system.gui.getDesktopHandles
Description
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. Exampe: If the original client opened 2 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.
Syntax
system.gui.getDesktopHandles( )
-
Parameters
-
Returns
PySequence - A list of window handles of all secondary Desktop frames.
-
Scope
Client
Code Examples
Code Snippet
#The following example list all handles (except the main client)
# in the client console (Help -> Diagnostics -> Console)
print
system.gui.getDesktopHandles()
Code Snippet
# 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)