ControlExtensions.AddListBox-Methode (ControlCollection, Range, Single, Single, String)

Artikel
08/10/2011

Fügt dem Dokument in der angegebenen Größe und an der angegebenen Position ein neues ListBox-Steuerelement hinzu.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddListBox ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As ListBox

public static ListBox AddListBox(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parameter

controls
Typ: Microsoft.Office.Tools.Word.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 Document.Controls-Eigenschaft (in einem Projekt auf Anwendungsebene) oder von der DocumentBase.Controls-Eigenschaft (in einem Projekt auf Dokumentebene) zurückgegebene Auflistung aufrufen, wird dieser Parameter automatisch angegeben.

range
Typ: Microsoft.Office.Interop.Word.Range
Der Speicherort des Steuerelements.

width
Typ: System.Single
Die Breite des Steuerelements in Punkt.

height
Typ: System.Single
Die Höhe des Steuerelements in Punkt.

name
Typ: System.String
Der Name, der zum Indizieren des Steuerelements in der ControlCollection-Instanz verwendet werden kann.

Rückgabewert

Typ: Microsoft.Office.Tools.Word.Controls.ListBox
Das Steuerelement, das dem Dokument 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 name-Argument oder das range-Argument ist nullNULL-Verweis (Nothing in Visual Basic), oder das name-Argument 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.

Hinweise

Mithilfe dieser Methode können Sie ListBox-Objekte am Ende der ControlCollection hinzufügen.

Um eine ListBox zu entfernen, die programmgesteuert hinzugefügt wurde, verwenden Sie die Remove-Methode.

Beispiele

Im folgenden Codebeispiel wird im ersten Absatz im Dokument 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 von der ThisDocument-Klasse in einem Projekt auf Dokumentebene aus.

Private Sub WordRangeAddListBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim ListBox1 As Microsoft.Office.Tools.Word.Controls. _
        ListBox = Me.Controls.AddListBox(Me.Paragraphs(1).Range, _
        90, 71.25F, "LisBox1")
    ListBox1.Items.Add("First Item")
    ListBox1.Items.Add("Second Item")
    ListBox1.SelectedIndex = 0
End Sub

private void WordRangeAddListBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.ListBox
         listBox1 = this.Controls.AddListBox(
         this.Paragraphs[1].Range, 90, 71.25F, "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.

Siehe auch

Referenz

ControlExtensions Klasse

AddListBox-Überladung

Microsoft.Office.Tools.Word-Namespace

Freigeben über