Word.Interfaces.ListData interface

Package:

word

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

Properties

id	Gets the list's id.
levelExistences	Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level.
levelTypes	Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'.
paragraphs	Gets paragraphs in the list. Read-only.

Property Details

id

Gets the list's id.

id?: number;

Property Value

number

Remarks

[ API set: WordApi 1.3 ]

levelExistences

Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level.

levelExistences?: boolean[];

Property Value

boolean[]

Remarks

[ API set: WordApi 1.3 ]

levelTypes

Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'.

levelTypes?: Word.ListLevelType[];

Property Value

Word.ListLevelType[]

Remarks

[ API set: WordApi 1.3 ]

paragraphs

Gets paragraphs in the list. Read-only.

paragraphs?: Word.Interfaces.ParagraphData[];

Property Value

Word.Interfaces.ParagraphData[]

Remarks

[ API set: WordApi 1.3 ]