ControlCollection.AddRichTextContentControl 方法 (ContentControl, String)

添加一个基于文档中的本机内容控件的新 RichTextContentControl。

命名空间：  Microsoft.Office.Tools.Word
程序集：  Microsoft.Office.Tools.Word（在 Microsoft.Office.Tools.Word.dll 中）

语法

声明
Function AddRichTextContentControl ( _
    contentControl As ContentControl, _
    name As String _
) As RichTextContentControl

RichTextContentControl AddRichTextContentControl(
    ContentControl contentControl,
    string name
)

参数

• contentControl
  类型：Microsoft.Office.Interop.Word.ContentControl
  作为新控件的基础的 Microsoft.Office.Interop.Word.ContentControl。

• name
  类型：System.String
  新控件的名称。

返回值

类型：Microsoft.Office.Tools.Word.RichTextContentControl
添加到文档的 RichTextContentControl。

异常

异常	条件
ArgumentNullException	contentControl 为 nullnull 引用（在 Visual Basic 中为 Nothing）。 - 或 - name 为 nullnull 引用（在 Visual Basic 中为 Nothing） 或长度为零。
ControlNameAlreadyExistsException	ControlCollection 中已存在一个同名控件。
ArgumentException	contentControl 不是生成块库（即 contentControl 的 Microsoft.Office.Interop.Word.ContentControl.Type 属性不具有 Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText 值）。

备注

使用此方法，可以在运行时添加基于文档中的本机内容控件的新 RichTextContentControl。 如果在运行时创建 RichTextContentControl，并且希望在下次打开文档时重新创建相同的控件，这非常有用。 有关更多信息，请参见 在运行时向 Office 文档添加控件。

示例

下面的代码示例会为文档中的每个本机多格式文本控件创建一个新的 RichTextContentControl。

此版本针对的是文档级自定义项。 若要使用此代码，请将其粘贴到项目内的 ThisDocument 类中，然后从 ThisDocument_Startup 方法中调用 CreateRichTextControlsFromNativeControls 方法。

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

此版本针对的是面向 .NET Framework 4 的应用程序级外接程序。 若要使用此代码，请将其粘贴到项目内的 ThisAddIn 类中，然后从 ThisAddIn_Startup 方法中调用 CreateRichTextControlsFromNativeControls 方法。

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

下面的代码示例会为用户向文档中添加的每个本机多格式文本控件创建一个新的 RichTextContentControl。

此版本针对的是文档级自定义项。 若要使用此代码，请将其粘贴到项目内的 ThisDocument 类中。 对于 C#，还必须将 ThisDocument_RichTextContentControlAfterAdd 事件处理程序附加到 ThisDocument 类的 ContentControlAfterAdd 事件。

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

此版本针对的是面向 .NET Framework 4 的应用程序级外接程序。 若要使用此代码，请将其粘贴到项目内的 ThisAddIn 类中。 此外，还必须将 ActiveDocument_RichTextContentControlAfterAdd 事件处理程序附加到活动文档的 ContentControlAfterAdd 事件。

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

.NET Framework 安全性

• 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息，请参见通过部分受信任的代码使用库。

请参见

参考

ControlCollection 接口

AddRichTextContentControl 重载

Microsoft.Office.Tools.Word 命名空间

其他资源

在运行时向 Office 文档添加控件

宿主控件的帮助器方法

如何：向 Word 文档添加内容控件