This function is used in Python Scripting.


Gets a list of all secondary handles of the open desktops associated with the current client. In this case, secondary means any desktop frame opened by the original client frame. Example: If the original client opened two new frames ('left client' and 'right client'), then this function would return ['left client', 'right client'].

See the Multi-Monitor Clients page for more details about using multiple monitors.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.



  • Parameters


  • Returns

List[Any] - A Python list of unicode strings, representing the handle of all secondary desktop frames.

  • Scope

Vision Client

Code Examples
Code Snippet - Getting Desktop Handles
# The following example list all handles (except the main client)
# in the client console (Help -> Diagnostics -> Console).
print system.gui.getDesktopHandles()

Code Snippet - Putting Desktop Handles in a Table
# Create the header and fetch handle names.
header = ["Desktop Names"]
handleList = system.gui.getDesktopHandles()

# Change the handle name list into a column.
handleColumn = [[name] for name in handleList]

# Display the handle list in a table component.
event.source.parent.getComponent('Handles Table').data = system.dataset.toDataSet(header, handleColumn)

system gui getDesktopHandles, gui.getDesktopHandles