AddRange Method
Collapse the table of content
Expand the table of content

ComboBox.ObjectCollection.AddRange Method

Adds an array of items to the list of items for a ComboBox.

[Visual Basic]
Public Sub AddRange( _
   ByVal items() As Object _
)
[C#]
public void AddRange(
 object[] items
);
[C++]
public: void AddRange(
 Object* items __gc[]
);
[JScript]
public function AddRange(
   items : Object[]
);

Parameters

items
An array of objects to add to the list.

Exceptions

Exception Type Condition
ArgumentNullException An item in the items parameter was a null reference (Nothing in Visual Basic).

Remarks

If the Sorted property of the ComboBox is set to true, the items are inserted into the list alphabetically. Otherwise, the items are inserted in the order they occur within the array. This method is typically passed an array of String objects, but an array of any type of object can be passed to this method. When an object is added to the collection, the method calls the object's ToString method to obtain the string to display in the list. When using this method to add items to the collection, you do not need to call the BeginUpdate and EndUpdate methods to optimize performance.

Example

The following code example demonstrates how to initialize a ComboBox control by setting the MaxDropDownItems and DropDownStyle properties and using the AddRange method to populate the ComboBox. It also shows handling the SelectedIndexChanged event. To run the example, paste the following code in a form that contains a TextBox named TextBox1 and call the InitializeComboBox method from the form's constructor or Load method.

[SampleID='System.Windows.Forms.ComboBoxFindString' SnippetID='1,2']
--------- Languages displayed= cs, vb ---------
--------- cs ---------
--------- Snippet 1 ---------
    // Declare comboBox1 as a ComboBox.
    internal System.Windows.Forms.ComboBox ComboBox1;
    
    // This method initializes the combo box, adding a large string array
    // but limiting the drop-down size to six rows so the combo box doesn't 
    // cover other controls when it expands.
    private void InitializeComboBox()
    {
        this.ComboBox1 = new System.Windows.Forms.ComboBox();
        string[] employees = new string[]{"Hamilton, David", "Hensien, Kari",
                "Hammond, Maria", "Harris, Keith", "Henshaw, Jeff D.", 
                "Hanson, Mark", "Harnpadoungsataya, Sariya", 
                "Harrington, Mark", "Harris, Keith", "Hartwig, Doris", 
                "Harui, Roger", "Hassall, Mark", "Hasselberg, Jonas", 
                "Harnpadoungsataya, Sariya", "Henshaw, Jeff D.", 
                "Henshaw, Jeff D.", "Hensien, Kari", "Harris, Keith", 
                "Henshaw, Jeff D.", "Hensien, Kari", "Hasselberg, Jonas",
                "Harrington, Mark", "Hedlund, Magnus", "Hay, Jeff", 
                "Heidepriem, Brandon D."};
        ComboBox1.Items.AddRange(employees);
        this.ComboBox1.Location = new System.Drawing.Point(136, 32);
        this.ComboBox1.MaxDropDownItems = 5;
        this.ComboBox1.DropDownStyle = ComboBoxStyle.DropDownList;
        this.ComboBox1.Name = "ComboBox1";
        this.ComboBox1.Size = new System.Drawing.Size(136, 81);
        this.ComboBox1.TabIndex = 0;
        this.Controls.Add(this.ComboBox1);
        
        // Associate the event-handling method with the 
        // SelectedIndexChanged event.
        this.ComboBox1.SelectedIndexChanged += 
            new System.EventHandler(ComboBox1_SelectedIndexChanged);
    }
--------- Snippet 2 ---------
    // This method is called when the user changes his or her selection.
    // It searches for all occurrences of the selected employee's
    // name in the Items array and adds the employee's name and 
    // the number of occurrences to TextBox1.Text.
    // CAUTION   This code exposes a known bug: If the index passed to the 
    // FindStringExact(searchString, index) method is the last index 
    // of the array, the code throws an exception.
    private void ComboBox1_SelectedIndexChanged(object sender, 
        System.EventArgs e)
    {
        ComboBox comboBox = (ComboBox) sender;
        // Save the selected employee's name, because we will remove
        // the employee's name from the list.
        string selectedEmployee = (string) ComboBox1.SelectedItem;
        int count = 0;
        int resultIndex = -1;
        // Call the FindStringExact method to find the first 
        // occurrence in the list.
        resultIndex = ComboBox1.FindStringExact(selectedEmployee);
        // Remove the name as it is found, and increment the found count. 
        // Then call the FindStringExact method again, passing in the 
        // index of the current found item so the search starts there 
        // instead of at the beginning of the list.
        while (resultIndex!=-1)
        {
            ComboBox1.Items.RemoveAt(resultIndex);
            count += 1;
            resultIndex = ComboBox1.FindStringExact(selectedEmployee, 
                resultIndex);
        }
        // Update the text in Textbox1.
        TextBox1.Text = TextBox1.Text+ "\r\n" + selectedEmployee + ": "
            + count;
    }
--------- vb ---------
--------- Snippet 1 ---------
    ' Declare comboBox1 as a ComboBox.
    Friend WithEvents ComboBox1 As System.Windows.Forms.ComboBox
    ' This method initializes the combo box, adding a large string 
    ' array but limiting the drop-down size to six rows so the combo box
    ' doesn't cover other controls when it expands.
    Private Sub InitializeComboBox()
        Me.ComboBox1 = New System.Windows.Forms.ComboBox
        Dim employees() As String = New String() {"Hamilton, David", _
            "Hensien, Kari", "Hammond, Maria", "Harris, Keith", _
            "Henshaw, Jeff D.", "Hanson, Mark", "Harnpadoungsataya, Sariya", _
            "Harrington, Mark", "Harris, Keith", "Hartwig, Doris", _
            "Harui, Roger", "Hassall, Mark", "Hasselberg, Jonas", _
            "Harnpadoungsataya, Sariya", "Henshaw, Jeff D.", "Henshaw, Jeff D.", _
            "Hensien, Kari", "Harris, Keith", "Henshaw, Jeff D.", _
            "Hensien, Kari", "Hasselberg, Jonas", "Harrington, Mark", _
            "Hedlund, Magnus", "Hay, Jeff", "Heidepriem, Brandon D."}
        ComboBox1.Items.AddRange(employees)
        Me.ComboBox1.Location = New System.Drawing.Point(136, 32)
        Me.ComboBox1.MaxDropDownItems = 5
        Me.ComboBox1.DropDownStyle = ComboBoxStyle.DropDown
        Me.ComboBox1.Name = "ComboBox1"
        Me.ComboBox1.Size = New System.Drawing.Size(136, 81)
        Me.ComboBox1.TabIndex = 0
        Me.Controls.Add(Me.ComboBox1)
    End Sub
--------- Snippet 2 ---------
    ' This method is called when the user changes his or her selection.
    ' It searches for all occurrences of the selected employee's
    ' name in the Items array and adds the employee's name and 
    ' the number of occurrences to TextBox1.Text.
    ' CAUTION   This code exposes a known bug: If the index passed to the 
    ' FindStringExact(searchString, index) method is the last index 
    ' of the array, the code throws an exception.
    Private Sub ComboBox1_SelectedIndexChanged(ByVal sender As Object, _
        ByVal e As System.EventArgs) Handles ComboBox1.SelectedIndexChanged
        Dim comboBox As comboBox = CType(sender, comboBox)
        ' Save the selected employee's name, because we will remove
        ' the employee's name from the list.
        Dim selectedEmployee = CType(ComboBox1.SelectedItem, String)
        Dim count As Integer = 0
        Dim resultIndex As Integer = -1
        ' Call the FindStringExact method to find the first 
        ' occurrence in the list.
        resultIndex = ComboBox1.FindStringExact(ComboBox1.SelectedItem)
        ' Remove the name as it is found, and increment the found count. 
        ' Then call the FindStringExact method again, passing in the index of the
        ' current found item so the search starts there instead of 
        ' at the beginning of the list.
        While (resultIndex <> -1)
            ComboBox1.Items.RemoveAt(resultIndex)
            count += 1
            resultIndex = ComboBox1.FindStringExact _
            (selectedEmployee, resultIndex)
        End While
        ' Update the text in Textbox1.
        TextBox1.Text = TextBox1.Text & Microsoft.VisualBasic.vbCrLf _
            & selectedEmployee & ": " & count
      End Sub

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

ComboBox.ObjectCollection Class | ComboBox.ObjectCollection Members | System.Windows.Forms Namespace

Show:
© 2016 Microsoft