Word.EventSource enum

Remarks

API set: WordApi 1.5

Used by

• Word.CommentEventArgs: source
• Word.ContentControlAddedEventArgs: source
• Word.ContentControlDataChangedEventArgs: source
• Word.ContentControlDeletedEventArgs: source
• Word.ContentControlEnteredEventArgs: source
• Word.ContentControlExitedEventArgs: source
• Word.ContentControlSelectionChangedEventArgs: source
• Word.ParagraphAddedEventArgs: source
• Word.ParagraphChangedEventArgs: source
• Word.ParagraphDeletedEventArgs: source

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-comments.yaml

// Registers event handlers.
await Word.run(async (context) => {
 const body: Word.Body = context.document.body;
 body.track();
 await context.sync();

 eventContexts[0] = body.onCommentAdded.add(onEventHandler);
 eventContexts[1] = body.onCommentChanged.add(onChangedHandler);
 eventContexts[2] = body.onCommentDeleted.add(onEventHandler);
 eventContexts[3] = body.onCommentDeselected.add(onEventHandler);
 eventContexts[4] = body.onCommentSelected.add(onEventHandler);
 await context.sync();

 console.log("Event handlers registered.");
});

...

async function onEventHandler(event: Word.CommentEventArgs) {
 // Handler for all events except onCommentChanged.
 await Word.run(async (context) => {
 console.log(`${event.type} event detected. Event source: ${event.source}. Comment info:`, event.commentDetails);
 });
}

Fields