Skip to content

TreeListControl class

Displays a collection of items arranged in a hierarchy of nodes.

public class TreeListControl : TreeListControlBase

Public Members

name description
TreeListControl() The default constructor.
AllowBandResizing { get; set; } Gets or sets whether users can resize bands.
AllowBestFit { get; set; } Gets or sets whether users can apply best-fit column sizing.
AllowColumnFiltering { get; set; } Gets or sets whether users can filter data by column.
AllowColumnMoving { get; set; } Gets or sets whether users can reorder columns by dragging their headers.
AllowColumnResizing { get; set; } Gets or sets whether users can resize columns.
AllowEditingTotalSummaries { get; set; } Gets or sets whether users can edit total summaries.
AllowHorizontalVirtualization { get; set; } Gets or sets whether off-screen columns are virtualized.
AllowResetColumnWidth { get; set; } Gets or sets whether users can reset column widths to their default values.
AllowSorting { get; set; } Gets or sets whether users can sort data.
AutoGenerateBands { get; set; } Gets or sets whether bands are generated automatically.
AutoGenerateColumns { get; set; } Gets or sets whether columns are generated automatically based on the data source.
AutoGenerateServiceColumns { get; set; } Gets or sets whether service columns are generated automatically.
AutoMoveRowFocus { get; set; } Gets or sets whether keyboard navigation moves focus to the next or previous row when passing the last or first column.
Bands { get; } Gets the control's band collection.
BandsSource { get; set; } Gets or sets the collection whose items are used to generate bands.
BandTemplate { get; set; } Gets or sets the template used to create a band for each item in BandsSource.
BestFitMode { get; set; } Gets or sets how the best-fit column width is calculated.
CellTemplate { get; set; } Gets or sets the default template used to display cell content when a column defines no own template.
ClipboardCopyHeaders { get; set; } Gets or sets whether column headers are copied to the clipboard along with cell values.
ColumnFilterButtonDisplayMode { get; set; } Gets or sets when the column filter buttons are displayed.
ColumnFilterPopupMode { get; set; } Gets or sets the type of the column filter popup.
ColumnMenu { get; set; } Gets or sets the context menu invoked for column headers.
Columns { get; } Gets the control's column collection.
ColumnsSource { get; set; } Gets or sets the collection whose items are used to generate columns.
ColumnTemplate { get; set; } Gets or sets the template used to create a column for each item in ColumnsSource.
ExtendScrollbarToFixedColumns { get; set; } Gets or sets whether the horizontal scrollbar extends under the fixed columns.
FilterPanelDisplayMode { get; set; } Gets or sets when the filter panel is displayed.
FilterPanelText { get; } Gets the text displayed in the filter panel.
FixedColumnSeparatorWidth { get; set; } Gets or sets the width of the separator marking fixed columns.
FixedLeftColumnWidth { get; } Gets the total width of columns fixed to the left edge.
FixedRightColumnWidth { get; } Gets the total width of columns fixed to the right edge.
FocusedColumn { get; set; } Gets or sets the focused column.
HeaderDropIndicatorWidth { get; set; } Gets or sets the width of the indicator shown between headers while a column is dragged.
HeaderPanelMinHeight { get; set; } Gets or sets the minimum height of the column header panel.
IsFilterPanelVisible { get; } Gets whether the filter panel is currently displayed.
NavigationMode { get; set; } Gets or sets whether keyboard navigation moves focus between cells or between rows.
RowDragMode { get; set; } Gets or sets whether rows are dragged by the row itself or by a drag handle.
RowIndicatorWidth { get; set; } Gets or sets the width of the row indicator.
SerializationInfo { get; } Gets the serialization info that stores the control's saved layout.
ShowAutoFilterRow { get; set; } Gets or sets whether the auto-filter row is displayed.
ShowBands { get; set; } Gets or sets whether band headers are displayed.
ShowBandSeparators { get; set; } Gets or sets whether separators between band headers are displayed.
ShowCheckAllNodesCheckBox { get; set; } Gets or sets whether the check box that checks all nodes is displayed.
ShowColumnHeaders { get; set; } Gets or sets whether the column header panel is displayed.
ShowColumnMenuFixedItem { get; set; } Gets or sets whether the fixed-column item is displayed in the column header context menu.
ShowConditionInAutoFilterRow { get; set; } Gets or sets whether the auto-filter row displays the applied filter condition.
ShowHorizontalLines { get; set; } Gets or sets whether horizontal grid lines are displayed.
ShowRowIndicator { get; } Gets whether the row indicator is displayed.
ShowTotalSummaries { get; set; } Gets or sets whether the total summary footer is displayed.
ShowVerticalLines { get; set; } Gets or sets whether vertical grid lines are displayed.
TotalSummaries { get; } Gets the collection of total summary items calculated across all rows.
TreeColumnFieldName { get; set; } Gets or sets the field name of the column that displays the tree hierarchy.
event AutoGeneratedColumns Occurs after columns are generated automatically.
event AutoGeneratingColumn Occurs when a column is generated automatically.
event CellValueChanged Occurs when a cell value has been changed.
event CellValueChanging Occurs while a cell value is being changed before it is posted to the data source.
event CustomColumnDisplayText Occurs when the display text of a cell is required.
event CustomColumnSort Occurs when column values are compared with custom logic during data sorting.
event CustomSummary Occurs when a summary item with the Custom summary type is calculated.
event CustomUnboundColumnData Occurs when a cell value of an unbound column is requested or posted.
event HiddenEditor Occurs after an in-place editor is closed.
event ShowingEditor Occurs before an in-place editor is activated.
event ShownEditor Occurs after an in-place editor is activated.
event ValidateCellValue Occurs when a cell value is validated.
BestFit(…) Applies best-fit sizing to the specified column.
BestFitAllColumns() Applies best-fit sizing to all visible columns.
ExportToImages(…) Exports the control's visible data to image files in the specified directory.
ExportToPdf(…) Exports the control's visible data to the specified file in PDF format. (2 methods)
ExportToXlsx(…) Exports the control's visible data to the specified file in XLSX format. (2 methods)
GetCellDisplayText(…) Returns the display text of the specified cell. (2 methods)
GetCellValue(…) Returns the value of the specified cell. (2 methods)
GetTotalSummaryValue(…) Returns the total summary value calculated for the specified summary item.
MoveNextCell() Moves focus to the next cell.
MovePrevCell() Moves focus to the previous cell.
PopulateColumns() Generates columns based on the data source fields.
ResetColumnWidth() Resets all column widths to their default values.
RestoreLayout(…) Restores the control's layout from the specified stream. (2 methods)
SaveLayout(…) Saves the control's layout to the specified stream. (2 methods)
SetCellValue(…) Sets the value of the specified cell. (2 methods)

See Also