SQL Selector Tree View Properties

The following properties are available for SQL 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.

ItemExpansionFilters

List<SQLSelectionFilter>

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

ItemSelectionFilters

List<SQLSelectionFilter>

Item expansion filters that control which items are expandable in the treeview. Complex policies can be constructed to limit the expansion of items, although performance overhead can be expected. The MinGenSelectable property should be utilized before leveraging the fine-grained control of the item selection filters.

MaxGenExpandable

int

0

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

MinGenSelectable

int

0

The minimum item generation selectable in the treeview. The default value of 0 allows items of any generation to be selected.

RootNodeExpansionPolicy

SQLSelectorTreeRootNodeExpansionPolicy

SQLSelectorTreeRootNodeExpansionPolicy.ExpandAllRootNodes

Controls whether the root nodes are automatically expanded. The root nodes are the top-level nodes in the tree and represent the list of items 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.

ExpandAllRootNodesAndDescendantNodes — All root nodes along with all descendant nodes are expanded. This option is intended for use when you want the tree to automatically expand to show all items.

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.

Misc

Property Type Default Description

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.

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 - Information Tools

Property Type Default Description

ShowSelectorCountTool
displayed as ShowSelectorItemCount

bool

false

Controls whether the Show Selector Item Count label is visible.

The Show Selector Item Count tool indicates the number of Selector Items returned by the configured selector list.

UI - Item Tooltips

Property Type Default Description

ItemToolTipContentOptions

SQLSelectorItemTipContentOptionFlags

Default value

SQLSelectorItemTipContentOptionFlags.DisplayName | SQLSelectorItemTipContentOptionFlags.Value

Controls the item information presented by the tooltip displayed when the mouse hovers over an item node.

By default, the tooltip contains the descriptor. The content can also contain the display text, id, generation, parent display text, parent id, and/or ancestors. 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 ancestors should be taken into account when deciding whether or not to include any of these options.

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

ItemToolTipContentOptions is only applicable when ShowItemToolTip or ShowItemToolTipOnOffTool is true.

See also: ShowItemToolTip, ShowItemToolTipOnOffTool

ShowItemToolTip

bool

true

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

By default, the tooltip displays the item display name and ID. You can use the ItemToolTipContentOptions setting to control the item information that is presented by the tooltip.

ShowItemToolTipOnOff

bool

true

Controls whether the 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 an item node in the tree.

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

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.