Ignition User Manual 7.9

Search

Contents




Strategic Partner Links

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

Resources

Knowledge Base Articles
Inductive University
Forum
IA Support
SDK Documentation
SDK Examples

All User Manual Versions

Ignition 8.1
Ignition 8
Ignition 7.8

Versions Compared

Old Version 4

changes.mady.by.user Paolo Mariani

Saved on

compared with

New Version 5

changes.mady.by.user Paolo Mariani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
titleDescription

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.


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission restrictions.


Panel
titleSyntax

system.gui.getDesktopHandles()

  • Parameters
  • Returns

PySequence - A list of window handles of all secondary Desktop frames.

  • Scope

Client



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet
#The following example list all handles (except the main client)
# in the client console (Help -> Diagnostics -> Console)
print system.gui.getDesktopHandles()


Code Block
languagepy
titleCode 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)