Word.CommentEventArgs interface
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Provides information about the comments that raised the comment event.
Remarks
[ API set: WordApi BETA (PREVIEW ONLY) ]
Properties
change |
Represents how the comment changed event is triggered. |
comment |
Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. |
source | The source of the event. It can be local or remote (through coauthoring). |
type | The event type. See Word.EventType for details. |
Property Details
changeType
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Represents how the comment changed event is triggered.
changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited";
Property Value
Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"
Remarks
commentDetails
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments.
commentDetails: Word.CommentDetail[];
Property Value
Remarks
source
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The source of the event. It can be local or remote (through coauthoring).
source: Word.EventSource | "Local" | "Remote";
Property Value
Word.EventSource | "Local" | "Remote"
Remarks
type
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The event type. See Word.EventType for details.
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
Property Value
Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"
Remarks
Office Add-ins
Feedback
https://aka.ms/ContentUserFeedback.
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:Submit and view feedback for