Finds a reference to an open window with the given name. Throws a ValueError if the named window is not open or not found.

This scripting function has no Client Permission restrictions.


  • Parameters

String name - The path to the window to field.

  • Returns

PyObject - A reference to the window, if it was open. Use .getRootContainer() to grab the root container of the window.

  • Scope


# This example will get the window named 'Overview' and then close it.
   window = system.gui.getWindow('Overview')
except ValueError:
   system.gui.warningBox("The Overview window isn't open")

# This example will set a value on a label component in the 'Header' window.
   window = system.gui.getWindow('Header')
   window.getRootContainer().getComponent('Label').text = "Machine 1 Starting"
except ValueError:
   system.gui.warningBox("The Header window isn't open")