Opens the specified URI. This operation is asynchronous.

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

Syntax

C#
public bool Open(
	string uri,
	WindowTargetType targetType,
	string targetName,
	GwxWindowProperties windowProperties,
	AliasCommandType localAliasCommandType,
	string localAliasCommandData,
	string globalAliases
)
Visual Basic
Public Function Open ( _
	uri As String, _
	targetType As WindowTargetType, _
	targetName As String, _
	windowProperties As GwxWindowProperties, _
	localAliasCommandType As AliasCommandType, _
	localAliasCommandData As String, _
	globalAliases As String _
) As Boolean
JScript
public final function Open(
	uri : String, 
	targetType : WindowTargetType, 
	targetName : String, 
	windowProperties : GwxWindowProperties, 
	localAliasCommandType : AliasCommandType, 
	localAliasCommandData : String, 
	globalAliases : String
) : boolean

Parameters

uri
Type: System..::..String
The URL of the display file to open. If not specified (null or empty string), loads a blank display.
targetType
Type: Ico.Gwx..::..WindowTargetType
see remarks.
targetName
Type: System..::..String
see remarks.
windowProperties
Type: Ico.Gwx..::..GwxWindowProperties
Optional: specifies new window properties for the to be applied to the target window (null for unspecified).
localAliasCommandType
Type: Ico.Gwx..::..AliasCommandType
Optional: local alias command type.
localAliasCommandData
Type: System..::..String
Optional: local alias command data.
globalAliases
Type: System..::..String
Optional: global alias command data.

Return Value

True if open initiated, false if open failed.

Implements

IGwxControlOpen(String, WindowTargetType, String, GwxWindowProperties, AliasCommandType, String, String)

Remarks

The targetType parameter is used in conjunction with the targetName parameter to designate which display window to open into.

If targetType is Self: (targetName is unused)

  • Loads the display into the current window.
This is the default target type.

If targetType is WindowOwnedPopup:

  • If targetName is specified and there is already an open popup window that matches that name (and is owned by the current window), the display is loaded into that popup window.
  • If targetName is specified and there is NOT already an open popup window that matches that name (and is owned by the current window), the display is loaded into a NEW popup window with the name specified by TargetName.
  • If targetName is NOT specified, the display is loaded into a NEW unnamed popup window.
Window owned popups will always stay above the owner window and will be minimized when the owner window is minimized. Window owned popups remain open even if the display is changed in the owner window. Window owned popups will be automatically closed when the owner window exits runtime or is closed.

If targetType is DisplayOwnedPopup:

  • Same as WindowOwnedPopup except the popup is owned by the Display (meaning, if a new display is loaded in a given window, all popups owned by the display that is being replaced, are automatically closed).

If targetType is DisplayOwnedModalPopup:

If targetType is WindowOwnedModalPopup:

  • Same as WindowOwnedPopup except the popup is "modal" (disables parent window).

If targetType is UnownedPopup:

  • Same as WindowOwnedPopup except the popup is "unowned" (they are owned by the desktop). Unowned popups will not necessarily stay above the window that opened them. Unowned popups remain open even if the display is changed in the window that opened them. Unowned popups will be automatically closed when the "root" window exits runtime or is closed.

If targetType is Embedded:

If targetType is Parent:

  • If targetName is specified and there is a parent window in the parent chain that matches that name, the display is loaded into that parent window.
  • 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 display is loaded into the first parent window (starting at the current window) in the parent chain.
  • If there is no parent, the behavior is the same as Self.

If targetType is Root: (targetName is unused)

  • The display is loaded into the topmost (root) parent window in the parent chain.
  • If there is no parent, the behavior is the same as Self.

See Also