Class BuildingBlockEntries (Word VBA)

The class BuildingBlockEntries represents a collection of all BuildingBlock objects in a template.

To use a BuildingBlockEntries class variable it first needs to be instantiated, for example

Dim bbes as BuildingBlockEntries
Set bbes = CustomizationContext.BuildingBlockEntries

BuildingBlockEntries class variables can be set using the Template.BuildingBlockEntries procedure.

For Each

Here is an example of processing the BuildingBlockEntries items in a collection.

Dim bbkBuildingBlockEntry As BuildingBlock
For Each bbkBuildingBlockEntry In CustomizationContext.BuildingBlockEntries
	
Next bbkBuildingBlockEntry

Add

Creates a new building block entry in a template and returns a BuildingBlock object that represents the new building block entry.

Add (Name, Type, Category, Range, Description, InsertOptions)

Dim objTemplate As Template 
Dim objBB As BuildingBlock 
 
Set objTemplate = ActiveDocument.AttachedTemplate 
Set objBB = objTemplate.BuildingBlockEntries.Add("Author Name", _ 
 wdTypeCustomTextBox, "Custom", Selection.Range)

Arguments

The following arguments are required:

Name (String) - Specifies the name of the building block entry. Corresponds to the Name property of the BuildingBlock object.

Type (WdBuildingBlockTypes) - Specifies the type of building block to create. Corresponds to the Type property of the BuildingBlock object.


Here you can find possible values for

WdBuildingBlockTypes

Category (String) - Specifies the category of the new building block entry. Corresponds to the Category property of the BuildingBlock object.

Range (Range) - Specifies the value of the buildling block entry. Corresponds to the Value property of the BuildingBlock object.

Optional arguments

The following arguments are optional

Description (String) - Specifies the description of the buildling block entry. Corresponds to the Description property of the BuildingBlock object.

InsertOptions (WdDocPartInsertOptions) - Specifies whether the building block entry is inserted as a page, a paragraph, or inline. If omitted, the default value is wdInsertContent. Corresponds to the InsertOptions property for the BuildingBlock object.

Possible return values are wdInsertContent - Inline building block, wdInsertPage - Page-level building block, wdInsertParagraph - Paragraph-level building block.

Count

Returns the number of items in the BuildingBlockEntries collection.

Dim lngCount As Long
lngCount = CustomizationContext.BuildingBlockEntries.Count

Item

Returns a BuildingBlock object that represents the specified item in the collection.

Item (Index)

Index: Specifies a String or Integer that represents the name or ordinal position of the object in the collection.

Dim bbkBuildingBlockEntry As BuildingBlock
Set bbkBuildingBlockEntry = CustomizationContext.BuildingBlockEntries(Index:=1)