Back to Devexpress

CustomColumnSortEventArgs.Handled Property

wpf-devexpress-dot-xpf-dot-grid-dot-customcolumnsorteventargs-a606c029.md

latest3.6 KB
Original Source

CustomColumnSortEventArgs.Handled Property

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

Namespace : DevExpress.Xpf.Grid

Assembly : DevExpress.Xpf.Grid.v25.2.dll

NuGet Package : DevExpress.Wpf.Grid.Core

Declaration

csharp
public bool Handled { get; set; }
vb
Public Property Handled As Boolean

Property Value

TypeDescription
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 no default processing is required.

If the Handled property is left set to false , the default comparison mechanism will be invoked after the GridControl.CustomColumnSort event handler is raised. This overrides the result of your comparison operation specified by the CustomColumnSortEventArgs.Result property.

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.

wpf-data-grid-implement-custom-grouping/CS/CustomGrouping_CodeBehind/MainWindow.xaml.cs#L45

csharp
e.Result = x > 9 && y > 9 ? 0 : x.CompareTo(y);
    e.Handled = true;
}

wpf-data-grid-implement-custom-sorting/CS/CustomSorting_CodeBehind/MainWindow.xaml.cs#L45

csharp
e.Result = dayIndex1.CompareTo(dayIndex2);
    e.Handled = true;
}

wpf-data-grid-implement-custom-grouping/VB/CustomGrouping_CodeBehind/MainWindow.xaml.vb#L45

vb
e.Result = If(x > 9 AndAlso y > 9, 0, x.CompareTo(y))
    e.Handled = True
End Sub

wpf-data-grid-implement-custom-sorting/VB/CustomSorting_CodeBehind/MainWindow.xaml.vb#L52

vb
e.Result = dayIndex1.CompareTo(dayIndex2)
    e.Handled = True
End If

See Also

CustomColumnSortEventArgs Class

CustomColumnSortEventArgs Members

DevExpress.Xpf.Grid Namespace