Note: This user manual will undergo maintenance starting at 5 p.m. PST 2/25/2021 and be unavailable for approximately 30 minutes. We apologize for the inconvenience.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »


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.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.



  • 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


Code Examples
Code Snippet
#The following example will close this desktop
Code Snippet
#The following example will close desktop 2
#The handle must be a string
Code Snippet
#The following example will close the desktop named "Left Monitor"
system.gui.closeDesktop("Left Monitor")
  • No labels