system.nav.closeWindow

Description

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.

Syntax

system.nav.closeWindow(windowPath)

Parameters

String windowPath - The path of a window to close.

Returns

nothing

Scope

Client

system.nav.closeWindow(window)

Parameters

FPMIWindow window - A reference to the window to close.

Returns

nothing

Scope

Client

Examples

Example 1:

This example would get the window named 'Overview' and then close it.

 
# If the window isn't open, show a warning

try:

   window = system.gui.getWindow('Overview')

   system.nav.closeWindow(window)

except ValueError:

   system.gui.warningBox("The Overview window isn't open")

Example 2:

This example would close the window named 'Overview' in one step.

# If the window isn't open, the call to closeWindow will have no effect
system.nav.closeWindow('Overview')