Word.Interfaces.BuildingBlockData interface

Package:

word

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

Remarks

Used by

• Word.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

Specifies the description for the building block.

description?: string;

Property Value

string

Remarks

API set: WordApiDesktop 1.3

id

Returns the internal identification number for the building block.

id?: string;

Property Value

string

Remarks

API set: WordApiDesktop 1.3

index

Returns the position of this building block in a collection.

index?: number;

Property Value

number

Remarks

API set: WordApiDesktop 1.3

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

API set: WordApiDesktop 1.3

name

Specifies the name of the building block.

name?: string;

Property Value

string

Remarks

API set: WordApiDesktop 1.3

value

Specifies the contents of the building block.

value?: string;

Property Value

string

Remarks

API set: WordApiDesktop 1.3