ControlCollection.AddComboBox Method (, String) (2007 System)

  • Article

Adds a new ComboBox control to the worksheet at the range specified.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v9.0 (in Microsoft.Office.Tools.Excel.v9.0.dll)

Syntax

'Declaration
Public Function AddComboBox ( _
    range As Range, _
    name As String _
) As ComboBox

'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim name As String 
Dim returnValue As ComboBox 

returnValue = instance.AddComboBox(range, _
    name)

public ComboBox AddComboBox(
    Range range,
    string name
)

public:
ComboBox^ AddComboBox(
    Range^ range, 
    String^ name
)

public function AddComboBox(
    range : Range, 
    name : String
) : ComboBox

Parameters

  • range
    Type: Range

    A Range that provides the bounds for the control.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.ComboBox
The ComboBox control that was added to the ControlCollection instance.

Exceptions

Exception Condition
ArgumentNullException

The name or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length.
ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.
InvalidRangeException

The range that was specified is not valid. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddComboBox method enables you to add ComboBox objects to the end of the ControlCollection. To remove a ComboBox that was previously added programmatically, use the Remove method.

The control automatically resizes when the range is resized.

Examples

The following code example adds a ComboBox control to cells A1 through B1, adds two items to the combo box, and then selects the first item.

Private Sub ExcelRangeAddComboBox()

    Dim ComboBox1 As Microsoft.Office.Tools.Excel. _
        Controls.ComboBox = Me.Controls.AddComboBox( _
        Me.Range("A1", "B1"), "ComboBox1")
    ComboBox1.Items.Add("First Item")
    ComboBox1.Items.Add("Second Item")
    ComboBox1.SelectedIndex = 0

End Sub

private void ExcelRangeAddComboBox()
{

    Microsoft.Office.Tools.Excel.Controls.ComboBox
        comboBox1 = this.Controls.AddComboBox(
        this.Range["A1", "B1"], "comboBox1");
    comboBox1.Items.Add("First Item");
    comboBox1.Items.Add("Second Item");
    comboBox1.SelectedIndex = 0;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddComboBox Overload

Microsoft.Office.Tools.Excel Namespace