Selector Tree View Properties

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

Behavior

Property Type Default Description

AutoOpenTreeView

bool

false

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

AutoSizeOnNodeExpansion

bool

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.

MaxAutoWidth

int

0

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

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 - Expand/Collapse Tools

Property Type Default Description

ShowCollapseAllTool

bool

true

Controls whether the Collapse All button is visible.

ShowCollapseBranchTool

bool

true

Controls whether the Collapse Branch button is visible.

ShowExpandAllTool

bool

true

Controls whether the Expand All button is visible.

ShowExpandBranchTool

bool

true

Controls whether the Expand Branch button is visible.

UI - Search Tools

Property Type Default Description

ShowFind

bool

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.

UI - Select/Clear Tools

Property Type Default Description

ShowClearAllTool

bool

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.

ShowClearBranchTool

bool

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.

ShowClearChildrenTool

bool

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.

ShowSelectAllTool

bool

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.

ShowSelectBranchTool

bool

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.

ShowSelectChildrenTool

bool

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.

UI- Selection Tools

Property Type Default Description

ShowListSelectionTool

bool

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.

ShowShowSelectionTool

bool

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.