Open View For Data Cell Tool Arguments

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

Misc

Property Type Default Description

AllowMultipleSelectedDataCells

bool

false

Controls whether the user is allowed to select multiple data cells. If MemberFilters are defined, each selected data cell is filtered. If any selected data cell does not qualify, the tool is not displayed on the context menu.

The AllowMultiple tool argument is optional. By default, the user is only allowed to select a single data cell.

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.

Debug

bool

false

Controls whether information that can be helpful with debugging is displayed. The context menu tool visibility is set based on the whether the selected cell(s) passes the criteria defined by the tool arguments. If Debug is True, a message box containing diagnostics is displayed by the tool controller after the right mouse button is clicked and before the context menu is displayed.

EnforceEssbaseFilter

bool

true

Controls whether the tool is displayed on the context menu when an Essbase filter prevents the user from accessing the data cell.

If the setting is True, the tool is not displayed on the context menu when the user has no access to the data cell. If the setting is False, the tool is displyed regardless of whether or not the user has access to the data cell.

EssbaseConnectionID

string

Specifies the Essbase connection ID to which the selected data cell(s) must be associated.

The EssbaseConnectionID tool argument is optional. By default, the view’s EssbaseConnectionID setting is used. The EssbaseConnectionID tool argument is only necessary when the view contains multiple retrieve ranges to different Essbase databases.

MemberFilters

List<MemberFilter>

Defines the filters that control whether the tool is available for the selected data cell(s) based on the level number, level name, member name, or UDA’s of the contributing members.

MemberFilters are optional.

MemberToTokenConversionRules

List<MemberToTokenConversionRule>

Controls the value assigned to the tokens that represent the datapoint’s context and that are passed to the target view. A rule defined for a given dimension controls whether the dimension’s datapoint member, members related to the datapoint member, or members returned by an MDX script are assigned to the dimension’s associated token. The rule can also specify the formatting used for each member, and the formatting can contain relational database string functions.

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.