Word.BuildingBlock class
Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting.
- Extends
Remarks
Properties
| category | Returns a |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| description | Specifies the description for the building block. |
| id | Returns the internal identification number for the building block. |
| index | Returns the position of this building block in a collection. |
| insert |
Specifies a |
| name | Specifies the name of the building block. |
| type | Returns a |
| value | Specifies the contents of the building block. |
Methods
| delete() | Deletes the building block. |
| insert(range, rich |
Inserts the value of the building block into the document and returns a |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
category
Returns a BuildingBlockCategory object that represents the category for the building block.
readonly category: Word.BuildingBlockCategory;Property Value
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
description
Specifies the description for the building block.
description: string;Property Value
string
Remarks
id
Returns the internal identification number for the building block.
readonly id: string;Property Value
string
Remarks
index
Returns the position of this building block in a collection.
readonly index: number;Property Value
number
Remarks
insertType
Specifies a DocPartInsertType value that represents how to insert the contents of the building block into the document.
insertType: Word.DocPartInsertType | "Content" | "Paragraph" | "Page";Property Value
Word.DocPartInsertType | "Content" | "Paragraph" | "Page"
Remarks
name
Specifies the name of the building block.
name: string;Property Value
string
Remarks
type
Returns a BuildingBlockTypeItem object that represents the type for the building block.
readonly type: Word.BuildingBlockTypeItem;Property Value
Remarks
value
Specifies the contents of the building block.
value: string;Property Value
string
Remarks
Method Details
delete()
insert(range, richText)
Inserts the value of the building block into the document and returns a Range object that represents the contents of the building block within the document.
insert(range: Word.Range, richText: boolean): Word.Range;Parameters
- range
- Word.Range
The range where the building block should be inserted.
- richText
-
boolean
Indicates whether to insert as rich text.
Returns
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.BuildingBlockLoadOptions): Word.BuildingBlock;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.BuildingBlock;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.BuildingBlock;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.BuildingBlockUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Word.Interfaces.BuildingBlockUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Word.BuildingBlock): void;Parameters
- properties
- Word.BuildingBlock
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.BuildingBlock object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.BuildingBlockData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.BuildingBlockData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.BuildingBlock;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.BuildingBlock;