Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Scripting_function



Panel
titleDescription

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


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission 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 Desktop. Alternatively, the handle "primary" can be used to refer to the Primary Desktop.

  • Returns
  • Scope

Client



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet
#The# The following example will close this desktop
system.gui.closeDesktop()


Code Block
languagepy
titleCode Snippet
#The# The following example will close desktop 2
#The# The handle must be a string
system.gui.closeDesktop("2")


Code Block
languagepy
titleCode Snippet
#The# The following example will close the desktop named "Left Monitor"
system.gui.closeDesktop("Left Monitor")