This function is used in Python Scripting.

Description

Moves an open client to a specific monitor. Use with system.gui.getScreens to identify monitors before moving.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.gui.setScreenIndex(index)

  • Parameters

Integer index - The new monitor index for this client to move to. 0 based.

  • Returns

Nothing

  • Scope

Vision Client

Code Examples
Code Snippet - Setting a Screen's Index
# This example could be used on a startup script to move the Client to a second monitor.
 
system.gui.setScreenIndex(1)
Keywords

system gui setScreenIndex, gui.setScreenIndex