Versions Compared

Old Version 5

changes.mady.by.user user-6e56b

Saved on

compared with

New Version Current

changes.mady.by.user user-6e56b

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits/style
Scripting_function


Panel
titleDescription

Allows you to close any of the open desktops associated with the current clientClient. See the Multi-Monitor Clients page for more details about using multiple monitors.

Client permissions restrictions


Panel
titleSyntax

system.gui.closeDesktop(handle)

  • Parameters

String handle - The handle for the desktop to close. The screen index cast as a string may be used instead of the handle. If omitted, this will default to the Primary Desktopprimary desktop. Alternatively, the handle "primary" can be used to refer to the primary desktop.

  • Returns

Nothing

  • Scope

Vision Client

panel
Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# The following example closes desktop 2.
# The handle must be a string.
system.gui.closeDesktop("2")
 Code Block
languagepy
titleCode Snippet
# The following example closes the desktop named "Left Monitor".
system.gui.closeDesktop("Left Monitor")
 Panel
titleKeywords
system gui closeDesktop, gui.closeDesktop