Open View For Member Cell Tool Arguments

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.

Controls whether the tool is available for the selected member cell(s) based on the dimension(s) to which the member(s) belongs. The value is a semi-colon delimited list of dimension names. If one or more dimensions are specified, each selected member must belong to a specified dimension for the tool to be displayed on the context menu.

For example, if the AllowedDimensions is Product;Market, the tool is displayed only when the selected member (or members) belongs to the Product or Market dimension.

The AllowedDimensions tool argument is optional. By default, the tool is displayed on the context menu for members belonging to any dimension.

Both the AllowedDimensions and AllowedOrientations settings are used to control whether the tool is displayed.

MemberCellOrientations.All

Controls whether the tool is available for the selected member cell(s) based on the orientation of the member(s). If one or more orientations are specified, each selected member must be one of the specified orientations for the tool to be displayed on the context menu.

The AllowedOrientation tool argument is optional. By default, the value is All, which indicates that the tool is displayed for any member cell.

Both the AllowedOrientations and AllowedDimensions settings are used to control whether the tool is displayed.

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.

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.

true

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

Specifies the caption displayed on the context menu.

The tool caption can contain a single format item, {0}. If present, the format item is replaced with a string that contains the value from the selected member cell. If multiple member cells are selected (and allowed), the string contains a comma-delimited list of the member cell values. For example, if the selected cell represents the member 'Diet Cola' and the ToolCaption value is 'View {0} Sales', the tool caption displayed on the context menu is 'View Diet Cola Sales'.

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

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.