TcxCustomTreeList Class

The base class for the TcxDBTreeList, TcxTreeList, and TcxVirtualTreeList controls.

Declaration

TcxCustomTreeList = class(
    TcxExtEditingControl,
    IcxNavigator,
    IcxStoredParent,
    IcxStoredObject,
    IcxTreeListDesignTimeOperations,
    IcxTreeListDesignTimeOperations2,
    IdxSkinSupport,
    IcxDataControllerConditionalFormattingProviderOwner,
    IcxFilterControl,
    IcxFilterControlEx
)

Remarks

This class defines the basic functionality for classes implementing a tree-like data representation. This display method requires elements representing a tree structure – columns and nodes.

The main element of the tree-like data representation is a node. Each node can have one or more child nodes. Nodes contain actual data. A node can have one or more values which are accessible via the node’s Values property. The number of values is determined by the ValueCount property. Each node value belongs to a column.

Columns represent the second group of control elements. Each column has a caption that allows end-users to uniquely identify the column within the control. The column collection is accessible via the Columns property at the control level. Columns allow end-users to sort their values by clicking a column’s caption. Columns can be hidden (see Visible). Visible columns are stored in the collection exposed via the VisibleColumns property. Additionally, a column value can be displayed within the preview section whose settings are accessible via the control’s Preview property. Columns are arranged in bands.

Bands are objects that logically and visually group columns. Each band can have as many columns as you wish. Like columns, bands also have captions to provide a user-friendly way of distinguishing them from each other. Each band manages a collection of columns it owns, exposed by the band’s Columns property. Thus, a column can be accessed at two levels: owner band level (see Columns) and at TreeList control level (see ItemIndex). You can display bands by setting the TreeList control’s OptionsView.Bands property to True. To access individual bands and their settings, use the TreeList control’s Bands collection.

In addition, the TreeList control contains a footer located at the bottom and this is used to display summary values. Use the TreeList control’s OptionsView.Footer property to switch the footer’s visibility.

The TreeList control has several option sets that control different aspects of its behavior and appearance. These include:

OptionsBehavior, determining the control’s response to end-user actions.
OptionsCustomizing, controlling how end-users can manipulate view items at runtime.
OptionsData, determining the functionality of a data-aware view.
OptionsSelection, managing selection within the TreeList control.
OptionsView, controlling the visibility, color, width and other appearance settings of control elements.
Navigator, controlling the visibility and appearance of the embedded navigator.
FindPanel, controlling the Find Panel‘s look & feel.
FilterBox, controlling the filter panel‘s appearance.