Skip to main content
Version: 7.9

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.
StringhandleA name for the desktop. If omitted, the screen index will be used.
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.
IntegerwidthThe width for the new Desktop's frame. If omitted, frame will become maximized on the specified monitor.
IntegerheightThe width for the new desktop's frame. If omitted, frame will become maximized on the specified monitor.
IntegerxThe X coordinate for the new desktop's frame. Only used if both width and height are specified. If omitted, defaults to 0.
IntegeryThe Y coordinate for the new desktop's frame. Only used if both width and height are specified. If omitted, defaults to 0.
PySequencewindowsA list of window paths to open in the new Desktop frame.

Returns​

JFrame - A reference to the new Desktop frame.

Scope​

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"])