Word.Interfaces.ListFormatData interface
An interface describing the data returned by calling listFormat.toJSON().
Properties
| is |
Indicates whether the |
| is |
Indicates whether the |
| list | Returns a |
| list |
Specifies the list level number for the first paragraph for the |
| list |
Gets the string representation of the list value of the first paragraph in the range for the |
| list |
Gets the list template associated with the |
| list |
Gets the type of the list for the |
| list |
Gets the numeric value of the the first paragraph in the range for the |
Property Details
isSingleList
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.
Indicates whether the ListFormat object contains a single list.
isSingleList?: boolean;Property Value
boolean
Remarks
isSingleListTemplate
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.
Indicates whether the ListFormat object contains a single list template.
isSingleListTemplate?: boolean;Property Value
boolean
Remarks
list
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 List object that represents the first formatted list contained in the ListFormat object.
list?: Word.Interfaces.ListData;Property Value
Remarks
listLevelNumber
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 number for the first paragraph for the ListFormat object.
listLevelNumber?: number;Property Value
number
Remarks
listString
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 the string representation of the list value of the first paragraph in the range for the ListFormat object.
listString?: string;Property Value
string
Remarks
listTemplate
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 the list template associated with the ListFormat object.
listTemplate?: Word.Interfaces.ListTemplateData;Property Value
Remarks
listType
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 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
listValue
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 the numeric value of the the first paragraph in the range for the ListFormat object.
listValue?: number;Property Value
number