ListBoxControl.CustomSort Event

Enables you to sort list items in custom order.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Behavior")]
public event EventHandler<ListBoxCustomSortEventArgs> CustomSort

VB.NET

<DXCategory("Behavior")>
Public Event CustomSort As EventHandler(Of ListBoxCustomSortEventArgs)

Event Data

The CustomSort event's data class is DevExpress.XtraEditors.ListBoxCustomSortEventArgs.

Remarks

Handle the CustomSort event to compare two neighboring items. You can compare items by their values (e.Value1, e.Value2) or display text (e.DisplayText1, e.DisplayText2). Set the e.Result parameter to 1 to position the first item above the second item, or set it to -1 to position the second item above the first item.

For optimization purposes, the editor itself does not raise the CustomSort event. Use the Sort() method to raise the CustomSort event when needed.

Note

1. Custom sorting does not work in bound mode.
2. The SortOrder property is ignored when you handle the CustomSort event.