Skip to main content
Version: 8.1

system.nav.desktop

This function is used in Python Scripting.

Description

Allows for invoking system.nav functions on a specific desktop.

See the Multi-Monitor Clients page for more details.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.nav.desktop(handle)

Parameters

TypeParameterDescription
StringhandleThe handle for the desktop to use. May be omitted for the primary desktop. [optional]

Returns

INavUtilities - A copy of system.nav (INavUtilities) that will alter the desktop named by the given handle.

Scope

Vision Client

Code Examples

Example #1
# The following example will close a window at path "Main Windows/Overview" in the Primary Desktop,
# regardless of where the script originates from.
system.nav.desktop().closeWindow("Main Windows/Overview")
Example #2
# Attempts to swap to a window at path "Main Windows/Main Window" on a specific Desktop. This example assumes a desktop with the handle "2nd Desktop" is already open.  
system.nav.desktop("2nd Desktop").swapTo("Main Windows/Main Window")