CheckedListBox.SetItemChecked Method (System.Windows.Forms)

SetItemChecked Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

CheckedListBox..::.SetItemChecked Method

Sets CheckState for the item at the specified index to Checked.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic (Declaration)

Public Sub SetItemChecked ( _
    index As Integer, _
    value As Boolean _
)

Visual Basic (Usage)

Dim instance As CheckedListBox
Dim index As Integer
Dim value As Boolean

instance.SetItemChecked(index, value)

public void SetItemChecked(
    int index,
    bool value
)

Visual C++

public:
void SetItemChecked(
    int index, 
    bool value
)

JScript

public function SetItemChecked(
    index : int, 
    value : boolean
)

Parameters

index: Type: System..::.Int32
The index of the item to set the check state for.

value: Type: System..::.Boolean
true to set the item as checked; otherwise, false.

Exceptions

Exception	Condition
ArgumentException	The index specified is less than zero. -or- The index is greater than the count of items in the list.

Exception

Condition

ArgumentException

The index specified is less than zero.

-or-

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

Remarks

When a value of true is passed, this method sets the CheckState value to Checked. A value of false sets CheckState to Unchecked.

Examples

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.

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

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;
}

Visual C++

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;
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

CheckedListBox Class

CheckedListBox Members

System.Windows.Forms Namespace