Skip to main content
Version: 8.1

system.gui.openDesktop

This function is used in Python Scripting.

Description

Creates an additional Desktop in a new frame. For more details, see the Multi-Monitor Clients page.

note

This function accepts keyword arguments.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.gui.openDesktop ([screen], [handle], [title], [width], [height], [x], [y], [windows])

Parameters

TypeParameterDescription
IntegerscreenThe screen index of which screen to place the new frame on. If omitted, screen 0 will be used. [optional]
StringhandleA name for the desktop. If omitted, the screen index will be used. [optional]
StringtitleThe title for the new frame. If omitted, the index handle will be used. If the handle and title are omitted, the screen index will be used. [optional]
IntegerwidthThe width for the new desktop's frame. If omitted, frame will become maximized on the specified monitor. [optional]
IntegerheightThe height for the new desktop's frame. If omitted, frame will become maximized on the specified monitor. [optional]
IntegerxThe x coordinate for the new desktop's frame. Only used if both width and height are specified. If omitted, defaults to 0. [optional]
IntegeryThe y coordinate for the new desktop's frame. Only used if both width and height are specified. If omitted, defaults to 0. [optional]
PySequencewindowsA list of window paths to open in the new Desktop frame. If omitted, the desktop will open without any opened windows. [optional]

Returns

JFrame - A reference to the new Desktop frame object.

Scope

Vision Client

Code Examples

Example #1
# Create a list of window paths to open in the new desktop.
windowsToOpen = ["Main Windows/Main Window", "Navigation"]

# Creates a new desktop. The desktop will open the windows listed above.
system.gui.openDesktop(windows=windowsToOpen)
Example #2
# Creates a new desktop on monitor 0 (primary) with only the Overview window open.
system.gui.openDesktop(screen=0, windows=["Overview"])
Example #3
# Creates a new desktop on monitor 0 (primary) with only the Overview window open.
# Including a handle gives the new desktop a name. This is useful for using other desktop scripting functions
system.gui.openDesktop(screen=0, handle="Left Monitor", windows=["Overview"])

Keywords

system gui openDesktop, gui.openDesktop