Open View Tool Arguments

The following properties are available for Open View Tool Arguments objects, grouped by the categories shown in the Toolbars Designer.

Misc

Property	Type	Default	Description
AutoBuildOnOpen	DefaultableBooleanValue	DefaultableBooleanValue.Default	Controls whether the view automatically builds when opened. The AutoBuildOnOpen tool argument is optional. By default, the value is Default. When set to Default, the target view’s AutoBuildOnOpen setting is used. If the tool argument is set to True or False, the view’s AutoBuildOnOpen setting is overridden and the specified tool argument value is used.
ShareSelectorTokens	bool	false	Controls whether the current view’s selector tokens are added as tokens to the opened view. When added, the tokens are used to set default selections, when applicable, and can be referenced in workbook scripts, SQLPassthroughDataSets, etc. as used by the opened view.
ShareViewTokens	bool	false	Controls whether the source view’s ViewTokens are shared with the target view. The ShareViewTokens tool argument is optional. By default, the ViewTokens are not shared. Typically, the ViewTokens should not be shared.
ShowViewAsActiveWindow	bool	true	Controls whether the opened view’s window becomes the active window. By default, the view’s window is activated.
ToolCaption	string		Specifies the caption displayed on the context menu. The ToolCaption tool argument is optional. If no ToolCaption tool argument is specified, the tool’s Caption property is used.
ViewID	string		Specifies the ID of the view that is to be opened. The ViewID tool argument is required. If no ViewID tool argument is specified, the tool is not displayed on the context menu.

Property

Type

Default

Description

AutoBuildOnOpen

DefaultableBooleanValue

DefaultableBooleanValue.Default

Controls whether the view automatically builds when opened.

The AutoBuildOnOpen tool argument is optional. By default, the value is Default. When set to Default, the target view’s AutoBuildOnOpen setting is used. If the tool argument is set to True or False, the view’s AutoBuildOnOpen setting is overridden and the specified tool argument value is used.

ShareSelectorTokens

bool

false

Controls whether the current view’s selector tokens are added as tokens to the opened view.

When added, the tokens are used to set default selections, when applicable, and can be referenced in workbook scripts, SQLPassthroughDataSets, etc. as used by the opened view.

ShareViewTokens

bool

false

Controls whether the source view’s ViewTokens are shared with the target view.

The ShareViewTokens tool argument is optional. By default, the ViewTokens are not shared. Typically, the ViewTokens should not be shared.

ShowViewAsActiveWindow

bool

true

Controls whether the opened view’s window becomes the active window. By default, the view’s window is activated.

ToolCaption

string

Specifies the caption displayed on the context menu.

The ToolCaption tool argument is optional. If no ToolCaption tool argument is specified, the tool’s Caption property is used.

ViewID

string

Specifies the ID of the view that is to be opened.

The ViewID tool argument is required. If no ViewID tool argument is specified, the tool is not displayed on the context menu.