ColumnBase.SortMode Property

Gets or sets how the column’s data is sorted when sorting is applied to it. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v18.2.Core.dll

Declaration

C#

[DefaultValue(ColumnSortMode.Default)]
public ColumnSortMode SortMode { get; set; }

VB.NET

<DefaultValue(ColumnSortMode.Default)>
Public Property SortMode As ColumnSortMode

Property Value

Type	Default	Description
ColumnSortMode	**Default**	A ColumnSortMode enumeration value that specifies the sort mode.

Available values:

Name	Description
Default	Sorts the column’s data according to the type of the editor assigned to the column. The Default option is equivalent to DisplayText for columns that use LookUpEdit, ImageComboBoxEdit and HypertextLabel (RepositoryItemHypertextLabel) in-place editors. The Default option is equivalent to Value for other columns. Note that for certain editors (TextEdit, ComboBoxEdit, etc) the edit values match the display values.
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	Enables custom sorting of a column’s data. To implement custom sorting, handle the ColumnView.CustomColumnSort event in the GridControl, and the TreeList.CompareNodeValues event in the TreeList. In the GridControl, the Custom mode also enables custom grouping of rows when grouping is applied against the current column. To implement custom grouping, handle the GridView.CustomColumnGroup event.

Remarks

The SortMode property specifies the algorithm used to sort the column’s data (by display text, edit value or using a custom sorting algorithm).

To provide custom sorting and/or grouping, set the SortMode property to ‘Custom’ and handle the GridControl.CustomColumnSort and GridControl.CustomColumnGroup events.

To learn more, see Sorting Modes and Custom Sorting.

Related GitHub Examples

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

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-implement-custom-grouping-e1530/CS/DXGrid_CustomGrouping/Window1.xaml#L16

<dxg:GridColumn FieldName="LastName" />
<dxg:GridColumn FieldName="UnitPrice" SortMode="Custom" GroupIndex="0">
    <dxg:GridColumn.EditSettings>

wpf-data-grid-implement-custom-sorting/CS/Window1.xaml#L9

<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="Day" GroupIndex="0" SortMode="Custom" />
    <dxg:GridColumn FieldName="Employee" />

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/CS/DXGridSample/Window17.xaml#L18

<dxg:GridColumn FieldName="Text" Name="gridColumn2"/>
<dxg:GridColumn FieldName="Number" SortMode="DisplayText" Name="gridColumn3"/>
<dxg:GridColumn FieldName="Group" Name="gridColumn4"/>

how-to-use-sorting-and-filtering-with-a-custom-object-t151940/VB/FilteringWithComboBoxEditor/MainWindow.xaml#L17

<dxg:GridColumn FieldName="Name" />
<dxg:GridColumn FieldName="Value" AllowSorting="True" SortMode="DisplayText" ColumnFilterMode="DisplayText"
                EditSettings="{dxe:TextSettings DisplayTextConverter={StaticResource converter}}">