Skip to main content
Version: 8.1

system.gui.getScreens

This function is used in Python Scripting.

Description

Get a list of all the monitors on the computer this client is open on. Use with system.gui.setScreenIndex() to move the client.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.gui.getScreens()

Parameters

Nothing

Returns

List[Tuple[String, Integer, Integer]] - A sequence of tuples of the form (index, width, height) for each screen device (monitor) available.

Scope

Vision Client

Code Examples

Example #1 - Getting Screen Information
# This example fetches monitor data and pushes it to a table in the same container.

screens = system.gui.getScreens()
pyData = []
for screen in screens:
pyData.append([screen[0], screen[1], screen[2]])

# Push data to 'Table'.
event.source.parent.getComponent('Table').data = system.dataset.toDataSet(["screen","width","height"], pyData)

Keywords

system gui getScreens, gui.getScreens