TreeListColumn.SortMode Property

Gets or sets how the column’s data is sorted when sorting is applied.

Namespace: DevExpress.XtraTreeList.Columns

Assembly: DevExpress.XtraTreeList.v22.2.dll

NuGet Package: DevExpress.Win.TreeList

Declaration

C#

[DefaultValue(ColumnSortMode.Default)]
[DXCategory("Data")]
[XtraSerializableProperty]
public ColumnSortMode SortMode { get; set; }

VB.NET

<DXCategory("Data")>
<DefaultValue(ColumnSortMode.Default)>
<XtraSerializableProperty>
Public Property SortMode As ColumnSortMode

Property Value

Type	Default	Description
ColumnSortMode	Default	A ColumnSortMode value specifying how the column’s data is sorted in sort mode.

Available values:

Name	Description
Default	Switches between DisplayText and Value modes based on the column editor’s type.
Value	Sorts the column’s data by the column’s edit values (these are synchronized with the bound data source’s values).
DisplayText	Sorts the column’s data by the column’s display text (the strings displayed within the column’s cells).
Custom	Applies sort options specified in the CustomColumnSort event handler. In data grids, this mode also applies group options from the CustomColumnGroup event handler.

Remarks

The SortMode property determines the algorithm used to sort the column’s data (by display text, edit value or using a custom sorting algorithm). To provide custom sorting, set the SortMode property to ColumnSortMode.Custom and handle the TreeList.CustomColumnSort event.