CheckedListBox.CheckedIndices Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

CheckedListBox.cs

Collection of checked indexes in this CheckedListBox.

C#

[System.ComponentModel.Browsable(false)]
public System.Windows.Forms.CheckedListBox.CheckedIndexCollection CheckedIndices { get; }

Property Value

CheckedListBox.CheckedIndexCollection

The CheckedListBox.CheckedIndexCollection collection for the CheckedListBox.

Attributes

BrowsableAttribute

Examples

The following example enumerates the checked items in the CheckedListBox.CheckedIndexCollection to see what check state an item is in. The example demonstrates using the CheckedIndices property to get the CheckedListBox.CheckedIndexCollection, and the CheckedItems property to get the CheckedListBox.CheckedItemCollection.

The first loop uses the GetItemCheckState method to get the CheckState of each checked item, given the index of the item. The second loop also uses GetItemCheckState, but uses the ListBox.ObjectCollection.IndexOf method to retrieve the index for the item.

C#

private void WhatIsChecked_Click(object sender, System.EventArgs e) {
    // Display in a message box all the items that are checked.

    // First show the index and check state of all selected items.
    foreach(int indexChecked in checkedListBox1.CheckedIndices) {
        // The indexChecked variable contains the index of the item.
        MessageBox.Show("Index#: " + indexChecked.ToString() + ", is checked. Checked state is:" +
                        checkedListBox1.GetItemCheckState(indexChecked).ToString() + ".");
    }

    // Next show the object title and check state for each item selected.
    foreach(object itemChecked in checkedListBox1.CheckedItems) {

        // Use the IndexOf method to get the index of an item.
        MessageBox.Show("Item with title: \"" + itemChecked.ToString() +
                        "\", is checked. Checked state is: " +
                        checkedListBox1.GetItemCheckState(checkedListBox1.Items.IndexOf(itemChecked)).ToString() + ".");
    }
}

Remarks

The collection of checked indexes is a subset of the indexes into the collection of all items in the CheckedListBox control. These indexes specify items in a checked or indeterminate state.

Applies to

See also

• CheckedListBox.CheckedIndexCollection