Essbase Selector Tree View Properties

EssbaseSelectorTreeViewRootNodeMemberPolicy.UseDimension

When the base members are added as descendant nodes, this setting controls how the member that is to be represented by the root node is determined. The root node, which represents an ancestor of the base members, can be the dimension or another ancestor based on a specified generation, level, or member name.

This setting is only applicable when the BaseMemberNodePolicy setting is AddBaseMemberAsDescendantNode.

The BaseMemberAsDescendantNode_RootNodeMemberValue setting is used to specify the level, generation,, or member name.

See also: BaseMemberNodePolicy, BaseMemberAsDescendantNode_RootNodeMemberValue

When the base members are added as descendant nodes, use this setting to specify the generation number or name, the level number or name, or the name of the member that is to be represented by the root node.

This setting is only applicable when the BaseMemberNodePolicy setting is AddBaseMemberAsDescendantNode and the BaseMemberAsDescendantNode_RootNodeMemberPolicy setting is UseSpecifiedGenNumber, UseSpecifiedGenName, UseSpecifiedLevelNumber, UseSpecifiedLevelName, or UseSpecifiedMemberName

See also: BaseMemberNodePolicy, BaseMemberAsDescendantNode_RootNodeMemberPolicy

The members generated by the selector list are referred to as base members. The BaseMemberNodePolicy setting controls whether the base members are added to the tree as root nodes or as descendant nodes.

AddBaseMemberAsRootNode — A root node is added to the tree for each base member.

AddBaseMemberAsDescendantNode — If a base member has ancestors, a node is added to the tree for each of the member’s ancestors and for the base member. If the base member does not have ancestors, a root node is added only for the member.

false

Controls whether the treeview is automatically displayed when the view is opened.

false

Whether to automatically size the width of the selector when a node is expanded. The width will only be changed if it isn’t wide enough to display all nodes. The width will never be made narrower.

false

Controls whether shared parent members can be expanded in the treeview.

A shared parent member is a shared member whose associated base member has children. When ExpandSharedParent is True, the node representing the shared parent member can be expanded in the treeview to display the descendants of the associated base member.

The following caveats apply when ExpandSharedParent is True:

0

The maximum width, in points, of the control when it is auto-sized. A default value of 0 is applied as no limit.

0

The maximum member generation represented in the treeview. The default value of 0 allows all generations to be represented.

-1

The maximum member level selectable in the treeview. The default value of -1 allows for a member at any level to be selected.

Member expansion filters that control which members are expandable in the treeview. Complex policies can be constructed to limit the expansion of members, although a performance overhead can be expected. The MaxGenExpandable property should be utilized before leveraging the fine-grained control of the member expansion filters.

See also: MaxGenExpandable, MemberSelectionFilters.

Member selection filters that control which members are selectable in the treeview. Complex policies can be constructed to limit the selection of members, although a performance overhead can be expected. The MaxLevelSelectable property should be utilized before leveraging the fine-grained control of the member selection filters.

See also: MaxLevelSelectable, MemberExpansionFilters.

false

Indicates whether nodes representing only the immediate children or all the descendants of a base member are populated in the tree when the base member is added. By default, the value is false, which indicates that nodes are added for only the immediate children. When the user expands a node that is not filled, the tree automatically populates the selected node. Setting the value to false is the preferred approach, because it typically yields better performance.

EssTreeRootNodeExpansionPolicy.ExpandSingleRootNode

Controls whether the root nodes are automatically expanded. The root nodes are the top-level nodes in the tree and represent the list of members that are generated based on the selector list.

ExpandSingleNode — When the tree contains only one root node, the root node is automatically expanded. When the tree contains multiple root nodes, none of the nodes are expanded.

ExpandNoRootNodes — None of the root nodes are expanded.

ExpandAllRootNodes — All root nodes are expanded.

ExpandAllRootNodesAndPrefilledDescendantNodes — All root nodes along with all prefilled descendant nodes are expanded. This option is intended for use when the BaseMemberNodePolicy setting is AddBaseMemberAsDescendantNode and you want the tree to automatically expand to show the base members. This option can also be used when the Prefill setting is True and you want the tree to automatically expand to show all the nodes. Since prefilling the tree and automatically expanding all nodes increase the amount of time the tree takes to display, the total number of members represented by the tree should be taken into account before enabling these options.

SelectorToolDisplayPolicy.ToolbarOnly

Whether to display the selector’s tools in the selector’s toolbars, context menu, or both.

true

Controls whether the selector tool is visible in the toolbar.

When the selector tool is not visible, you will typically want to set the AutoOpenTreeView or AutoOpenListBox setting, depending on the control type, to true.

,

When the user is allowed to select multiple items, the selection text displayed by the selector is a delimited list of substrings in which each substring represents a selected item. The SelectionTextDelimiter defines the character(s) used to delimit the substrings. By default, the delimiter is a comma followed by a blank.

60

Controls the maximum number of characters that are displayed by the selector.

When a selector is configured to allow the user to select multiple items, the selector displays a delimited list of substrings in which each substring represents a selected item. You can use the SelectionTextMaxCharacters to limit the number of characters that are displayed by the selector. When the actual number of characters in the selection text exceeds the SelectionTextMaxCharacters value, an overflow indicator is displayed. When the user mouses over the selector, a tooltip shows the entire selection text.

You can use the SelectionTextMinCharacters and SelectionTextMaxCharacters to limit the number of characters that are displayed by the selector. When both settings are the same non-negative value, the number of characters displayed remains constant.

By default, the value is 60.

See also: SelectionTextMinCharacters, SelectionTextShowPartialItemString

-1

Controls the minimum number of characters that are displayed by the selector.

You can use the SelectionTextMinCharacters and SelectionTextMaxCharacters to limit the number of characters that are displayed by the selector. When both settings are the same non-negative value, the number of characters displayed remains constant.

By default, the value is -1, which indicates that no minimum number of characters is defined.

See also: SelectionTextMaxCharacters, SelectionTextShowPartialItemString

true

Determines whether a partial string is displayed for a selected item.

For example, if Boston, Chicago, and Atlanta are the selected items, the default selection text is 'Boston, Chicago, Atlanta'. If the SelectionTextMaxCharacters is 20 and SelectionTextShowPartialItemString is true, the displayed text is 'Boston, Chicago, Atl'. If SelectionTextShowPartialItemString is false, the displayed text is 'Boston, Chicago,'.

See also: SelectionTextMaxCharacters

true

Controls whether the Collapse All button is visible.

true

Controls whether the Collapse Branch button is visible.

true

Controls whether the Expand All button is visible.

true

Controls whether the Expand Branch button is visible.

true

Controls whether the Member Information button is visible. The tool allows the user to view detailed member information.

true

Controls whether the Alias Table dropdown list is visible. The tool allows the user to select the alias table used by the tree when displaying aliases.

See also: ShowNamesOrAliasesOptionTools

true

Controls whether the Show Names and Show Aliases buttons are visible. The buttons allow the user to toggle between member names or aliases in the tree.

See also: ShowAliasTableTool

Controls the member information presented by the tooltip displayed when the mouse hovers over a member item.

By default, the tooltip contains the member name, alias, generation, level, and whether or not the member is shared. The content can also contain the UDA’s associated with the member, the member comment, formula, consolidation operation, and associated attributes. The size of the tooltip as well as the amount of time required to display the tooltip are both a factor of the size of the content. The possible number of UDA’s and associated attributes as well as the length of the comment and the formula should be taken into account when deciding whether or not to include any of these options.

You can specify the member information displayed by the tooltip by checking and unchecking options.

MemberToolTipContentOptions is only applicable when ShowMemberItemToolTip or ShowMemberItemToolTipOnOffTool is true.

See also: ShowMemberItemToolTip, ShowMemberItemToolTipOnOffTool

true

Controls whether a tooltip is displayed when the mouse is over a member node in the tree.

By default, the tooltip displays the member name, alias, generation, level, whether or not the member is shared, and UDA’s, if any. You can use the MemberToolTipContentOptions setting to control the member information that is presented by the tooltip.

See also: MemberToolTipContentOptions

true

Controls whether the Member Item ToolTip On/Off state button tool is visible.

The tool allows the user to control whether a tooltip is displayed when the mouse is over a member node in the tree.

See also: ShowMemberItemToolTip, MemberToolTipContentOptions

false

Controls whether the Shared Members checkbox is checked or unchecked by default. The default setting is False (i.e. unchecked.)

The checkbox controls whether shared members are automatically found and selected in the tree when the user chooses a member from the list of search results and clicks the Select button (or double-clicks a member from the list of search results.)

See also: SharedMembersCheckboxVisible

DefaultableBooleanValue.Default

Controls whether the Shared Members checkbox is visible in the Find area. Typically, the Shared Members checkbox is only appropriate when multple selections are allowed.

The options include: Default, True, False. When set to Default, the Shared Members checkbox is visible when multiple selections are allowed, and is not visible when only a single selection is allowed. The default value is Default.

See also: SharedMembersCheckboxChecked

true

Controls whether the search capability is available.

The search capability is supported by user-interface components contained in a collapsable area with the caption 'Find' located at the bottom of the control. By default, the Find area is visible and collapsed.

true

Controls whether the Clear All button is visible.

The ShowClearAllTool is only applicable when the selector list is assigned to a selector that is configured to allow multiple selected items. You configure a selector to allow multiple selected items using a view’s SelectorConfiguration setting.

true

Controls whether the Clear Branch button is visible.

The ShowClearBranchTool is only applicable when the selector list is assigned to a selector that is configured to allow multiple selected items. You configure a selector to allow multiple selected items using a view’s SelectorConfiguration setting.

true

Controls whether the Clear Children button is visible.

The ShowClearChildrenTool is only applicable when the selector list is assigned to a selector that is configured to allow multiple selected items. You configure a selector to allow multiple selected items using a view’s SelectorConfiguration setting.

true

Controls whether the Select All button is visible.

The ShowSelectAllTool is only applicable when the selector list is assigned to a selector that is configured to allow multiple selected items. You configure a selector to allow multiple selected items using a view’s SelectorConfiguration setting.

true

Controls whether the Select Branch button is visible.

The ShowSelectBranchTool is only applicable when the selector list is assigned to a selector that is configured to allow multiple selected items. You configure a selector to allow multiple selected items using a view’s SelectorConfiguration setting.

true

Controls whether the Select Children button is visible.

The ShowSelectChildrenTool is only applicable when the selector list is assigned to a selector that is configured to allow multiple selected items. You configure a selector to allow multiple selected items using a view’s SelectorConfiguration setting.

true

Controls whether the List Selection button is visible.

The List Selection tool displays a dialog that shows a list of the selected nodes.

The ShowListSelectionTool is only applicable when the selector list is assigned to a selector that is configured to allow multiple selected items. You configure a selector to allow multiple selected items using a view’s SelectorConfiguration setting.

true

Controls whether the Show Selection button is visible.

The Show Selection tool expands and collapses nodes as necessary to make the selected node(s) visible.