Word.Interfaces.AnnotationLoadOptions interface

Package:

word

Represents an annotation attached to a paragraph.

Remarks

[ API set: WordApi 1.7 ]

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).
critiqueAnnotation	Gets the critique annotation object.
id	Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
state	Gets the state of the annotation.

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

critiqueAnnotation

Gets the critique annotation object.

critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;

Property Value

Word.Interfaces.CritiqueAnnotationLoadOptions

Remarks

[ API set: WordApi 1.7 ]

id

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

Gets the state of the annotation.

state?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.7 ]