Closes a GraphWorX window.

Namespace: Ico.Gwx
Assembly: GwxRuntimeViewControl (in GwxRuntimeViewControl.dll) Version: 10.97.212.0 (10.97.212.00)

Syntax

C#
public bool Close(
	WindowTargetType targetType,
	string targetName
)
Visual Basic
Public Function Close ( _
	targetType As WindowTargetType, _
	targetName As String _
) As Boolean
JScript
public final function Close(
	targetType : WindowTargetType, 
	targetName : String
) : boolean

Parameters

targetType
Type: Ico.Gwx..::..WindowTargetType
see remarks.
targetName
Type: System..::..String
see remarks.

Return Value

True if one or more windows are closed, false if no windows are closed.

Implements

IGwxControlClose(WindowTargetType, String)

Remarks

The targetType is used in conjunction with the targetName to designate which display window to close. TargetName can be a full name, a partial name with wildcards, or unspecified.

If targetType is Self: (targetName is unused)

  • Closes the current window. This is the default target type.

If targetType is WindowOwnedPopup, WindowOwnedModalPopup, DisplayOwnedPopup, DisplayOwnedModalPopup, UnownedPopup, or Embedded

  • If targetName is specified and there is already an open window of the same targetType that matches the targetName (and is owned by the current window), that window is closed.
  • If targetName is specified and there is NOT already an open window of the same targetType that matches the targetName (and is owned by the current window), no window is closed.
  • If targetName is NOT specified, all windows of the same targetType (that are owned by the current window) are closed.

If targetType is Parent:

  • If targetName is specified and there is a parent window in the parent chain that matches that name, that parent window is closed.
  • If targetName is specified and there is NOT a parent window in the parent chain that matches that name, the behavior is the same as "Self"
  • If targetName is NOT specified, the first parent window (starting at the current window) is closed.
  • If there is no parent, the behavior is the same as Self.

If targetType is Root: (targetName is unused)

  • The topmost (root) parent window is closed.
  • If there is no parent, the behavior is the same as Self.

See Also