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.

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


#The following example will close this desktop

#The following example will close desktop 2
#The handle must be a string

#The following example will close the desktop named "Left Monitor"
system.gui.closeDesktop("Left Monitor")