ColumnBase.SortOrder Property

Gets or sets the column’s sort order. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v24.1.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

[Browsable(false)]
public ColumnSortOrder SortOrder { get; set; }

VB.NET

<Browsable(False)>
Public Property SortOrder As ColumnSortOrder

Property Value

Type	Description
ColumnSortOrder	The column’s sort order.

Available values:

Name	Description
None	No sorting is applied to a column.
Ascending	Sorts the column in ascending order.
Descending	Sorts the columns in descending order.

Remarks

To sort data against a column, specify its SortOrder property:

XAML

<dxg:GridColumn FieldName="City" SortOrder="Descending"/>
<dxg:GridColumn FieldName="Visits" SortOrder="Ascending"/>
<dxg:GridColumn FieldName="Birthday" SortOrder="None"/>

The SortOrder property does not clear the sorting applied. This property adds a new sorting condition to previous ones.

Refer to the Sorting in Code topic for more information.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SortOrder 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.

XAML

wpf-data-grid-display-group-summaries/CS/DisplayGroupSummaries_CodeBehind/MainWindow.xaml#L15

<dxg:GridColumn FieldName="RegistrationDate" />
<dxg:GridColumn FieldName="Married" GroupIndex="0" SortOrder="Ascending" />
<dxg:GridColumn FieldName="Age" />

wpf-data-grid-getting-started-net-framework/CS/WPFDataGridGettingStartedNETFramework/MainWindow.xaml#L17

<dxg:GridColumn FieldName="OrderID" IsSmart="True"/>
<dxg:GridColumn FieldName="CustomerID" IsSmart="True" SortIndex="0" SortOrder="Ascending"/>
<dxg:GridColumn FieldName="OrderDate" IsSmart="True" SortIndex="1" SortOrder="Descending"/>

how-to-display-custom-text-within-dxgrid-cells-e2020/CS/DXGrid_DisplayCustomText/Window1.xaml#L5

<dxg:GridControl.Columns>
    <dxg:GridColumn x:Name="columnProductName" FieldName="ProductName" SortOrder="Ascending" Width="134" />
    <dxg:GridColumn x:Name="columnPrice" FieldName="Price" />

wpf-grid-prevent-expand-collapse-operations-for-group-rows/CS/Forbid_Expand_Collapse/MainWindow.xaml#L27

<dxg:GridColumn FieldName="Discount"/>
<dxg:GridColumn FieldName="Status" GroupIndex="0" SortOrder="Descending"/>
<dxg:GridControl.View>

wpf-data-grid-use-skip-tokens-to-optimize-paging/CS/MainWindow.xaml#L17

<dxg:GridColumn FieldName="Created" IsSmart="True" Width="*"
                AllowSorting="True" SortOrder="Descending">
    <dxg:GridColumn.EditSettings>

C#

wpf-data-grid-customize-automatically-generated-columns/CS/E2019/Window1.xaml.cs#L19

column.CellTemplate = Application.Current.MainWindow.Resources["IssueNameTemplate"] as DataTemplate;
column.SortOrder = DevExpress.Data.ColumnSortOrder.Ascending;
break;

VB.NET

wpf-data-grid-customize-automatically-generated-columns/VB/E2019/Window1.xaml.vb#L22

    column.CellTemplate = TryCast(Application.Current.MainWindow.Resources("IssueNameTemplate"), DataTemplate)
    column.SortOrder = DevExpress.Data.ColumnSortOrder.Ascending
Case "IssueType"