ControlCollection.AddRichTextContentControl Methode

Referenz

Definition

Namespace:: Microsoft.Office.Tools.Word

Assemblys:: Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Überlädt

AddRichTextContentControl(String)	Fügt bei der aktuellen Auswahl im Dokument ein neues RichTextContentControl hinzu.
AddRichTextContentControl(ContentControl, String)	Fügt ein neues RichTextContentControl hinzu, das auf einem nativen Inhaltssteuerelement im Dokument basiert.
AddRichTextContentControl(Range, String)	Fügt ein neues RichTextContentControl im angegebenen Bereich im Dokument hinzu.

AddRichTextContentControl(String)

Fügt bei der aktuellen Auswahl im Dokument ein neues RichTextContentControl hinzu.

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (string name);

abstract member AddRichTextContentControl : string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (name As String) As RichTextContentControl

Parameter

name: String

Der Name des neuen Steuerelements.

Gibt zurück

RichTextContentControl

Das RichTextContentControl, das dem Dokument hinzugefügt wurde.

Ausnahmen

ArgumentNullException

name ist null oder hat die Länge 0 (null).

ControlNameAlreadyExistsException

Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.

Beispiele

Im folgenden Codebeispiel wird am Anfang des Dokuments ein neues RichTextContentControl hinzugefügt.

Diese Version ist für eine Anpassung auf Dokumentebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und rufen Sie die AddRichTextControlAtSelection -Methode aus der ThisDocument_Startup -Methode auf.

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

private void AddRichTextControlAtSelection()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.Select();

    richTextControl1 = this.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    richTextControl1 = Me.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

Diese Version ist für ein Add-In auf Anwendungsebene vorgesehen, das auf die .NET Framework 4 oder die .NET Framework 4.5 ausgerichtet ist. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und rufen Sie die AddRichTextControlAtSelection -Methode aus der ThisAddIn_Startup -Methode auf.

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

private void AddRichTextControlAtSelection()
{
    if (this.Application.ActiveDocument == null)
        return;

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
    vstoDoc.Paragraphs[1].Range.Select();

    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
    vstoDoc.Paragraphs(1).Range.Select()
    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

Hinweise

Verwenden Sie diese Methode, um zur Laufzeit ein neues RichTextContentControl bei der aktuellen Auswahl im Dokument hinzuzufügen. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.

Gilt für:

AddRichTextContentControl(ContentControl, String)

Fügt ein neues RichTextContentControl hinzu, das auf einem nativen Inhaltssteuerelement im Dokument basiert.

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(Microsoft::Office::Interop::Word::ContentControl ^ contentControl, System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (Microsoft.Office.Interop.Word.ContentControl contentControl, string name);

abstract member AddRichTextContentControl : Microsoft.Office.Interop.Word.ContentControl * string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (contentControl As ContentControl, name As String) As RichTextContentControl

Parameter

contentControl: ContentControl

Das ContentControl, das die Grundlage für das neue Steuerelement ist.

name: String

Der Name des neuen Steuerelements.

Gibt zurück

RichTextContentControl

Das RichTextContentControl, das dem Dokument hinzugefügt wurde.

Ausnahmen

ArgumentNullException

contentControl ist null.-or- name ist null oder hat die Länge null.

ControlNameAlreadyExistsException

Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.

ArgumentException

contentControlist kein Bausteinkatalog (d. h. microsoft.Office.Interop.Word. Die ContentControl.Type-Eigenschaft von contentControl hat nicht den Wert Microsoft.Office.Interop.Word. WdContentControlType.wdContentControlRichText).

Beispiele

Im folgenden Codebeispiel wird ein neues RichTextContentControl für jedes native Rich-Text-Steuerelement erstellt, das sich im Dokument befindet.

Diese Version ist für eine Anpassung auf Dokumentebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und rufen Sie die CreateRichTextControlsFromNativeControls -Methode aus der ThisDocument_Startup -Methode auf.

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.RichTextContentControl> richTextControls;

private void CreateRichTextControlsFromNativeControls()
{
    if (this.ContentControls.Count <= 0)
        return;

    richTextControls = new System.Collections.Generic.List
        <Microsoft.Office.Tools.Word.RichTextContentControl>();
    int count = 0;

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type ==
            Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText)
        {
            count++;
            Microsoft.Office.Tools.Word.RichTextContentControl tempControl =
                this.Controls.AddRichTextContentControl(nativeControl,
                "VSTORichTextControl" + count.ToString());
            richTextControls.Add(tempControl);
        }
    }
}

Private richTextControls As New System.Collections.Generic.List _
        (Of Microsoft.Office.Tools.Word.RichTextContentControl)

Private Sub CreateRichTextControlsFromNativeControls()
    If Me.ContentControls.Count <= 0 Then
        Return
    End If

    Dim count As Integer = 0
    For Each nativeControl As Word.ContentControl In Me.ContentControls
        If nativeControl.Type = Word.WdContentControlType.wdContentControlRichText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.RichTextContentControl = _
                Me.Controls.AddRichTextContentControl(nativeControl, _
                "VSTORichTextContentControl" + count.ToString())
            richTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

Diese Version ist für ein Add-In auf Anwendungsebene vorgesehen, das auf die .NET Framework 4 oder die .NET Framework 4.5 ausgerichtet ist. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und rufen Sie die CreateRichTextControlsFromNativeControls -Methode aus der ThisAddIn_Startup -Methode auf.

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.RichTextContentControl> richTextControls;

private void CreateRichTextControlsFromNativeControls()
{
    if (this.Application.ActiveDocument == null)
        return;

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (vstoDoc.ContentControls.Count <= 0)
        return;

    richTextControls = new System.Collections.Generic.List
        <Microsoft.Office.Tools.Word.RichTextContentControl>();
    int count = 0;
    
    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type ==
            Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText)
        {
            count++;
            Microsoft.Office.Tools.Word.RichTextContentControl tempControl =
                vstoDoc.Controls.AddRichTextContentControl(nativeControl,
                "VSTORichTextControl" + count.ToString());
            richTextControls.Add(tempControl);
        }
    }
}

Private richTextControls As New System.Collections.Generic.List _
        (Of Microsoft.Office.Tools.Word.RichTextContentControl)

Private Sub CreateRichTextControlsFromNativeControls()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    If vstoDoc.ContentControls.Count <= 0 Then
        Return
    End If

    Dim count As Integer = 0
    For Each nativeControl As Word.ContentControl In vstoDoc.ContentControls
        If nativeControl.Type = Word.WdContentControlType.wdContentControlRichText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.RichTextContentControl = _
                vstoDoc.Controls.AddRichTextContentControl(nativeControl, _
                "VSTORichTextContentControl" + count.ToString())
            richTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

Im folgenden Codebeispiel wird ein neues RichTextContentControl für jedes native Rich-Text-Steuerelement erstellt, das der Benutzer dem Dokument hinzufügt.

Diese Version ist für eine Anpassung auf Dokumentebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein. Für C# müssen Sie den ThisDocument_RichTextContentControlAfterAdd Ereignishandler auch an das ContentControlAfterAdd Ereignis der ThisDocument -Klasse anfügen.

void ThisDocument_RichTextContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlRichText)
    {
        this.Controls.AddRichTextContentControl(NewContentControl,
            "RichTextControl" + NewContentControl.ID);
    }
}

Private Sub ThisDocument_RichTextContentControlAfterAdd(ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean) Handles Me.ContentControlAfterAdd

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlRichText Then
        Me.Controls.AddRichTextContentControl(NewContentControl, _
            "RichTextControl" + NewContentControl.ID)
    End If
End Sub

Diese Version ist für ein Add-In auf Anwendungsebene vorgesehen, das auf die .NET Framework 4 oder die .NET Framework 4.5 ausgerichtet ist. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein. Außerdem müssen Sie den ActiveDocument_RichTextContentControlAfterAdd Ereignishandler an das ContentControlAfterAdd Ereignis des aktiven Dokuments anfügen.

void ActiveDocument_RichTextContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlRichText)
    {
        vstoDoc.Controls.AddRichTextContentControl(NewContentControl,
            "RichTextControl" + NewContentControl.ID);
    }
}

Private Sub ActiveDocument_RichTextContentControlAfterAdd( _
    ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean)

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    If NewContentControl.Type = Word.WdContentControlType. _
        wdContentControlRichText Then
        vstoDoc.Controls.AddRichTextContentControl(NewContentControl, _
            "RichTextControl" + NewContentControl.ID)
    End If
End Sub

Hinweise

Verwenden Sie diese Methode, um ein neues RichTextContentControl hinzuzufügen, das auf einem nativen Inhaltssteuerelement im Dokument zur Laufzeit basiert. Dies ist nützlich, wenn Sie ein RichTextContentControl zur Laufzeit erstellen und dasselbe Steuerelement beim nächsten Öffnen des Dokuments neu erstellen möchten. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.

Gilt für:

AddRichTextContentControl(Range, String)

Fügt ein neues RichTextContentControl im angegebenen Bereich im Dokument hinzu.

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(Microsoft::Office::Interop::Word::Range ^ range, System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (Microsoft.Office.Interop.Word.Range range, string name);

abstract member AddRichTextContentControl : Microsoft.Office.Interop.Word.Range * string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (range As Range, name As String) As RichTextContentControl

Parameter

range: Range

Ein Range, der die Grenzen für das neue Steuerelement bereitstellt.

name: String

Der Name des neuen Steuerelements.

Gibt zurück

RichTextContentControl

Das RichTextContentControl, das dem Dokument hinzugefügt wurde.

Ausnahmen

ArgumentNullException

name ist null oder hat die Länge 0 (null).

ControlNameAlreadyExistsException

Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.

Beispiele

Im folgenden Codebeispiel wird am Anfang des Dokuments ein neues RichTextContentControl hinzugefügt.

Diese Version ist für eine Anpassung auf Dokumentebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und rufen Sie die AddRichTextControlAtRange -Methode aus der ThisDocument_Startup -Methode auf.

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl2;

private void AddRichTextControlAtRange()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();

    richTextControl2 = this.Controls.AddRichTextContentControl(this.Paragraphs[1].Range,
        "richTextControl2");
    richTextControl2.PlaceholderText = "Enter your first name";
}

Dim richTextControl2 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtRange()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    richTextControl2 = Me.Controls.AddRichTextContentControl(Me.Paragraphs(1).Range, _
        "richTextControl2")
    richTextControl2.PlaceholderText = "Enter your first name"
End Sub

Diese Version ist für ein Add-In auf Anwendungsebene vorgesehen, das auf die .NET Framework 4 oder die .NET Framework 4.5 ausgerichtet ist. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und rufen Sie die AddRichTextControlAtRange -Methode aus der ThisAddIn_Startup -Methode auf.

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl2;

private void AddRichTextControlAtRange()
{
    if (this.Application.ActiveDocument == null)
        return;

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();

    richTextControl2 = vstoDoc.Controls.AddRichTextContentControl(vstoDoc.Paragraphs[1].Range,
        "richTextControl2");
    richTextControl2.PlaceholderText = "Enter your first name";
}

Dim richTextControl2 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtRange()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
    richTextControl2 = vstoDoc.Controls.AddRichTextContentControl( _
        vstoDoc.Paragraphs(1).Range, _
        "richTextControl2")
    richTextControl2.PlaceholderText = "Enter your first name"
End Sub

Hinweise

Verwenden Sie diese Methode, um zur Laufzeit ein neues RichTextContentControl in einem angegebenen Bereich im Dokument hinzuzufügen. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.

Gilt für:

ControlCollection.AddRichTextContentControl Methode

Definition

Überlädt

AddRichTextContentControl(String)

Parameter

Gibt zurück

Ausnahmen

Beispiele

Hinweise

Gilt für:

AddRichTextContentControl(ContentControl, String)

Parameter

Gibt zurück

Ausnahmen

Beispiele

Hinweise

Gilt für:

AddRichTextContentControl(Range, String)

Parameter

Gibt zurück

Ausnahmen

Beispiele

Hinweise

Gilt für:

Zusätzliche Ressourcen