GridColumn.SortOrder Property

Gets or sets the column’s sort order.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[DXCategory("Data")]
[DefaultValue(ColumnSortOrder.None)]
[XtraSerializablePropertyId(2)]
public ColumnSortOrder SortOrder { get; set; }

VB.NET

<DXCategory("Data")>
<DefaultValue(ColumnSortOrder.None)>
<XtraSerializablePropertyId(2)>
Public Property SortOrder As ColumnSortOrder

Property Value

Type	Default	Description
ColumnSortOrder	**None**	A ColumnSortOrder enumeration value specifying 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

Read the SortOrder property value to determine which sort order is currently applied to the column. Assign a value to this property to sort data by the current column’s values. Note that any previous sorting is not cleared when changing the SortOrder property value. The new sort order applies an additional sorting condition to that previously applied. The newly sorted column is added to the ColumnView.SortedColumns collection as the result. Its index within the collection can be obtained using the GridColumn.SortIndex property.

The GridColumn.SortMode property specifies how the column’s data is sorted (by display text, edit values or using a custom sorting algorithm).

To clear the sorting applied previously, call the View’s ColumnView.ClearSorting method.

If you need to change the SortOrder property value in the form’s Load event handler, you should call the GridControl.ForceInitialize method in advance.

To learn more about sorting, see the Sorting in Code topic.

Example

The following example sorts data by two columns in a Grid View. The code is enclosed within calls to the ColumnView.BeginDataUpdate and BaseView.EndDataUpdate methods. This speeds up performance by sorting the data only once, after the BaseView.EndDataUpdate method is called.

C#

    gridView1.BeginDataUpdate();
    try {
        gridView1.ClearSorting();
        gridView1.Columns["Trademark"].SortOrder = DevExpress.Data.ColumnSortOrder.Ascending;
        gridView1.Columns["Model"].SortOrder = DevExpress.Data.ColumnSortOrder.Ascending;
    }
    finally {
        gridView1.EndDataUpdate();
    }

VB.NET

    gridView1.BeginDataUpdate()
    Try
        gridView1.ClearSorting()
        gridView1.Columns("Trademark").SortOrder = DevExpress.Data.ColumnSortOrder.Ascending
        gridView1.Columns("Model").SortOrder = DevExpress.Data.ColumnSortOrder.Ascending
    Finally
        gridView1.EndDataUpdate()
    End Try

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-make-the-grid-always-be-sorted-by-a-particular-column-e759/CS/Form1.cs#L44

{
    if (column.SortOrder != DevExpress.Data.ColumnSortOrder.Ascending || column.SortIndex != view.SortInfo.Count - 1)
    {

how-to-provide-sorting-functionality-for-the-grid-that-allows-drag-and-drop-row-reordering-e3149/CS/E3149/Form1.cs#L238

    gridView1.PopulateColumns();
    gridView1.Columns[OrderFieldName].SortOrder = DevExpress.Data.ColumnSortOrder.Ascending;
}

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.cs#L85

foreach(GridColumn col in grid.SortedColumns) {
    list.Sorting.Add(new SnapListGroupParam(col.FieldName, col.SortOrder));
}

grid-how-to-custom-paint-sort-glyphs-in-column-headers-t360328/CS/CustomDrawColumnHeader-SortButton/Form1.cs#L31

    gridControl1.MainView.PopulateColumns();
    (gridControl1.MainView as ColumnView).Columns["Country"].SortOrder = ColumnSortOrder.Ascending;
}

how-to-show-the-sort-dialog-in-a-grid-in-a-similar-manner-as-in-excel-e2941/CS/WindowsApplication3/SortForm.cs#L49

    foreach (GridColumn col in view.SortedColumns)
        sortTree.AppendNode(new object[] { col, col.SortMode, col.SortOrder }, null);
}

VB.NET

how-to-make-the-grid-always-be-sorted-by-a-particular-column-e759/VB/Form1.vb#L41

If checkEdit1.Checked Then
    If column.SortOrder <> DevExpress.Data.ColumnSortOrder.Ascending OrElse column.SortIndex <> view.SortInfo.Count - 1 Then
        column.SortIndex = view.SortInfo.Count

how-to-provide-sorting-functionality-for-the-grid-that-allows-drag-and-drop-row-reordering-e3149/VB/E3149/Form1.vb#L226

    gridView1.PopulateColumns()
    gridView1.Columns(OrderFieldName).SortOrder = DevExpress.Data.ColumnSortOrder.Ascending
End Sub

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.vb#L88

For Each col As GridColumn In grid.SortedColumns
    list.Sorting.Add(New SnapListGroupParam(col.FieldName, col.SortOrder))
Next col

how-to-show-the-sort-dialog-in-a-grid-in-a-similar-manner-as-in-excel-e2941/VB/WindowsApplication3/SortForm.vb#L47

For Each col As GridColumn In view.SortedColumns
    sortTree.AppendNode(New Object() {col, col.SortMode, col.SortOrder}, -1)
Next col

reporting-winforms-convert-grid-to-report/VB/XtraReport1.vb#L48

Dim gf As GroupField
If gridColumn.SortOrder = ColumnSortOrder.Ascending Then
    gf = New GroupField(gridColumn.FieldName, XRColumnSortOrder.Ascending)