Essbase Selector List Box Properties

The following properties are available for Essbase Selector List Box objects, grouped by the categories shown in the Selectors and Selector Lists editors.

Behavior

Property Type Default Description

AutoOpenListBox

bool

false

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

ItemsSorted

bool

false

Indicates whether the items are sorted. If not sorted, the items appear in the order returned by the selector list.

Prepopulate

bool

false

When used in an asynchronous view, controls whether the selector list items are obtained prior to when the list is displayed.

The selector list items will automatically pre-populate, for instance, when the ValidateDefaultSelection is True. If not, setting Prepopulate to True minimizes the delay when the listbox control is opened for the first time.

ToolDisplayPolicy

SelectorToolDisplayPolicy

SelectorToolDisplayPolicy.ToolbarOnly

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

ToolVisibleInToolbar

bool

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.

Selection Text

Property Type Default Description

SelectionTextDelimiter

string

,

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.

SelectionTextMaxCharacters

int

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.

SelectionTextMinCharacters

int

-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.

SelectionTextShowPartialItemString

bool

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,'.

UI - Member Name/Alias Tools

Property Type Default Description

ShowAliasTableTool

bool

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.

ShowNamesOrAliasesOptionTools

bool

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

UI - Search Tools

Property Type Default Description

ShowSearchTool

bool

false

Controls whether the Search tool is visible.