system.vision.getParentWindow

Backwards Compatibility

This function replaces system.gui.getParentWindow. 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

Finds the parent (enclosing) window for the component that fired an event and returns a reference to it.

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.getParentWindow(event)

Parameters

Type	Parameter	Description
EventObject	event	A component event object.

Returns

FPMIWindow - The window that contains the component that fired the event.

Scope

Vision Client

Code Examples

Example #1 - Getting Window and Changing Its Title

# Use this in an event script to change the window's title.
  
window = system.vision.getParentWindow(event)
window.title='This is a new title'