CheckedComboBoxEdit.CustomSort Event

Fires when items in the drop-down list need to be sorted in custom order.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v25.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Events")]
public event EventHandler<CheckedListBoxCustomSortEventArgs> CustomSort

VB.NET

<DXCategory("Events")>
Public Event CustomSort As EventHandler(Of CheckedListBoxCustomSortEventArgs)

Event Data

The CustomSort event's data class is DevExpress.XtraEditors.Controls.CheckedListBoxCustomSortEventArgs.

Remarks

Handle the CustomSort event to compare two neighboring items (e.Item1 and e.Item2). You can compare items by their values (e.Value1, e.Value2) or display text (e.DisplayText1, e.DisplayText2). Set the e.Result event 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. For example, you can call this method within the ItemCheck event handler.

Note

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

Example

The following code snippet sorts checked items first, followed by unchecked items.

C#

using System.Windows.Forms;
using DevExpress.XtraEditors;
using DevExpress.XtraEditors.Controls;

public partial class Form1 : Form {
    public Form1() {
        InitializeComponent();
        checkedComboBoxEdit1.CustomSort += checkedComboBoxEdit1_CustomSort;
        checkedComboBoxEdit1.ItemCheck += checkedComboBoxEdit1_ItemCheck;
        checkedComboBoxEdit1.Properties.Items.AddRange(new CheckedListBoxItem[] {
            new CheckedListBoxItem() { Value = "Bart Arnaz" },
            new CheckedListBoxItem() { Value = "Leah Simpson" },
            new CheckedListBoxItem() { Value = "Arnie Schwartz" },
            new CheckedListBoxItem() { Value = "Billy Zimmer" },
            new CheckedListBoxItem() { Value = "Samantha Piper" },
            new CheckedListBoxItem() { Value = "Maggie Boxter" },
            new CheckedListBoxItem() { Value = "Brad Farkus" },
        });
    }

    void checkedComboBoxEdit1_CustomSort(object sender, CheckedListBoxCustomSortEventArgs e) {
        if (e.Item1.CheckState == e.Item2.CheckState)
            e.Result = ((string)e.Value1).CompareTo((string)e.Value2);
        else
            e.Result = e.Item1.CheckState == CheckState.Checked ? -1 : 1;
    }

    void checkedComboBoxEdit1_ItemCheck(object sender, DevExpress.XtraEditors.Controls.ItemCheckEventArgs e) {
        checkedComboBoxEdit1.Sort();
    }
}

VB.NET

Imports System.Windows.Forms
Imports DevExpress.XtraEditors
Imports DevExpress.XtraEditors.Controls

Public Partial Class Form1
    Inherits Form

    Public Sub New()
        InitializeComponent()

        AddHandler checkedComboBoxEdit1.CustomSort, AddressOf checkedComboBoxEdit1_CustomSort
        AddHandler checkedComboBoxEdit1.ItemCheck, AddressOf checkedComboBoxEdit1_ItemCheck

        checkedComboBoxEdit1.Properties.Items.AddRange(New CheckedListBoxItem() {
            New CheckedListBoxItem() With {.Value = "Bart Arnaz"},
            New CheckedListBoxItem() With {.Value = "Leah Simpson"},
            New CheckedListBoxItem() With {.Value = "Arnie Schwartz"},
            New CheckedListBoxItem() With {.Value = "Billy Zimmer"},
            New CheckedListBoxItem() With {.Value = "Samantha Piper"},
            New CheckedListBoxItem() With {.Value = "Maggie Boxter"},
            New CheckedListBoxItem() With {.Value = "Brad Farkus"}
        })
    End Sub

    Private Sub checkedComboBoxEdit1_CustomSort(sender As Object, e As CheckedListBoxCustomSortEventArgs)
        If e.Item1.CheckState = e.Item2.CheckState Then
            e.Result = String.Compare(CStr(e.Value1), CStr(e.Value2))
        Else
            e.Result = If(e.Item1.CheckState = CheckState.Checked, -1, 1)
        End If
    End Sub

    Private Sub checkedComboBoxEdit1_ItemCheck(sender As Object, e As DevExpress.XtraEditors.Controls.ItemCheckEventArgs)
        checkedComboBoxEdit1.Sort()
    End Sub

End Class