Sorting in Code

• Sep 21, 2018

Sorting

The following methods and properties can be used to sort data:

• A column’s ColumnBase.SortOrder property specifies the column’s sort order. Set it to ColumnSortOrder.Ascending or ColumnSortOrder.Descending.

  C#

  grid.Columns["ProductName"].SortOrder = ColumnSortOrder.Ascending;
  

• Set a column’s ColumnBase.SortIndex property to a non-negative value. This automatically sorts its values in ascending order.
• Use the grid’s GridControl.SortBy method.

Unsorting

To unsort data by the values of a single column, do one of the following:

• Set the column’s ColumnBase.SortOrder property to ColumnSortOrder.None.
• Set the column’s ColumnBase.SortIndex property to -1.

• Use the grid’s GridControl.SortBy method:

  C#

  grid.SortBy(grid.Columns["ProductName"], ColumnSortOrder.None);
  

To clear the sorting applied to the grid, use the DataControlBase.ClearSorting method.

Note

If grouping is applied, the DataControlBase.ClearSorting method preserves sorting applied to grouping columns, because group rows are always sorted.

Sorting Events

When sorting data, the grid does the following:

• Raises the GridControl.StartSorting event.
• Sorts data.
• Raises the GridControl.EndSorting event.

Note

Group rows are always sorted. The StartSorting and EndSorting events are also raised before and after data is grouped.