Edit

Word.Interfaces.ListCollectionLoadOptions interface

  • Reference
Package:
word

Contains a collection of Word.List objects.

Remarks

[ API set: WordApi 1.3 ]

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).
id

For EACH ITEM in the collection: Gets the list's id.
levelExistences

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'.

Property Details

$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).

$all?: boolean;

Property Value

boolean

id

For EACH ITEM in the collection: Gets the list's id.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

levelExistences

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'.

levelTypes?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]