Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL USER MANUAL VERSIONS

Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Employees

Sign In

Skip to end of metadata
Go to start of metadata

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.

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

Integer screen - The screen index of which screen to place the new frame on. If omitted, screen 0 will be used.

String handle - A name for the desktop. If omitted, the screen index will be used.

String title - The 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.

Integer width - The width for the new Desktop's frame. If omitted, frame will become maximized on the specified monitor.

Integer height - The width for the new desktop's frame. If omitted, frame will become maximized on the specified monitor.

Integer x - The X coordinate for the new desktop's frame. Only used if both width and height are specified. If omitted, defaults to 0.

Integer y - The Y coordinate for the new desktop's frame. Only used if both width and height are specified. If omitted, defaults to 0.

PySequence windows - A list of window paths to open in the new Desktop frame.

  • Returns

JFrame  - A reference to the new Desktop frame object. 

  • Scope

Vision Client

Code Examples
Code Snippet
# 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)

Code Snippet
# Creates a new desktop on monitor 0 (primary) with only the Overview window open
system.gui.openDesktop(screen=0, windows=["Overview"])

Code Snippet
# 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

  • No labels