AddListBox Method (ControlCollection, Double, Double, Double, Double, String)
Collapse the table of content
Expand the table of content

ControlExtensions.AddListBox Method (ControlCollection, Double, Double, Double, Double, String)


Adds a new ListBox control to the worksheet in the specified size and location.

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

public static ListBox AddListBox(
	this ControlCollection controls,
	double left,
	double top,
	double width,
	double height,
	string name


Type: Microsoft.Office.Tools.Excel.ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Worksheet.Controls property (in an application-level project) or the WorksheetBase.Controls property (in a document-level project), this parameter is supplied automatically.

Type: System.Double

The distance in points between the left edge of the control and the left edge of the worksheet.

Type: System.Double

The distance in points between the top edge of the control and the top edge of the worksheet.

Type: System.Double

The width of the control in points.

Type: System.Double

The height of the control in points.

Type: System.String

The name of the control.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.ListBox

The ListBox control that was added to the ControlCollection instance.

Exception Condition

The name argument is null or has zero length.


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

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

The following code example adds a ListBox control to the top of the worksheet, 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 void ExcelAddListBox()

         listBox1 = this.Controls.AddListBox(
         0, 0, 90, 71.25, "lisBox1");
    listBox1.Items.Add("First Item");
    listBox1.Items.Add("Second Item");
    listBox1.SelectedIndex = 0;
Return to top
© 2016 Microsoft