Word.Interfaces.ListLevelCollectionLoadOptions 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.

Contains a collection of Word.ListLevel objects.

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).
alignment	For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
font	For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object.
linkedStyle	For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object.
numberFormat	For EACH ITEM in the collection: Specifies the number format for the specified list level.
numberPosition	For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object.
numberStyle	For EACH ITEM in the collection: Specifies the number style for the list level object.
resetOnHigher	For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1.
startAt	For EACH ITEM in the collection: Specifies the starting number for the specified list level object.
tabPosition	For EACH ITEM in the collection: Specifies the tab position for the specified list level object.
textPosition	For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object.
trailingCharacter	For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level.

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

alignment

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.

For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.

alignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

font

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.

For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object.

font?: Word.Interfaces.FontLoadOptions;

Property Value

Word.Interfaces.FontLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

linkedStyle

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.

For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object.

linkedStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

numberFormat

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.

For EACH ITEM in the collection: Specifies the number format for the specified list level.

numberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

numberPosition

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.

For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object.

numberPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

numberStyle

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.

For EACH ITEM in the collection: Specifies the number style for the list level object.

numberStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

resetOnHigher

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.

For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1.

resetOnHigher?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

startAt

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.

For EACH ITEM in the collection: Specifies the starting number for the specified list level object.

startAt?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

tabPosition

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.

For EACH ITEM in the collection: Specifies the tab position for the specified list level object.

tabPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textPosition

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.

For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object.

textPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

trailingCharacter

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.

For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level.

trailingCharacter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]