How to: Respond to Checking Items in CheckedListBoxControl

• Oct 25, 2019
• 2 minutes to read

The code below shows a message when a list box item’s check state changes and prevents the first item from being checked.

C#

using DevExpress.XtraEditors;
using DevExpress.XtraEditors.Controls;

for (int i = 0; i < 10; i++)
    checkedListBoxControl1.Items.Add(new CheckedListBoxItem(i, "Item " + i.ToString()));
checkedListBoxControl1.ItemChecking += CheckedListBoxControl1_ItemChecking;
checkedListBoxControl1.ItemCheck += checkedListBoxControl1_ItemCheck;

private void CheckedListBoxControl1_ItemChecking(object sender, ItemCheckingEventArgs e) {
    CheckedListBoxControl checkedListBox = (CheckedListBoxControl)sender;
    CheckedListBoxItem item = (CheckedListBoxItem)checkedListBox.GetItem(e.Index);
    if (item.Description == "Item 0") {
        MessageBox.Show($"You cannot change the {item.Description} item check state.");
        e.Cancel = true;
    }
}

private void checkedListBoxControl1_ItemCheck(object sender, DevExpress.XtraEditors.Controls.ItemCheckEventArgs e) {
    CheckedListBoxControl checkedListBox = (CheckedListBoxControl)sender;
    CheckedListBoxItem item = (CheckedListBoxItem)checkedListBox.GetItem(e.Index);
    MessageBox.Show($"The {item.Description} item with the {item.Value} value is {item.CheckState}.");
}

VB.NET

Imports DevExpress.XtraEditors
Imports DevExpress.XtraEditors.Controls

For i As Integer = 0 To 9
    checkedListBoxControl1.Items.Add(New CheckedListBoxItem(i, "Item " & i.ToString()))
Next i
AddHandler checkedListBoxControl1.ItemChecking, AddressOf CheckedListBoxControl1_ItemChecking
AddHandler checkedListBoxControl1.ItemCheck, AddressOf checkedListBoxControl1_ItemCheck

Private Sub CheckedListBoxControl1_ItemChecking(ByVal sender As Object, ByVal e As ItemCheckingEventArgs)
    Dim checkedListBox As CheckedListBoxControl = DirectCast(sender, CheckedListBoxControl)
    Dim item As CheckedListBoxItem = DirectCast(checkedListBox.GetItem(e.Index), CheckedListBoxItem)
    If item.Description = "Item 0" Then
        MessageBox.Show($"You cannot change the {item.Description} item check state.")
        e.Cancel = True
    End If
End Sub

Private Sub checkedListBoxControl1_ItemCheck(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.ItemCheckEventArgs)
    Dim checkedListBox As CheckedListBoxControl = DirectCast(sender, CheckedListBoxControl)
    Dim item As CheckedListBoxItem = DirectCast(checkedListBox.GetItem(e.Index), CheckedListBoxItem)
    MessageBox.Show($"The {item.Description} item with the {item.Value} value is {item.CheckState}.")
End Sub