ControlExtensions.AddListBox-Methode (ControlCollection, Range, String)
Fügt dem Arbeitsblatt im angegebenen Bereich ein neues ListBox-Steuerelement hinzu.
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
)
Parameter
- controls
Typ: Microsoft.Office.Tools.Excel.ControlCollection
Die Auflistung, der das Steuerelement hinzugefügt werden soll.Geben Sie diesen Parameter nicht selbst an.Wenn Sie diese Methode für die von der Worksheet.Controls-Eigenschaft (in einem Projekt auf Anwendungsebene) oder von der WorksheetBase.Controls-Eigenschaft (in einem Projekt auf Dokumentebene) zurückgegebene Auflistung aufrufen, wird dieser Parameter automatisch angegeben.
- range
Typ: Microsoft.Office.Interop.Excel.Range
Ein Range, der die Begrenzungen des Steuerelements angibt.
- name
Typ: System.String
Der Name des Steuerelements, der zum Indizieren des Steuerelements in der ControlCollection-Instanz verwendet werden kann.
Rückgabewert
Typ: Microsoft.Office.Tools.Excel.Controls.ListBox
Das ListBox-Steuerelement, das der ControlCollection-Instanz hinzugefügt wurde.
Hinweis zur Verwendung
In Visual Basic und C# können Sie diese Methode als Instanzenmethode für ein beliebiges Objekt vom Typ ControlCollection aufrufen. Bei Verwendung der Syntax für Instanzenmethoden lassen Sie den ersten Parameter aus. Weitere Informationen finden Sie unter Erweiterungsmethoden (Visual Basic) und Erweiterungsmethoden (C#-Programmierhandbuch).
Ausnahmen
| Ausnahme | Bedingung |
|---|---|
| ArgumentNullException | Das Argument für den Namen oder den Bereich ist nullNULL-Verweis (Nothing in Visual Basic), oder das Argument für den Namen hat die Länge 0 (null). |
| ControlNameAlreadyExistsException | Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection-Instanz vorhanden. |
| InvalidRangeException | Der angegebene Bereich ist nicht gültig. Bereiche, die mehrere Bereiche enthalten, können nicht verwendet werden. Der Bereich muss sich auf dem gleichen Arbeitsblatt wie die ControlCollection-Instanz befinden. |
Hinweise
Mithilfe der AddListBox-Methode können Sie ListBox-Objekte am Ende der ControlCollection hinzufügen. Um einen ListBox zu entfernen, der zuvor programmgesteuert hinzugefügt wurde, verwenden Sie die Remove-Methode.
Die Größe des Steuerelements wird automatisch geändert, wenn die Größe des Bereichs geändert wird.
Beispiele
Im folgenden Codebeispiel wird den Zellen A1 bis B6 ein ListBox-Steuerelement hinzugefügt, dem Listenfeld werden zwei Elemente hinzugefügt, und dann wird das erste Element ausgewählt. Wenn Sie dieses Beispiel verwenden möchten, führen Sie es in der Sheet1-Klasse in einem Projekt auf Dokumentebene aus.
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-Sicherheit
- Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.