Skip to main content

TcxTreeList Class

A control that displays data in a tree-like manner.

Declaration

TcxTreeList = class(
    TcxCustomTreeList
)

Remarks

The base element of a tree-like structure is a node. Nodes contain actual data. You can use the Node.Values property of a node to access its values, one for each column within the control.

The TreeList control supports node selection. To select a node, an end-user should click it with the mouse. Additionally, the control supports multiple node selection. An additional node can be selected by clicking the node holding down the Ctrl key. The Ctrl key can also be used to exclude a node from the selection. Alternatively, the end-user can select a range of nodes by using the Shift key. To select a range of nodes, the end-user should first select the initial node within the range, press the Shift key and then click the final node for the range.

Each TreeList column has a caption that uniquely identifies the column among the other columns. Also, the end-user can use the caption to resize the column and to move it to another location within the control.

The TreeList control can sort data against column values. To sort, the end-user should click a column header. To change the sort order, another click is required. To clear sorting by a column, the end-user should click the column header while holding down the Ctrl key. The control supports the sorting of several columns at once. Use the OptionsBehavior.MultiSort property to enable this feature. To sort on a second column, the end-user clicks on the column header while holding down the Shift key.

Columns are logically and visually arranged in bands. Each band can have a number of associated nodes. Like columns, bands have captions that are used to identify the band uniquely, resize it and relocate it within the control. Bands can be fixed either to the left or the right side of the control. Columns that belong to fixed bands are not involved in horizontal scrolling.

Bands and columns can be hidden at runtime using the customization form. This form is used to remove/restore bands and columns temporarily. The end-user can move the desired bands or columns to the customization form, scroll to the desired location within the control and restore them. To move a band or a column to the customization form, the end-user should drag the desired band or column header to the form. A band or a column moved to the customization form is removed from the TreeList control. To restore a band or a column from the customization form, the end-user should drag the band or column header back to the control.

The TreeList control supports Developer Express styles technology. You can specify style settings for the control’s various visual elements at design and runtime. Support for style sheets means that styles can be assigned for all control elements at once.

The TreeList control supports summary calculation. A developer can define summary items for each column within the control. Summary results are displayed within the footer and group footers.

The TreeList control provides a huge number of properties, methods, and events that allow a developer to customize the control’s look and feel and behavior as required. Sets of properties dealing with similar functionality are arranged in groups and are exposed by option objects.

See Also