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.v24.1.dll

NuGet Package: DevExpress.Wpf.Grid.Core

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 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.

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#

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

    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

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

VB.NET

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

    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

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