Edit

Share via

Word.Interfaces.BuildingBlockCategoryLoadOptions interface

Package:
word

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 category of building blocks in a Word document.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

$all

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).
index

Returns the position of the BuildingBlockCategory object in a collection.
name

Returns the name of the BuildingBlockCategory object.
type

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

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

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 the BuildingBlockCategory object in a collection.

index?: boolean;

Property Value

boolean

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.

Returns the name of the BuildingBlockCategory object.

name?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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 of building block for the building block category.

type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions;

Property Value

Word.Interfaces.BuildingBlockTypeItemLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]