ControlCollection.AddBuildingBlockGalleryContentControl 方法 (String)

项目
08/12/2011

在文档中当前选定的位置添加一个新的 BuildingBlockGalleryContentControl。

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

语法

声明
Function AddBuildingBlockGalleryContentControl ( _
    name As String _
) As BuildingBlockGalleryContentControl

BuildingBlockGalleryContentControl AddBuildingBlockGalleryContentControl(
    string name
)

参数

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

返回值

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

异常

异常	条件
ArgumentNullException	name 为 nullnull 引用（在 Visual Basic 中为 Nothing）或长度为零。
ControlNameAlreadyExistsException	ControlCollection 中已存在一个同名控件。

备注

使用此方法，可在运行时在文档中当前选定位置添加一个新的 BuildingBlockGalleryContentControl。有关更多信息，请参见在运行时向 Office 文档添加控件。

示例

下面的代码示例会在文档开头添加一个新的 BuildingBlockGalleryContentControl。 BuildingBlockGalleryContentControl 显示由 Microsoft Office Word 提供的方程式生成块。

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

Dim buildingBlockGalleryControl1 As Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl

Private Sub AddBuildingBlockGalleryControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    buildingBlockGalleryControl1 = Me.Controls.AddBuildingBlockGalleryContentControl( _
        "buildingBlockGalleryControl1")
    With buildingBlockGalleryControl1
        .PlaceholderText = "Choose an equation"
        .BuildingBlockCategory = "Built-In"
        .BuildingBlockType = Word.WdBuildingBlockTypes.wdTypeEquations
    End With
End Sub

private Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl buildingBlockControl1;

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

    buildingBlockControl1 = this.Controls.AddBuildingBlockGalleryContentControl(
        "buildingBlockControl1");
    buildingBlockControl1.PlaceholderText = "Choose an equation";
    buildingBlockControl1.BuildingBlockCategory = "Built-In";
    buildingBlockControl1.BuildingBlockType = Word.WdBuildingBlockTypes.wdTypeEquations;
}

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

Dim buildingBlockGalleryControl1 As BuildingBlockGalleryContentControl

Private Sub AddBuildingBlockGalleryControlAtSelection()
    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()
    buildingBlockGalleryControl1 = vstoDoc.Controls.AddBuildingBlockGalleryContentControl( _
        "buildingBlockGalleryControl1")
    With buildingBlockGalleryControl1
        .PlaceholderText = "Choose an equation"
        .BuildingBlockCategory = "Built-In"
        .BuildingBlockType = Word.WdBuildingBlockTypes.wdTypeEquations
    End With
End Sub

private Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl buildingBlockControl1;

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

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

    buildingBlockControl1 = vstoDoc.Controls.AddBuildingBlockGalleryContentControl(
        "buildingBlockControl1");
    buildingBlockControl1.PlaceholderText = "Choose an equation";
    buildingBlockControl1.BuildingBlockCategory = "Built-In";
    buildingBlockControl1.BuildingBlockType = Word.WdBuildingBlockTypes.wdTypeEquations;
}