Word.Annotation class
Represents an annotation attached to a paragraph.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| critique |
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. |
Methods
| delete() | Deletes the annotation. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
critiqueAnnotation
Gets the critique annotation object.
readonly critiqueAnnotation: Word.CritiqueAnnotation;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml
// Gets annotations found in the selected paragraph.
await Word.run(async (context) => {
const paragraph = context.document.getSelection().paragraphs.getFirst();
const annotations = paragraph.getAnnotations();
annotations.load("id,state,critiqueAnnotation");
await context.sync();
console.log("Annotations found:");
for (var i = 0; i < annotations.items.length; i++) {
const annotation = annotations.items[i];
console.log(`${annotation.id} - ${annotation.state} - ${JSON.stringify(annotation.critiqueAnnotation.critique)}`);
}
});
id
Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
readonly id: string;Property Value
string
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml
// Accepts the first annotation found in the selected paragraph.
await Word.run(async (context) => {
const paragraph = context.document.getSelection().paragraphs.getFirst();
const annotations = paragraph.getAnnotations();
annotations.load("id,state,critiqueAnnotation");
await context.sync();
for (var i = 0; i < annotations.items.length; i++) {
const annotation = annotations.items[i];
if (annotation.state === Word.AnnotationState.created) {
console.log(`Accepting ${annotation.id}`);
annotation.critiqueAnnotation.accept();
await context.sync();
break;
}
}
});
state
Gets the state of the annotation.
readonly state: Word.AnnotationState | "Created" | "Accepted" | "Rejected";Property Value
Word.AnnotationState | "Created" | "Accepted" | "Rejected"
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml
// Rejects the last annotation found in the selected paragraph.
await Word.run(async (context) => {
const paragraph = context.document.getSelection().paragraphs.getFirst();
const annotations = paragraph.getAnnotations();
annotations.load("id,state,critiqueAnnotation");
await context.sync();
for (var i = annotations.items.length - 1; i >= 0; i--) {
const annotation = annotations.items[i];
if (annotation.state === Word.AnnotationState.created) {
console.log(`Rejecting ${annotation.id}`);
annotation.critiqueAnnotation.reject();
await context.sync();
break;
}
}
});
Method Details
delete()
Deletes the annotation.
delete(): void;Returns
void
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml
// Deletes all annotations found in the selected paragraph.
await Word.run(async (context) => {
const paragraph = context.document.getSelection().paragraphs.getFirst();
const annotations = paragraph.getAnnotations();
annotations.load("id");
await context.sync();
const ids = [];
for (var i = 0; i < annotations.items.length; i++) {
const annotation = annotations.items[i];
ids.push(annotation.id);
annotation.delete();
}
await context.sync();
console.log("Annotations deleted:", ids);
});
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.AnnotationLoadOptions): Word.Annotation;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.Annotation;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Annotation;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.Annotation object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.AnnotationData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.AnnotationData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.Annotation;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.Annotation;Returns
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for