Skip to main content

VCL Tree List

  • 3 minutes to read

The VCL Tree List is a hybrid control that allows you to display data as a tree, a grid, or a combination of both.

VCL Tree List: A Tree List UI Example

Data Access Modes

The Tree List supports the following data access modes:

Bound
The Tree List loads all data from the bound dataset to the client.
Unbound
In unbound mode, you can create nodes and columns and specify data in code.
Provider
The Tree List connects to a dedicated data source that loads data on demand.

Refer to the following topics for additional information on how to bind the Tree List to data:

Edit Data

The Tree List control allows you to embed DevExpress editors into column cells for user-friendly data display and input.

Date Editor Popup Example

Search and Filter Data

The Tree List has multiple options for data search and filtering.

Excel Style Filter Example

Refer to the following topics for details:

Sort Data

The Tree List allows users to sort data in ascending or descending order. Users can sort data against any number of columns. Refer to the following topics for details on data sort operations:

Summaries

The Tree List can calculate summaries against all nodes or against nodes at a specific hierarchy level.

Footer and Group Summaries

Bands

Bands are additional headers designed to group columns. Each band can display a caption with support for BBCode-inspired formatting. Users can hide, display, and reorder bands and columns within bands.

VCL Tree List: Tree List Bands

Scrollbar Annotations

A vertical scrollbar can display colored marks (annotations) that indicate the positions of rows that meet specific criteria. Users can click annotations to navigate to the corresponding records.

Scrollbar Annotation Example

The Tree List can display the following scrollbar annotation types:

  • Validation error marks
  • Search result marks
  • Selected record marks
  • The focused row mark
  • Custom record marks

Refer to the following topic for additional information: Scrollbar Annotations.

Conditional Formatting

The Tree List control supports Excel-style conditional formatting.

VCL Tree List: A Conditional Formatting Example

Data Export

Call the following global procedures to export Tree List content in corresponding formats:

cxExportTLToCSV | cxExportTLToCSVStream
Export Tree List content to a file or stream in the Comma-Separated Values (CSV) format.
cxExportTLToExcel | cxExportTLToExcelStream
Export Tree List content to a file or stream in the Microsoft Excel® binary (XLS) format.
cxExportTLToHTML | cxExportTLToHTMLStream
Export Tree List content to a file or stream in the HyperText Markup Language (HTML) format.
cxExportTLToText | cxExportTLToTextStream
Export Tree List content to a file or stream as plain text.
cxExportTLToXLSX | cxExportTLToXLSXStream
Export Tree List content to a file or stream in the Office OpenXML Spreadsheet (XLSX) format.
cxExportTLToXML
Exports Tree List content to a file in the Extensible Markup Language (XML) format.

Tip

All export procedure topics include code examples.

To see the VCL Tree List in action, run the TreeView-Grid Hybrid demo in the VCL Demo Center installed with compiled DevExpress VCL demos. Click different items in the sidebar on the left to switch between demo features.

Download: Compiled VCL Demos

Compiled DevExpress demos ship with source code installed in the Public Documents folder (%PUBLIC%) for all users (default). You can find all project and source code files for the TreeView-Grid Hybrid demo in the following folder:

%PUBLIC%\Documents\DevExpress VCL Demos\MegaDemos\Product Demos\ExpressQuantumTreeList\