BuildingBlockGalleryContentControl Interface

Definition

Represents a gallery of document building blocks that users can insert into a document.

[System.Runtime.InteropServices.Guid("d8d887a2-69fe-4a86-a8dd-352003dc0e7e")]
public interface BuildingBlockGalleryContentControl : IDisposable, Microsoft.Office.Tools.Word.ContentControlBase, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
Attributes
Implements

Examples

The following code example adds a new BuildingBlockGalleryContentControl to the beginning of the document. The BuildingBlockGalleryContentControl displays equation building blocks that are provided by Microsoft Office Word.

This version is for a document-level customization. To use this code, paste it into the ThisDocument class in your project, and call the AddBuildingBlockControlAtSelection method from the ThisDocument_Startup method.

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

This version is for an application-level add-in. To use this code, paste it into the ThisAddIn class in your project, and call the AddBuildingBlockControlAtSelection method from the ThisAddIn_Startup method.

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

Remarks

A BuildingBlockGalleryContentControl displays a list of document building blocks that users can insert into a document. A document building block is a piece of content that has been created to be used multiple times, such as a common cover page, a formatted table, or a header. To choose the building blocks that you want to display, use the BuildingBlockCategory and BuildingBlockType properties.

For more information about document building blocks, see What's New for Developers in Word 2007.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Content Controls

The BuildingBlockGalleryContentControl is one of eight types of content controls that you can use to design documents and templates in Microsoft Office Word. Content controls have a user interface (UI) that has controlled input like a form. You can use content controls to prevent users from editing protected sections of the document or template, and you can also bind content controls to a data source. For more information, see Content Controls.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Properties

Application

Gets a Application that represents the current instance of Microsoft Office Word.

BuildingBlockCategory

Gets or sets the category of the building blocks that are displayed in the BuildingBlockGalleryContentControl.

BuildingBlockType

Gets or sets the type of the building blocks that are displayed in the BuildingBlockGalleryContentControl.

Container (Inherited from ContentControlBase)
ContainerComponent (Inherited from ContentControlBase)
Creator

Gets a 32-bit integer that indicates the application in which the BuildingBlockGalleryContentControl was created.

DefaultDataSourceUpdateMode

Gets or sets the default DataSourceUpdateMode for the ContentControlBase.

(Inherited from ContentControlBase)
DefaultTextStyle

Gets the name of the character style to use to format text in the BuildingBlockGalleryContentControl.

ID

Gets a unique number that identifies the content control.

(Inherited from ContentControlBase)
InnerObject

Gets the underlying ContentControl object for the ContentControlBase.

(Inherited from ContentControlBase)
LockContentControl

Gets or sets a value that specifies whether the BuildingBlockGalleryContentControl can be deleted from the document.

LockContents

Gets or sets a value that specifies whether the contents of the BuildingBlockGalleryContentControl can be edited.

Parent

Gets the parent of the BuildingBlockGalleryContentControl.

ParentContentControl

Gets the parent content control of a BuildingBlockGalleryContentControl that is nested in another content control.

PlaceholderText

Gets or sets the text that is displayed in the BuildingBlockGalleryContentControl until the text is changed by a user action or some other operation.

Range

Gets a Range that represents the contents of the BuildingBlockGalleryContentControl.

ShowingPlaceholderText

Gets a value that indicates whether the BuildingBlockGalleryContentControl is currently displaying placeholder text.

Tag

Gets or sets a string that you want to associate with the BuildingBlockGalleryContentControl.

Temporary

Gets or sets a value that specifies whether the BuildingBlockGalleryContentControl is automatically deleted from the document when the control is edited.

Text

Gets or sets the text in the BuildingBlockGalleryContentControl.

Title

Gets or sets the title of the BuildingBlockGalleryContentControl.

Methods

Copy()

Copies the BuildingBlockGalleryContentControl from the document to the Clipboard.

Cut()

Removes the BuildingBlockGalleryContentControl from the document and adds it to the Clipboard.

Delete(Boolean)

Deletes a dynamically created content control from the document and removes it from the ControlCollection in the document.

(Inherited from ContentControlBase)
SetPlaceholderText(BuildingBlock, Range, String)

Displays text that is in a BuildingBlock, a Range, or a string as the placeholder text in the BuildingBlockGalleryContentControl.

Events

Added

Occurs after the content control is added to the document.

(Inherited from ContentControlBase)
BindingContextChanged

Occurs when the value of the BindingContext property of the ContentControlBase changes.

(Inherited from ContentControlBase)
ContentUpdating

Occurs just before Microsoft Office Word updates the text in the content control, if the content control is bound to a custom XML part.

(Inherited from ContentControlBase)
Deleting

Occurs just before the content control is deleted from the document.

(Inherited from ContentControlBase)
Entering

Occurs when the user clicks in the content control, or when the cursor is moved into the content control programmatically.

(Inherited from ContentControlBase)
Exiting

Occurs when the user clicks outside the content control, or when the cursor is moved outside the content control programmatically.

(Inherited from ContentControlBase)
StoreUpdating

Occurs just before Microsoft Office Word updates data in a custom XML part that is bound to the content control (that is, after the text in the content control changes).

(Inherited from ContentControlBase)
Validated

Occurs when the content control has been successfully validated.

(Inherited from ContentControlBase)
Validating

Occurs when the contents of the content control are being validated.

(Inherited from ContentControlBase)

Applies to