通过

BuildingBlockGalleryContentControl 接口

  • 项目

表示用户可插入文档的文档构造块库。

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

语法

声明
<GuidAttribute("d8d887a2-69fe-4a86-a8dd-352003dc0e7e")> _
Public Interface BuildingBlockGalleryContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize

[GuidAttribute("d8d887a2-69fe-4a86-a8dd-352003dc0e7e")]
public interface BuildingBlockGalleryContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

BuildingBlockGalleryContentControl 类型公开以下成员。

属性

  名称 说明
公共属性 Application 获取一个表示 Microsoft Office Word 当前实例的 Microsoft.Office.Interop.Word.Application。
公共属性 BindingContext 获取或设置 IBindableComponent 的货币管理器的集合。 （继承自 IBindableComponent。）
公共属性 BuildingBlockCategory 获取或设置在 BuildingBlockGalleryContentControl 中显示的构造块的类别。
公共属性 BuildingBlockType 获取或设置在 BuildingBlockGalleryContentControl 中显示的生成块的类型。
公共属性 Container 基础结构。 （继承自 ContentControlBase。）
公共属性 ContainerComponent 基础结构。 （继承自 ContentControlBase。）
公共属性 Creator 获取一个 32 位整数，该整数指示已在其中创建 BuildingBlockGalleryContentControl 的应用程序。
公共属性 DataBindings 获取此 IBindableComponent 的数据绑定对象的集合。 （继承自 IBindableComponent。）
公共属性 DefaultDataSourceUpdateMode 获取或设置 ContentControlBase 的默认 DataSourceUpdateMode。 （继承自 ContentControlBase。）
公共属性 DefaultTextStyle 获取用于设置 BuildingBlockGalleryContentControl 中的文本格式的字符样式的名称。
公共属性 ID 获取标识内容控件的唯一编号。 （继承自 ContentControlBase。）
公共属性 InnerObject 获取 Microsoft.Office.Tools.Word.ContentControlBase 的基础 Microsoft.Office.Interop.Word.ContentControl 对象。 （继承自 ContentControlBase。）
公共属性 LockContentControl 获取或设置一个值，该值指定是否可以从文档中删除 BuildingBlockGalleryContentControl。
公共属性 LockContents 获取或设置一个值，该值指定 BuildingBlockGalleryContentControl 的内容是否可以编辑。
公共属性 Parent 获取 BuildingBlockGalleryContentControl 的父级。
公共属性 ParentContentControl 获取嵌套在另一个内容控件中的 BuildingBlockGalleryContentControl 的父内容控件。
公共属性 PlaceholderText 获取或设置在用户操作或某个其他操作更改文本之前在 BuildingBlockGalleryContentControl 中显示的文本。
公共属性 Range 获取一个表示 BuildingBlockGalleryContentControl 的内容的 Range。
公共属性 ShowingPlaceholderText 获取一个值，该值指示 BuildingBlockGalleryContentControl 当前是否显示占位符文本。
公共属性 Site 获取或设置与 IComponent 关联的 ISite。 （继承自 IComponent。）
公共属性 Tag 获取或设置要与 BuildingBlockGalleryContentControl 关联的字符串。
公共属性 Temporary 获取或设置一个值，该值指定在编辑 BuildingBlockGalleryContentControl 时是否自动将该控件从文档中删除。
公共属性 Text 获取或设置 BuildingBlockGalleryContentControl 中的文本。
公共属性 Title 获取或设置 BuildingBlockGalleryContentControl 的标题。

页首

方法

  名称 说明
公共方法 BeginInit 用信号通知对象初始化即将开始。 （继承自 ISupportInitialize。）
公共方法 Copy 将 BuildingBlockGalleryContentControl 从文档复制到剪贴板。
公共方法 Cut 从文档中移除 BuildingBlockGalleryContentControl，然后将其添加到剪贴板中。
公共方法 Delete 从文档中删除动态创建的内容控件，并将其从文档中的 ControlCollection 中移除。 （继承自 ContentControlBase。）
公共方法 Dispose 执行与释放或重置非托管资源相关的应用程序定义的任务。 （继承自 IDisposable。）
公共方法 EndInit 用信号通知对象初始化已完成。 （继承自 ISupportInitialize。）
公共方法 SetPlaceholderText 将 Microsoft.Office.Interop.Word.BuildingBlock、Range 或字符串中的文本显示为 BuildingBlockGalleryContentControl 中的占位符文本。

页首

事件

  名称 说明
公共事件 Added 在内容控件添加到文档后发生。 （继承自 ContentControlBase。）
公共事件 BindingContextChanged 当 ContentControlBase 的 BindingContext 属性的值更改时发生。 （继承自 ContentControlBase。）
公共事件 ContentUpdating 如果内容控件绑定到自定义 XML 部件，则此事件在 Microsoft Office Word 更新内容控件中的文本之前发生。 （继承自 ContentControlBase。）
公共事件 Deleting 在内容控件从文档中删除之前发生。 （继承自 ContentControlBase。）
公共事件 Disposed 表示处理组件的 Disposed 事件的方法。 （继承自 IComponent。）
公共事件 Entering 当用户在内容控件中单击，或者以编程方式将光标移到内容控件中时发生。 （继承自 ContentControlBase。）
公共事件 Exiting 当用户在内容控件外单击，或者以编程方式将光标移出内容控件时发生。 （继承自 ContentControlBase。）
公共事件 StoreUpdating 就在 Microsoft Office Word 更新绑定到内容控件的自定义 XML 部件中的数据之前（即在内容控件中的文本更改之后）发生。 （继承自 ContentControlBase。）
公共事件 Validated 在成功验证内容控件时发生。 （继承自 ContentControlBase。）
公共事件 Validating 在验证内容控件的内容时发生。 （继承自 ContentControlBase。）

页首

备注

BuildingBlockGalleryContentControl 显示用户可插入文档的文档构造块的列表。 文档生成块是创建用来重复使用的一部分内容，例如共用封面页、带格式的表或标题。 若要选择要显示的构造块，请使用 BuildingBlockCategory 和 BuildingBlockType 属性。

有关文档构造块的更多信息，请参见 Word 2007 针对开发人员的新功能。

备注

此接口由 Visual Studio Tools for Office Runtime 实现。不应在代码中实现此接口。有关详细信息，请参阅 Visual Studio Tools for Office Runtime 概述。

内容控件

可用于设计 Microsoft Office Word 中的文档和模板的内容控件类型有八种，BuildingBlockGalleryContentControl 是其中之一。 内容控件具有一个用户界面 (UI)，其中包含类似于窗体的受控输入。 使用内容控件可以防止用户编辑文档或模板的受保护部分，还可以将内容控件绑定到数据源。 有关详细信息，请参阅 内容控件。

用法

本文档介绍面向 .NET Framework 4 和 .NET Framework 4.5 的 Office 项目中所用此类型的版本。在面向 .NET Framework 3.5 的项目中，此类型可能具有不同的成员，因此本文档为此类型提供的代码示例可能并不适用。有关在面向 .NET Framework 3.5 的项目中使用此类型的文档，请参阅 Visual Studio 2008 文档中的以下参考部分：https://go.microsoft.com/fwlink/?LinkId=160658。

示例

下面的代码示例会在文档开头添加一个新的 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;
}

此版本针对的是应用程序级外接程序。 若要使用此代码，请将其粘贴到项目内的 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;
}

请参见

参考

Microsoft.Office.Tools.Word 命名空间

其他资源

内容控件

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

如何：使用内容控件保护文档的某些部分

演练：使用内容控件创建模板