GridControl.CustomColumnSort Event

Enables you to sort data using custom rules.

Namespace: DevExpress.UI.Xaml.Grid

Assembly: DevExpress.UI.Xaml.Grid.v19.2.dll

Declaration

public event CustomColumnSortEventHandler CustomColumnSort
Public Event CustomColumnSort As CustomColumnSortEventHandler

Event Data

The CustomColumnSort event handler receives an argument of the CustomColumnSortEventArgs type. The following properties provide information specific to this event.

Property Description
Column Gets the column whose values are being compared.
Handled Gets or sets whether a comparison operation is handled and no default processing is required.
ListSourceRowIndex1 Gets the index of the first of the two rows being compared in the data source.
ListSourceRowIndex2 Gets the index of the second of the two rows being compared in the data source.
Result Gets or sets the result of a custom comparison.
SortOrder Gets the sort order applied to the column.
Source Gets the grid control that raised the event.
Value1 Gets the first value being compared.
Value2 Gets the second value being compared.

Remarks

To sort column values using custom logic, set a column's ColumnBase.SortMode property to ColumnSortMode.Custom, and handle the CustomColumnSort event.

When this event is fired, two rows should be compared. The column being processed is specified by the Column parameter. The Value1 and Value2 parameters identify the values of the rows within this column. The result of the custom comparison should be set to the Result parameter as follows:

  • -1 if the first row should be positioned above the second row when data is sorted in ascending order. When data is sorted in descending order, the first row will be positioned below the second row.
  • 1 if the first row should be positioned below the second row when data is sorted in ascending order. When data is sorted in descending order, the first row will be positioned above the second row.
  • 0 to indicate that the rows are equal. In this case, the rows will be arranged within a grid according to their indices in a data source.

The event parameter's Handled property should be set to true if the comparison operation was handled. You can leave this parameter set to false to invoke the default comparison mechanism after your event handler has finished. In this instance, the custom comparison operation's result is ignored.

See Also