The requested page is not available for the requested platform. You are viewing the content for Default platform.

DataGridView.SortBy(GridColumn, ColumnSortOrder, Int32) Method

Sorts data by values of the specified column in the specified order, and places the column at the specified position among the sorted columns.

Namespace: DevExpress.XamarinForms.DataGrid

Assembly: DevExpress.XamarinForms.Grid.dll

Declaration

public void SortBy(
    GridColumn column,
    ColumnSortOrder sortOrder,
    int sortIndex
)

Parameters

Name Type Description
column GridColumn

A GridColumn object or descendant that specifies the grid's column.

sortOrder ColumnSortOrder

The sort order.

sortIndex Int32

The zero-based column's index among the sorted columns.

Remarks

Use the SortBy method to sort data in the grid.

  • Single-Column Sorting (Default)
    The grid allows data sorting by a single column only, if the DataGridView.SortMode property is set to Single.
    In this case, when you call the SortBy method, the grid discards the previously applied sorting by another column.

  • Multi-Column Sorting
    The grid supports multi-column sorting, if the DataGridView.SortMode property is set to Multiple.
    When you call the SortBy method, the grid does not clear previously applied sorting and uses the new sort order as an additional condition to sort data. The sortIndex parameter specifies the sequence of column sorting.

Another way to sort data in the grid by column values is to use the column's GridColumn.SortOrder property. To specify the sorting sequence applied to multiple columns, use the GridColumn.SortIndex of these columns.

To specify whether the grid should sort data by cell values or display text, use the GridColumn.SortMode property.

To prevent end users from sorting data, use the DataGridView.AllowSort and GridColumn.AllowSort properties.

To cancel sorting, use the DataGridView.ClearSorting method.

See Also