Edit

Share via

Word.Interfaces.AnnotationCollectionLoadOptions interface

  • Reference
Package:
word

Contains a collection of Word.Annotation objects.

Remarks

[ API set: WordApi 1.7 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
critiqueAnnotation

For EACH ITEM in the collection: Gets the critique annotation object.
id

For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
state

For EACH ITEM in the collection: Gets the state of the annotation.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

critiqueAnnotation

For EACH ITEM in the collection: Gets the critique annotation object.

critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;

Property Value

Word.Interfaces.CritiqueAnnotationLoadOptions

Remarks

[ API set: WordApi 1.7 ]

id

For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.7 ]

state

For EACH ITEM in the collection: Gets the state of the annotation.

state?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.7 ]