Connection Selector Tree View Properties

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

Behavior

Property Type Default Description

ItemDisplayPolicy

ConnectionListItemDisplayPolicy

ConnectionListItemDisplayPolicy.Name

The connection value displayed for the selector items. The item value is always the connection ID.

ItemsSorted

bool

true

Whether the connection type groups, and the connections within each group, are sorted by their displayed value. If not sorted, they appear in the order returned by the selector list.

SetActiveConnection

bool

true

Whether selecting a connection sets the active connection of the hosting view. When disabled, the selector never drives the view’s connection and can be used to build a token value from the selected connection alone. Applies only when the hosting view supports connection assignment; otherwise, the setting is ignored.

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.

TrackActiveConnection

bool

true

Whether the selector shows the hosting view’s active connection as its selection, both initially and whenever another surface changes it, so that a connection assigned by the view metadata, including a tokenized connection ID, is shown as the selection. Applies only when the hosting view supports connection assignment; otherwise, the setting is ignored and the selector functions as a standard selector.

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