Edit

Word.Interfaces.ListLevelLoadOptions interface

  • Reference
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 list level.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
alignment

Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
font

Gets a Font object that represents the character formatting of the specified object.
linkedStyle

Specifies the name of the style that's linked to the specified list level object.
numberFormat

Specifies the number format for the specified list level.
numberPosition

Specifies the position (in points) of the number or bullet for the specified list level object.
numberStyle

Specifies the number style for the list level object.
resetOnHigher

Specifies the list level that must appear before the specified list level restarts numbering at 1.
startAt

Specifies the starting number for the specified list level object.
tabPosition

Specifies the tab position for the specified list level object.
textPosition

Specifies the position (in points) for the second line of wrapping text for the specified list level object.
trailingCharacter

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 LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Specifies the character inserted after the number for the specified list level.

trailingCharacter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]