Versions Compared

Key

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


Panel
titleDescription

Given a window path, or a reference to a window itself, it will close the window. If the window can't be found, this function will do nothing.

Client permissions restrictions


Panel
titleSyntax

system.nav.closeWindow(window)

  • Parameters

FPMIWindow window - A reference to the window to close. Refer to the window objects.

  • Returns

Nothing

  • Scope

Vision Client

Panel
titleSyntax

system.nav.closeWindow(windowPath)

  • Parameters

String windowPath - The path of a window to close.

  • Returns

Nothing

  • Scope

Vision Client

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# This example gets the window named 'Overview' and then closes it.
# If the window isn't open, a warning is shown.
try:
   window = system.gui.getWindow('Overview')
   system.nav.closeWindow(window)
except ValueError:
   system.gui.warningBox("The Overview window isn't open")
Panel
Code Block
languagepy
titleCode Snippet
# This example closes the window named 'Overview' in one step.
# If the window isn't open, the call to closeWindow has no effect.
system.nav.closeWindow('Overview')
Panel
titleKeywords

system nav closeWindow, nav.closeWindow