system.gui.getWindow

This function is used in Python Scripting.

Description

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

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.gui.getWindow(name)

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

Client

Code Examples

Code Snippet

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

Code Snippet

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

Contents

Strategic Partner Links

Resources

All Manual Versions