This documentation is archived and is not being maintained.

CheckedListBox.SetItemCheckState Method

Sets the check state of the item at the specified index.

[Visual Basic]
Public Sub SetItemCheckState( _
   ByVal index As Integer, _
   ByVal value As CheckState _
)
[C#]
public void SetItemCheckState(
 int index,
 CheckState value
);
[C++]
public: void SetItemCheckState(
 int index,
 CheckState value
);
[JScript]
public function SetItemCheckState(
   index : int,
 value : CheckState
);

Parameters

index
The index of the item to set the state for.
value
One of the CheckState values.

Exceptions

Exception Type Condition
ArgumentException The index specified is less than zero.

-or-

The index is greater than or equal to the count of items in the list.

InvalidEnumArgumentException The value is not one of the CheckState values.

Remarks

The SetItemCheckState method raises the ItemCheck event.

Items set to CheckState.Indeterminate appear with a check mark in the check box, but the box is grayed to indicate the indeterminate status of the checked item.

Example

[Visual Basic, C#, C++] The following example enumerates the items in the CheckedListBox and checks every other item in the list. The example demonstrates using the SetItemCheckState and SetItemChecked methods to set the check state of an item. For every other item that is to be checked, SetItemCheckState is called to set the CheckState to Indeterminate, while SetItemChecked is called on the other item to set the checked state to Checked.

[Visual Basic, C#, C++] The example also demonstrates using the Items property to get the CheckedListBox.ObjectCollection to get the Count of items.

[Visual Basic] 
Private Sub CheckEveryOther_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles CheckEveryOther.Click
    ' Cycle through every item and check every other.
    Dim i As Integer

    ' Set flag to true to know when this code is being executed. Used in the ItemCheck
    ' event handler.
    insideCheckEveryOther = True

    For i = 0 To CheckedListBox1.Items.Count - 1
        ' For every other item in the list, set as checked.

        If ((i Mod 2) = 0) Then
            ' But for each other item that is to be checked, set as being in an
            ' indeterminate checked state.

            If ((i Mod 4) = 0) Then
                CheckedListBox1.SetItemCheckState(i, CheckState.Indeterminate)
            Else
                CheckedListBox1.SetItemChecked(i, True)
            End If
        End If
    Next

    insideCheckEveryOther = False

End Sub

[C#] 
private void CheckEveryOther_Click(object sender, System.EventArgs e) {
    // Cycle through every item and check every other.

    // Set flag to true to know when this code is being executed. Used in the ItemCheck
    // event handler.
    insideCheckEveryOther = true;

    for (int i = 0; i < checkedListBox1.Items.Count; i++) {
        // For every other item in the list, set as checked.
        if ((i % 2) == 0) {
            // But for each other item that is to be checked, set as being in an
            // indeterminate checked state.
            if ((i % 4) == 0)
                checkedListBox1.SetItemCheckState(i, CheckState.Indeterminate);
            else
                checkedListBox1.SetItemChecked(i, true);
        }
    }        

    insideCheckEveryOther = false;
}

[C++] 
private:
    void CheckEveryOther_Click(Object* /*sender*/, System::EventArgs* /*e*/) {
        // Cycle through every item and check every other.

        // Set flag to true to know when this code is being executed. Used in the ItemCheck
        // event handler.
        insideCheckEveryOther = true;

        for (int i = 0; i < checkedListBox1->Items->Count; i++) {
            // For every other item in the list, set as checked.
            if ((i % 2) == 0) {
                // But for each other item that is to be checked, set as being in an
                // indeterminate checked state.
                if ((i % 4) == 0)
                    checkedListBox1->SetItemCheckState(i, CheckState::Indeterminate);
                else
                    checkedListBox1->SetItemChecked(i, true);
            }
        }        

        insideCheckEveryOther = false;
    }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

CheckedListBox Class | CheckedListBox Members | System.Windows.Forms Namespace | CheckState

Show: