ControlExtensions.AddLabel-Methode (ControlCollection, Single, Single, Single, Single, String)

Artikel
01/03/2014

Fügt dem Dokument in der angegebenen Größe und an der angegebenen Position ein neues Label-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 AddLabel ( _
    controls As ControlCollection, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As Label

public static Label AddLabel(
    this ControlCollection controls,
    float left,
    float top,
    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.

left
Typ: System.Single
Die Entfernung zwischen dem linken Rand des Steuerelements und dem linken Rand des Dokuments in Punkt.

top
Typ: System.Single
Die Entfernung zwischen dem oberen Rand des Steuerelements und dem oberen Rand des Dokuments in Punkt.

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.Label
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 ist nullein Nullverweis (Nothing in Visual Basic) oder hat die Länge 0 (null).
ControlNameAlreadyExistsException	Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection-Instanz vorhanden.

Hinweise

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

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

Beispiele

Im folgenden Codebeispiel wird am Anfang des Dokuments ein Label-Steuerelement hinzugefügt. Anschließend wird der Text in First Name geändert. Wenn Sie dieses Beispiel verwenden möchten, führen Sie es von der ThisDocument-Klasse in einem Projekt auf Dokumentebene aus.

Private Sub WordAddLabel()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Label1 As Microsoft.Office.Tools.Word.Controls.Label _
        = Me.Controls.AddLabel(0, 0, 75, 17.25F, "Label1")
    Label1.Text = "First Name"
End Sub

private void WordAddLabel()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.Label
        label1 = this.Controls.AddLabel(
        0, 0, 75, 17.25F, "label1");
    label1.Text = "First Name";
}

.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

AddLabel-Überladung

Microsoft.Office.Tools.Word-Namespace

Freigeben über