CustomColumnSortEventArgs.Handled Property

Gets or sets whether a comparison operation is handled and therefore no default processing is required.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public bool Handled { get; set; }

VB.NET

Public Property Handled As Boolean

Property Value

Type	Description
Boolean	true if a comparison operation is handled; otherwise false.

Remarks

Set the Handled property to true to indicate that the current comparison operation is handled and therefore no default processing is required. If this property is left set to false the default comparison mechanism will be invoked after your ColumnView.CustomColumnSort (or GridView.CustomColumnGroup) event handler is called. This will then override the result of your comparison operation which is specified by the CustomColumnSortEventArgs.Result property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Handled 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-sort-grid-columns-taking-into-account-a-hidden-column-or-field-e420/CS/WindowsApplication9/Form1.cs#L33

int category2 = (int)((DataRowView)ds[e.ListSourceRowIndex2])["CategoryID"];
e.Handled = true;
if (category1 > category2 && e.SortOrder == DevExpress.Data.ColumnSortOrder.Ascending

how-to-put-custom-rows-in-grid-control-e3367/CS/CustomRowInGrid/CustomRowInGrid/Form1.cs#L101

    e.Handled = true;
}

VB.NET

how-to-sort-grid-columns-taking-into-account-a-hidden-column-or-field-e420/VB/WindowsApplication9/Form1.vb#L30

Dim category2 As Integer = CInt(Fix((CType(ds(e.ListSourceRowIndex2), DataRowView))("CategoryID")))
e.Handled = True
If category1 > category2 AndAlso e.SortOrder = DevExpress.Data.ColumnSortOrder.Ascending OrElse category1 < category2 AndAlso e.SortOrder = DevExpress.Data.ColumnSortOrder.Descending Then

how-to-put-custom-rows-in-grid-control-e3367/VB/CustomRowInGrid/Form1.vb#L105

    e.Handled = True
End If