ColumnBase.SortOrder Property

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

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

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

VB.NET

<Browsable(False)>
Public Property SortOrder As ColumnSortOrder

Property Value

Type	Description
ColumnSortOrder	A ColumnSortOrder enumeration value that specifies 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

Any previous sorting is not cleared when changing the SortOrder property’s value. The new sort order applies an additional sorting condition to the one previously applied.

To apply sorting, you can also use the GridControl.SortBy method. To learn more, see Sorting in Code.

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.

C#

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

    <dxg:GridColumn FieldName="MyDateTime" Name="gridColumn5" />
    <dxg:GridColumn FieldName="MyTime" Name="gridColumn6" SortIndex="0" SortOrder="Ascending"/>
</dxg:GridControl.Columns>

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-forbid-expand-collapse-operations-for-group-rows/CS/DXGrid_PreventGroupRowFromCollapsing/Window1.xaml#L13

    <dxg:GridColumn FieldName="Discount" Width="75" />
    <dxg:GridColumn FieldName="Status" GroupIndex="0" SortOrder="Descending" x:Name="colStatus" />
</dxg:GridControl.Columns>

how-to-use-skip-tokens-to-optimize-paging/CS/MainWindow.xaml#L17

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

how-to-bind-to-custom-service-with-restrictions/CS/MainWindow.xaml#L18

<dxg:GridControl.Columns>
    <dxg:GridColumn x:Name="hotColumn" FieldName="Hot" Visible="False" ShowInColumnChooser="False" AllowSorting="True" AllowedSortOrders="Descending" SortOrder="Descending"/>
    <dxg:GridColumn x:Name="weekColumn" FieldName="Week" Visible="False" ShowInColumnChooser="False" AllowSorting="True" AllowedSortOrders="Descending" />

VB.NET

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/VB/DXGridSample/ReportHelper.vb#L78

gb.RepeatEveryPage = shouldRepeatGroupHeadersOnEveryPage
Dim gf As New GroupField(groupedColumn.FieldName,If(groupedColumn.SortOrder = ColumnSortOrder.Ascending, XRColumnSortOrder.Ascending, XRColumnSortOrder.Descending))
gb.GroupFields.Add(gf)

how-to-provide-a-way-to-change-the-gridcolumn-behavior-when-a-user-clicks-the-header-e2110/VB/Window1.xaml.vb#L48

Protected Overrides Sub OnColumnHeaderClick(ByVal column As ColumnBase, ByVal isShift As Boolean, ByVal isCtrl As Boolean)
    MyBase.OnColumnHeaderClick(column, isShift, column.SortOrder = ColumnSortOrder.Descending)
End Sub

how-to-customize-automatically-generated-columns-e2019/VB/E2019/Window1.xaml.vb#L21

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