Sdílet prostřednictvím

ControlCollection.AddRichTextContentControl – metoda (ContentControl, String)

  • Článek

Přidá nový RichTextContentControl základě nativní řízení obsahu v dokumentu.

Obor názvů:  Microsoft.Office.Tools.Word
Sestavení:  Microsoft.Office.Tools.Word (v Microsoft.Office.Tools.Word.dll)

Syntaxe

'Deklarace
Function AddRichTextContentControl ( _
    contentControl As ContentControl, _
    name As String _
) As RichTextContentControl

RichTextContentControl AddRichTextContentControl(
    ContentControl contentControl,
    string name
)

Parametry

Vrácená hodnota

Typ: Microsoft.Office.Tools.Word.RichTextContentControl
RichTextContentControl , Byl přidán do dokumentu.

Výjimky

Výjimka Podmínka
ArgumentNullException

contentControlis nullodkaz Null (Nothing v jazyce Visual Basic).

-nebo-

nameje nullodkaz Null (Nothing v jazyce Visual Basic) nebo má nulovou délku.
ControlNameAlreadyExistsException

Ovládací prvek se stejným názvem je již v ControlCollection.
ArgumentException

contentControlGalerie stavebních bloků není (tedy Microsoft.Office.Interop.Word.ContentControl.Type Vlastnost contentControl nemá hodnotu Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText).

Poznámky

Tuto metodu lze použít k přidání nového RichTextContentControl základě nativní řízení obsahu dokumentu v čase zpracování. To je užitečné při vytváření RichTextContentControl v době běhu a chcete při příštím otevření dokumentu znovu tentýž ovládací. Další informace naleznete v tématu Adding Controls to Office Documents at Run Time.

Příklady

Následující příklad kódu vytvoří nový RichTextContentControl pro každého nativní RTF ovládacího prvku v dokumentu.

Tato verze je přizpůsobení úrovni dokumentu. Tento kód použít, vložte ji do ThisDocument třídy v projektu a volání CreateRichTextControlsFromNativeControls Metoda z ThisDocument_Startup metody.

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

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);
        }
    }
}

Tato verze je aplikace-úroveň doplněk , který zaměřuje .NET Framework 4. Tento kód použít, vložte ji do ThisAddIn třídy v projektu a volání CreateRichTextControlsFromNativeControls Metoda z ThisAddIn_Startup metody.

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

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);
        }
    }
}

Následující příklad kódu vytvoří nový RichTextContentControl pro každý nativní ovládací prvek RTF, který uživatel přidá do dokumentu.

Tato verze je přizpůsobení úrovni dokumentu. Chcete-li použít tento kód, vložte ji do ThisDocument třídy v projektu. Pro C# musí také připojit ThisDocument_RichTextContentControlAfterAdd Obslužná rutina události ContentControlAfterAdd události ThisDocument Třída

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

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

Tato verze je aplikace-úroveň doplněk , který zaměřuje .NET Framework 4. Chcete-li použít tento kód, vložte ji do ThisAddIn třídy v projektu. Také je nutné připojit ActiveDocument_RichTextContentControlAfterAdd Obslužná rutina události ContentControlAfterAdd událostí aktivního dokumentu.

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

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);
    }
}

Zabezpečení rozhraní .NET Framework

Viz také

Odkaz

ControlCollection Rozhraní

AddRichTextContentControl – přetížení

Microsoft.Office.Tools.Word – obor názvů

Další zdroje

Adding Controls to Office Documents at Run Time

Helper Methods for Host Controls

How to: Add Content Controls to Word Documents