TreeListColumn Class

Represents a single column in the TreeList control.

Namespace: DevExpress.XtraTreeList.Columns

Assembly: DevExpress.XtraTreeList.v18.1.dll

Declaration

C#

public class TreeListColumn :
    Component,
    IAppearanceOwner,
    IDataColumnInfo,
    IHeaderObject,
    IXtraSerializableLayoutEx

VB.NET

Public Class TreeListColumn
    Inherits Component
    Implements IAppearanceOwner,
               IDataColumnInfo,
               IHeaderObject,
               IXtraSerializableLayoutEx

Related API Members

The following members accept/return TreeListColumn objects:

Show 31 links

• CellEventArgs.Column
• ColumnChangedEventArgs.Column
• CompareNodeValuesEventArgs.Column
• CustomDrawColumnHeaderEventArgs.Column
• CustomDrawFooterCellEventArgs.Column
• CustomDrawNodeCellEventArgs.Column
• FilterCondition.Column
• FocusedColumnChangedEventArgs.OldColumn
• GetCustomSummaryValueEventArgs.Column
• StyleFormatCondition.Column
• TreeList.AutoFillColumn
• TreeList.FocusedColumn
• TreeList.GetColumnByColumnHandle(Int32)
• TreeList.GetColumnByVisibleIndex(Int32)
• TreeList.GetSortColumn(Int32)
• TreeList.HierarchyColumn
• TreeList.TreeViewColumn
• TreeListColumnCollection.Add()
• TreeListColumnCollection.AddField(String)
• TreeListColumnCollection.AddVisible(String)
• TreeListColumnCollection.ColumnByFieldName(String)
• TreeListColumnCollection.ColumnByName(String)
• TreeListColumnCollection.Insert(Int32)
• TreeListColumnCollection.Item[Int32]
• TreeListColumnCollection.Item[String]
• TreeListFormatRule.Column
• TreeListFormatRule.ColumnApplyTo
• TreeListHitInfo.Column
• TreeListMenuItemClickEventArgs.Column
• VirtualTreeGetCellValueInfo.Column
• VirtualTreeSetCellValueInfo.Column

Remarks

The TreeListColumn class encapsulates a single column in the TreeList.

A Tree List column is a component. If a column is created at design time, it can be accessed in code by its name.

All columns can be accessed using the TreeList.Columns collection. This property provides an indexer (TreeListColumnCollection.Item) that enables you to access columns by their indexes (TreeListColumn.AbsoluteIndex) and field names (TreeListColumn.FieldName).

The TreeListColumn.Caption property allows you to set a column header to a custom string.

The TreeListColumn.OptionsColumn property defines a set of settings that control column focus, movement, data sorting and column size modifications. The appearance of column cells can be customized with the TreeListColumn.AppearanceCell property.

To change the text format of column cell values, use the TreeListColumn.Format property.

You can calculate summaries against a column using the TreeListColumn.RowFooterSummary and TreeListColumn.SummaryFooter properties.

To access a column value in a specific node, use the indexer provided by the Tree List node (TreeListNode.Item).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TreeListColumn class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-use-treelist-for-file-management-drag-and-drop-files-and-folders-e3400/CS/FileList/FileListHelper.cs#L17

TreeList Tree;
private DevExpress.XtraTreeList.Columns.TreeListColumn treeListColumn1;
private DevExpress.XtraTreeList.Columns.TreeListColumn treeListColumn2;

how-to-add-a-horizontal-cells-merge-capability-to-an-xtratreelist-control-e2501/CS/TreeListCellMerging/MergeCellsEventArgs.cs#L12

private string currentCellDisplayText;
private TreeListColumn currentColumn;
private DefaultBoolean merge;

how-to-print-a-treelist-that-supports-the-horizontal-cell-merging-capability-e4344/CS/TreeListCellMerging/MergeCellsEventArgs.cs#L11

private string currentCellDisplayText;
private TreeListColumn currentColumn;
private bool merge;

how-to-change-the-field-value-of-all-child-nodes-of-a-certain-node-e751/CS/Form1.cs#L21

private DevExpress.XtraTreeList.TreeList treeList1;
private DevExpress.XtraTreeList.Columns.TreeListColumn treeListColumn1;
private DevExpress.XtraTreeList.Columns.TreeListColumn treeListColumn2;

how-to-use-the-expressioneditorform-as-a-stand-alone-control-e1705/CS/Standalone ExpressionEditor/UnboundExpressionPanel.cs#L35

    columnContext = new GridColumnIDataColumnInfoWrapper(column as GridColumn, GridColumnIDataColumnInfoWrapperEnum.ExpressionEditor);
if (column is TreeListColumn)
    columnContext = column as IDataColumnInfo;

VB.NET

how-to-use-treelist-for-file-management-drag-and-drop-files-and-folders-e3400/VB/FileList/FileListHelper.vb#L16

Private Tree As TreeList
Private treeListColumn1 As DevExpress.XtraTreeList.Columns.TreeListColumn
Private treeListColumn2 As DevExpress.XtraTreeList.Columns.TreeListColumn

how-to-add-a-horizontal-cells-merge-capability-to-an-xtratreelist-control-e2501/VB/TreeListCellMerging/MergeCellsEventArgs.vb#L12

Private currentCellDisplayText_Renamed As String
Private currentColumn_Renamed As TreeListColumn
Private merge_Renamed As DefaultBoolean

how-to-print-a-treelist-that-supports-the-horizontal-cell-merging-capability-e4344/VB/TreeListCellMerging/MergeCellsEventArgs.vb#L11

Private currentCellDisplayText_Renamed As String
Private currentColumn_Renamed As TreeListColumn
Private merge_Renamed As Boolean

how-to-change-the-field-value-of-all-child-nodes-of-a-certain-node-e751/VB/Form1.vb#L21

Private treeList1 As DevExpress.XtraTreeList.TreeList
Private treeListColumn1 As DevExpress.XtraTreeList.Columns.TreeListColumn
Private treeListColumn2 As DevExpress.XtraTreeList.Columns.TreeListColumn

how-to-use-the-expressioneditorform-as-a-stand-alone-control-e1705/VB/Standalone ExpressionEditor/UnboundExpressionPanel.vb#L36

End If
If TypeOf column Is TreeListColumn Then
    columnContext = TryCast(column, IDataColumnInfo)

Inheritance

Object

MarshalByRefObject

Component

TreeListColumn