Skip to main content
Version: 8.3 Beta 🚧

system.vision.openWindowInstance

Backwards Compatibility

This function replaces system.nav.openWindowInstance. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description​

When called in a Vision Client, it operates exactly like system.vision.openWindow(), except that if the named window is already open, then an additional instance of the window will be opened. There is no limit to the number of additional instances of a window that you can open.

When called in the Designer, it operates similar to system.vision.openWindow(), except that if the named window is already open the function will swap to the opened window. Additional instances will not be opened. A warning is issued indicating why a new instance was not opened.

note

This function is available on secondary desktops via the system.vision.desktop function. See the Multi-Monitor Clients page for more details on secondary desktops.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.vision.openWindowInstance(path, [params])

Parameters​

TypeParameterDescription
StringpathThe path to the window to open.
Dictionary[String, Any]paramsA 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​

Window - A reference to window that was navigated to. Refer to the list of window objects.

Scope​

Vision Client

Code Examples​

Example #1
# This example would open three copies of a single HOA popup screen.

system.vision.openWindowInstance("HOA", {machineNum:3})
system.vision.openWindowInstance("HOA", {machineNum:4})
system.vision.openWindowInstance("HOA", {machineNum:5})