ControlCollection.AddBuildingBlockGalleryContentControl 方法 (ContentControl, String)

项目
05/20/2013

将新 BuildingBlockGalleryContentControl 添加到集合中。新控件基于文件中已有的本机内容控件。

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

语法

声明
Function AddBuildingBlockGalleryContentControl ( _
    contentControl As ContentControl, _
    name As String _
) As BuildingBlockGalleryContentControl

BuildingBlockGalleryContentControl AddBuildingBlockGalleryContentControl(
    ContentControl contentControl,
    string name
)

参数

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

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

返回值

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

异常

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

ArgumentNullException

contentControl 为 nullnull 引用（在 Visual Basic 中为 Nothing）。

- 或 -

name 为 nullnull 引用（在 Visual Basic 中为 Nothing）或长度为零。

ControlNameAlreadyExistsException

ControlCollection 中已存在一个同名控件。

ArgumentException

contentControl 不是生成块库（即 contentControl 的 Type 属性不具有 Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlBuildingBlockGallery 值）。

备注

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

示例

下面的代码示例会为文档中已有的每个本机构造块库创建一个新的 BuildingBlockGalleryContentControl。

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

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

Private Sub CreateBuildingBlockGalleryControlsFromNativeControls()
    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.wdContentControlBuildingBlockGallery Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl = _
                Me.Controls.AddBuildingBlockGalleryContentControl(nativeControl, _
                "VSTOBuildingBlockGalleryContentControl" + count.ToString())
            buildingBlockControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

private System.Collections.Generic.List
   <Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl> buildingBlockControls;

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

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

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlBuildingBlockGallery)
        {
            count++;
            Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl tempControl =
                this.Controls.AddBuildingBlockGalleryContentControl(nativeControl,
                "VSTOBuildingBlockContentControl" + count.ToString());
            buildingBlockControls.Add(tempControl);
        }
    }
}

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

Private buildingBlockControls As New System.Collections.Generic.List _
        (Of BuildingBlockGalleryContentControl)

Private Sub CreateBuildingBlockGalleryControlsFromNativeControls()
    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.wdContentControlBuildingBlockGallery Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl = _
                vstoDoc.Controls.AddBuildingBlockGalleryContentControl(nativeControl, _
                "VSTOBuildingBlockGalleryContentControl" + count.ToString())
            buildingBlockControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

private System.Collections.Generic.List
   <Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl> buildingBlockControls;

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

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (vstoDoc.ContentControls.Count <= 0)
    {
        System.Windows.Forms.MessageBox.Show("No content controls found in document.");                    
        return;
    }

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

    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlBuildingBlockGallery)
        {
            count++;
            Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl tempControl =
                vstoDoc.Controls.AddBuildingBlockGalleryContentControl(nativeControl,
                "VSTOBuildingBlockContentControl" + count.ToString());
            buildingBlockControls.Add(tempControl);
        }
    }
}

下面的代码示例会为用户向文档中添加的每个本机构造块库创建一个新的 BuildingBlockGalleryContentControl。

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

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

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlBuildingBlockGallery Then
        Me.Controls.AddBuildingBlockGalleryContentControl(NewContentControl, _
            "BuildingBlockControl" + NewContentControl.ID)
    End If
End Sub

void ThisDocument_BuildingBlockContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlBuildingBlockGallery)
    {
        this.Controls.AddBuildingBlockGalleryContentControl(NewContentControl,
            "BuildingBlockControl" + NewContentControl.ID);
    }
}

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

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

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

void ActiveDocument_BuildingBlockContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlBuildingBlockGallery)
    {
        vstoDoc.Controls.AddBuildingBlockGalleryContentControl(NewContentControl,
            "BuildingBlockControl" + NewContentControl.ID);
    }
}