Edit

Share via

Word.Interfaces.BuildingBlockData interface

Package:
word

An interface describing the data returned by calling buildingBlock.toJSON().

Properties

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

Specifies a DocPartInsertType value that represents how to insert the contents of the building block into the document.
name

Specifies the name of the building block.
value

Specifies the contents of the building block.

Property Details

description

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the description for the building block.

description?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the internal identification number for the building block.

id?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

index

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the position of this building block in a collection.

index?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

insertType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

name

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the name of the building block.

name?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

value

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the contents of the building block.

value?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]