ControlExtensions.AddListBox Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| AddListBox(ControlCollection, Range, String) |
Adds a new ListBox control to the worksheet at the range specified. |
| AddListBox(ControlCollection, Double, Double, Double, Double, String) |
Adds a new ListBox control to the worksheet in the specified size and location. |
AddListBox(ControlCollection, Range, String)
Adds a new ListBox control to the worksheet at the range specified.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Office::Tools::Excel::Controls::ListBox ^ AddListBox(Microsoft::Office::Tools::Excel::ControlCollection ^ controls, Microsoft::Office::Interop::Excel::Range ^ range, System::String ^ name);public static Microsoft.Office.Tools.Excel.Controls.ListBox AddListBox (this Microsoft.Office.Tools.Excel.ControlCollection controls, Microsoft.Office.Interop.Excel.Range range, string name);static member AddListBox : Microsoft.Office.Tools.Excel.ControlCollection * Microsoft.Office.Interop.Excel.Range * string -> Microsoft.Office.Tools.Excel.Controls.ListBox<Extension()>
Public Function AddListBox (controls As ControlCollection, range As Range, name As String) As ListBoxParameters
- controls
- 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 Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.
- name
- String
The name of the control that can be used to index the control in the ControlCollection instance.
Returns
The ListBox control that was added to the ControlCollection instance.
Exceptions
The name or range argument is null, or the name argument has zero length.
A control with the same name is already in the ControlCollection instance.
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.
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 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;
}
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
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.
Applies to
AddListBox(ControlCollection, Double, Double, Double, Double, String)
Adds a new ListBox control to the worksheet in the specified size and location.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Office::Tools::Excel::Controls::ListBox ^ AddListBox(Microsoft::Office::Tools::Excel::ControlCollection ^ controls, double left, double top, double width, double height, System::String ^ name);public static Microsoft.Office.Tools.Excel.Controls.ListBox AddListBox (this Microsoft.Office.Tools.Excel.ControlCollection controls, double left, double top, double width, double height, string name);static member AddListBox : Microsoft.Office.Tools.Excel.ControlCollection * double * double * double * double * string -> Microsoft.Office.Tools.Excel.Controls.ListBox<Extension()>
Public Function AddListBox (controls As ControlCollection, left As Double, top As Double, width As Double, height As Double, name As String) As ListBoxParameters
- controls
- 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 Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.
- left
- Double
The distance in points between the left edge of the control and the left edge of the worksheet.
- top
- Double
The distance in points between the top edge of the control and the top edge of the worksheet.
- width
- Double
The width of the control in points.
- height
- Double
The height of the control in points.
- name
- String
The name of the control.
Returns
The ListBox control that was added to the ControlCollection instance.
Exceptions
The name argument is null or has zero length.
A control with the same name is already in the ControlCollection instance.
Examples
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()
{
Microsoft.Office.Tools.Excel.Controls.ListBox
listBox1 = this.Controls.AddListBox(
0, 0, 90, 71.25, "lisBox1");
listBox1.Items.Add("First Item");
listBox1.Items.Add("Second Item");
listBox1.SelectedIndex = 0;
}
Private Sub ExcelAddListBox()
Dim ListBox1 As Microsoft.Office.Tools.Excel. _
Controls.ListBox = Me.Controls.AddListBox( _
0, 0, 90, 71.25, "ListBox1")
ListBox1.Items.Add("First Item")
ListBox1.Items.Add("Second Item")
ListBox1.SelectedIndex = 0
End Sub
Remarks
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.