CheckedListBox.ObjectCollection.Add Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Adds an item to the list of items for a CheckedListBox.

Overloads

Add(Object, Boolean)	Adds an item to the list of items for a CheckedListBox, specifying the object to add and whether it is checked.
Add(Object, CheckState)	Adds an item to the list of items for a CheckedListBox, specifying the object to add and the initial checked value.

Add(Object, Boolean)

Adds an item to the list of items for a CheckedListBox, specifying the object to add and whether it is checked.

public:
 int Add(System::Object ^ item, bool isChecked);

public int Add (object item, bool isChecked);

override this.Add : obj * bool -> int

Public Function Add (item As Object, isChecked As Boolean) As Integer

Parameters

item

Object

An object representing the item to add to the collection.

isChecked

Boolean

true to check the item; otherwise, false.

Returns

Int32

The index of the newly added item.

Examples

The following code example demonstrates initializing a CheckedListBox control by setting the CheckOnClick, SelectionMode, and ThreeDCheckBoxes properties. The example populates the CheckedListBox with controls and sets the DisplayMember to the Control.Name property of the control.

To run the example, paste the following code in a form containing a CheckedListBox named CheckedListBox1 and call the InitializeCheckListBox method from the form's constructor or Load method.

   // This method initializes CheckedListBox1 with a list of all 
   // the controls on the form. It sets the selection mode
   // to single selection and allows selection with a single click.
   // It adds itself to the list before adding itself to the form.
internal:
   System::Windows::Forms::CheckedListBox^ CheckedListBox1;

private:
   void InitializeCheckedListBox()
   {
      this->CheckedListBox1 = gcnew CheckedListBox;
      this->CheckedListBox1->Location = System::Drawing::Point( 40, 90 );
      this->CheckedListBox1->CheckOnClick = true;
      this->CheckedListBox1->Name = "CheckedListBox1";
      this->CheckedListBox1->Size = System::Drawing::Size( 120, 94 );
      this->CheckedListBox1->TabIndex = 1;
      this->CheckedListBox1->SelectionMode = SelectionMode::One;
      this->CheckedListBox1->ThreeDCheckBoxes = true;
      System::Collections::IEnumerator^ myEnum = this->Controls->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         Control^ aControl = safe_cast<Control^>(myEnum->Current);
         this->CheckedListBox1->Items->Add( aControl, false );
      }

      this->CheckedListBox1->DisplayMember = "Name";
      this->CheckedListBox1->Items->Add( CheckedListBox1 );
      this->Controls->Add( this->CheckedListBox1 );
   }

// This method initializes CheckedListBox1 with a list of all 
// the controls on the form. It sets the selection mode
// to single selection and allows selection with a single click.
// It adds itself to the list before adding itself to the form.

internal System.Windows.Forms.CheckedListBox CheckedListBox1;

private void InitializeCheckedListBox()
{
    this.CheckedListBox1 = new CheckedListBox();
    this.CheckedListBox1.Location = new System.Drawing.Point(40, 90);
    this.CheckedListBox1.CheckOnClick = true;
    this.CheckedListBox1.Name = "CheckedListBox1";
    this.CheckedListBox1.Size = new System.Drawing.Size(120, 94);
    this.CheckedListBox1.TabIndex = 1;
    this.CheckedListBox1.SelectionMode = SelectionMode.One;
    this.CheckedListBox1.ThreeDCheckBoxes = true;

    foreach ( Control aControl in this.Controls )
    {
        this.CheckedListBox1.Items.Add(aControl, false);
    }

    this.CheckedListBox1.DisplayMember = "Name";
    this.CheckedListBox1.Items.Add(CheckedListBox1);
    this.Controls.Add(this.CheckedListBox1);
}

' This method initializes CheckedListBox1 with a list of all the controls
' on the form. It sets the selection mode to single selection and
' allows selection with a single click. It adds itself to the list before 
' adding itself to the form.
Friend WithEvents CheckedListBox1 As System.Windows.Forms.CheckedListBox

Private Sub InitializeCheckedListBox()
    Me.CheckedListBox1 = New CheckedListBox
    Me.CheckedListBox1.Location = New System.Drawing.Point(40, 90)
    Me.CheckedListBox1.CheckOnClick = True
    Me.CheckedListBox1.Name = "CheckedListBox1"
    Me.CheckedListBox1.Size = New System.Drawing.Size(120, 94)
    Me.CheckedListBox1.TabIndex = 1
    Me.CheckedListBox1.SelectionMode = SelectionMode.One
    Me.CheckedListBox1.ThreeDCheckBoxes = True

    Dim aControl As Control
    For Each aControl In Me.Controls
        Me.CheckedListBox1.Items.Add(aControl, False)
    Next

    Me.CheckedListBox1.DisplayMember = "Name"
    Me.CheckedListBox1.Items.Add(CheckedListBox1)
    Me.Controls.Add(Me.CheckedListBox1)
End Sub

Remarks

This method adds an item to the list. For a list, the item is added to the end of the existing list of items. For a sorted checked list box, the item is inserted into the list according to its sorted position. A SystemException occurs if there is insufficient space available to store the new item.

Add(Object, CheckState)

Adds an item to the list of items for a CheckedListBox, specifying the object to add and the initial checked value.

public:
 int Add(System::Object ^ item, System::Windows::Forms::CheckState check);

public int Add (object item, System.Windows.Forms.CheckState check);

override this.Add : obj * System.Windows.Forms.CheckState -> int

Public Function Add (item As Object, check As CheckState) As Integer

Parameters

item

Object

An object representing the item to add to the collection.

check

CheckState

The initial CheckState for the checked portion of the item.

Returns

Int32

The index of the newly added item.

Exceptions

InvalidEnumArgumentException

The check parameter is not one of the valid CheckState values.

Remarks

This method adds an item to the checked list box. For an unsorted checked list box, the item is added to the end of the existing list of items. For a sorted checked list box, the item is inserted into the list according to its sorted position. A SystemException occurs if there is insufficient space available to store the new item.