Word.BuildingBlock class

Returns a BuildingBlockCategory object that represents the category for the building block.

readonly category: Word.BuildingBlockCategory;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Specifies the description for the building block.

description: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns the internal identification number for the building block.

readonly id: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns the position of this building block in a collection.

readonly index: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the name of the building block.

name: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns a BuildingBlockTypeItem object that represents the type for the building block.

readonly type: Word.BuildingBlockTypeItem;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the contents of the building block.

value: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Deletes the building block.

delete(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Returns

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

Returns

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

Returns

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

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.BuildingBlock): void;

Parameters

Returns

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

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;

Returns