Versions Compared

Old Version 4

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, syntax
Scripting_function


Panel
titleDescription

Allows for invoking invoking system.nav functions on a specific desktop.  See the Multi-Monitor Clients page for more details.

Client permissions restrictions


Panel
titleSyntax

system.nav.desktop([handle])

  • Parameters

String handle-  The 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

panel
Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# The following example closes 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")
 Code Block
languagepy
titleCode Snippet
# Attempts to swap to a window at path "Main Windows/Main Window" on a specific Desktopdesktop. 
# This example assumes a desktop with the handle "2nd Desktop" is already open.  
system.nav.desktop("2nd Desktop").swapTo("Main Windows/Main Window")
 Panel
titleKeywords
system nav desktop, nav.desktop