Word.AnnotationPopupActionEventArgs interface
Represents action information that's passed back on annotation pop-up action event.
TypeScript
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml
// Registers event handlers.
await Word.run(async (context) => {
eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);
eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);
await context.sync();
console.log("Event handlers registered.");
});
...
async function onPopupActionHandler(args: Word.AnnotationPopupActionEventArgs) {
await Word.run(async (context) => {
let message = `AnnotationPopupAction: ID ${args.id} = `;
if (args.action === "Accept") {
message += `Accepted: ${args.critiqueSuggestion}`;
} else {
message += "Rejected";
}
console.log(message);
});
}
action | Specifies the chosen action in the pop-up menu. |
critique |
Specifies the accepted suggestion (only populated when accepting a critique suggestion). |
id | Specifies the annotation ID for which the event was fired. |
Specifies the chosen action in the pop-up menu.
TypeScript
action: string;
Property Value
string
Remarks
Specifies the accepted suggestion (only populated when accepting a critique suggestion).
TypeScript
critiqueSuggestion: string;
Property Value
string
Remarks
Specifies the annotation ID for which the event was fired.
TypeScript
id: string;
Property Value
string
Remarks
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: