Freigeben über

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

  • Artikel

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

public static RichTextBox AddRichTextBox(
    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.

Rückgabewert

Typ: Microsoft.Office.Tools.Word.Controls.RichTextBox
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 RichTextBox-Objekte am Ende der ControlCollection hinzufügen.

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

Beispiele

Im folgenden Codebeispiel wird am Anfang des Dokuments ein RichTextBox-Steuerelement hinzugefügt. Anschließend wird dem Steuerelement Text zugewiesen, und der Text wird formatiert.Wenn Sie dieses Beispiel verwenden möchten, führen Sie es von der ThisDocument-Klasse in einem Projekt auf Dokumentebene aus.

Private Sub WordAddRichTextBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim RichTextBox1 As Microsoft.Office.Tools.Word.Controls. _
        RichTextBox = Me.Controls.AddRichTextBox(0, 0, 75, 15, _
        "RichTextBox1")
    RichTextBox1.Text = "Sample text"
    RichTextBox1.Select(0, 6)
    RichTextBox1.SelectionFont = New Font("Times New Roman", _
        10, FontStyle.Bold)
End Sub 

private void WordAddRichTextBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.RichTextBox
         richTextBox1 = this.Controls.AddRichTextBox(
        0, 0, 75, 15, "richTextBox1");
    richTextBox1.Text = "Sample text";
    richTextBox1.Select(0, 6);
    richTextBox1.SelectionFont = new Font("Times New Roman",
        10, FontStyle.Bold);
}

.NET Framework-Sicherheit

Siehe auch

Referenz

ControlExtensions Klasse

AddRichTextBox-Überladung

Microsoft.Office.Tools.Word-Namespace