system.nav.openWindow

This function is used in Python Scripting.

Description

Opens the window with the given path. If the window is already open, brings it to the front. The optional params dictionary contains key:value pairs which will be used to set the target window's root container's dynamic variables.

For instance, if the window that you are opening is named "TankDisplay" has a dynamic variable in its root container named "TankNumber", then callingsystem.nav.openWindow("TankDisplay", {"TankNumber" : 4}) will open the "TankDisplay" window and set Root Container.TankNumber to four. This is useful for making parameterized windows, that is, windows that are re-used to display information about like pieces of equipment. See also: Parameterized Popup Windows.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.nav.openWindow(path [, params])

Parameters

Type	Parameter	Description
String	path	The path to the window to open.
PyDictionary	params	A dictionary of parameters to pass into the window. The keys in the dictionary must match dynamic property names on the target window's root container. The values for each key will be used to set those properties. [optional]

Returns

PyObject - A reference to the opened window.

Scope

Client

Code Examples

Code Snippet

# This is the simplest form of openWindow
system.nav.openWindow("SomeWindowName")

Code Snippet

# A more complex example - a setpoint screen for multiple valves that opens centered
titleText = "Third Valve Setpoints"
tankNo = system.nav.openWindow("ValveSetPts", {"valveNum":3, "titleText":titleText})
system.nav.centerWindow("ValveSetPts")