Edit

Share via


Word.Interfaces.ListFormatData interface

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

Properties

isSingleList

Indicates whether the ListFormat object contains a single list.

isSingleListTemplate

Indicates whether the ListFormat object contains a single list template.

list

Returns a List object that represents the first formatted list contained in the ListFormat object.

listLevelNumber

Specifies the list level number for the first paragraph for the ListFormat object.

listString

Gets the string representation of the list value of the first paragraph in the range for the ListFormat object.

listTemplate

Gets the list template associated with the ListFormat object.

listType

Gets the type of the list for the ListFormat object.

listValue

Gets the numeric value of the the first paragraph in the range for the ListFormat object.

Property Details

isSingleList

Indicates whether the ListFormat object contains a single list.

isSingleList?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

isSingleListTemplate

Indicates whether the ListFormat object contains a single list template.

isSingleListTemplate?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

list

Returns a List object that represents the first formatted list contained in the ListFormat object.

list?: Word.Interfaces.ListData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

listLevelNumber

Specifies the list level number for the first paragraph for the ListFormat object.

listLevelNumber?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

listString

Gets the string representation of the list value of the first paragraph in the range for the ListFormat object.

listString?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

listTemplate

Gets the list template associated with the ListFormat object.

listTemplate?: Word.Interfaces.ListTemplateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

listType

Gets the type of the list for the ListFormat object.

listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";

Property Value

Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"

Remarks

[ API set: WordApiDesktop 1.3 ]

listValue

Gets the numeric value of the the first paragraph in the range for the ListFormat object.

listValue?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]