Word.Interfaces.BuildingBlockLoadOptions interface
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.
Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting.
Remarks
Properties
| $all | Specifying |
| category | Returns a |
| 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. |
Property Details
$all
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.
Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
$all?: boolean;Property Value
boolean
category
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 a BuildingBlockCategory object that represents the category for the building block.
category?: Word.Interfaces.BuildingBlockCategoryLoadOptions;Property Value
Remarks
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?: boolean;Property Value
boolean
Remarks
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?: boolean;Property Value
boolean
Remarks
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?: boolean;Property Value
boolean
Remarks
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?: boolean;Property Value
boolean
Remarks
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?: boolean;Property Value
boolean
Remarks
type
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 a BuildingBlockTypeItem object that represents the type for the building block.
type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions;Property Value
Remarks
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?: boolean;Property Value
boolean