Partager via


ControlExtensions.AddListBox Method (ControlCollection, Range, String)

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

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddListBox ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As ListBox
public static ListBox AddListBox(
    this ControlCollection controls,
    Range range,
    string name
)

Parameters

Return Value

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

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ControlCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

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 AddListBox method enables you to add ListBox objects to the end of the ControlCollection. To remove a ListBox 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 ListBox control to cells A1 through B6, adds two items to the list box, and then selects the first item. To use this example, run it from the Sheet1 class in a document-level project.

Private Sub ExcelRangeAddListBox()

        Dim ListBox1 As Microsoft.Office.Tools.Excel. _
            Controls.ListBox = Me.Controls.AddListBox( _
            Me.Range("A1", "B6"), "ListBox1")

        ListBox1.Items.Add("First Item")
        ListBox1.Items.Add("Second Item")
        ListBox1.SelectedIndex = 0

    End Sub
private void ExcelRangeAddListBox()
{

    Microsoft.Office.Tools.Excel.Controls.ListBox
         listBox1 = this.Controls.AddListBox(
         this.Range["A1", "B6"], "lisBox1");
    listBox1.Items.Add("First Item");
    listBox1.Items.Add("Second Item");
    listBox1.SelectedIndex = 0;
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddListBox Overload

Microsoft.Office.Tools.Excel Namespace