Word.CommentEventArgs interface
Заметка
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен в зависимости от полученных нами отзывов. Не используйте этот API в рабочей среде.
Предоставляет сведения о комментариях, которые вызвали событие примечания.
Замечания
[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]
Примеры
// 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 onChangedHandler(event: Word.CommentEventArgs) {
await Word.run(async (context) => {
console.log(
`${event.type} event detected. ${event.changeType} change made. Event source: ${event.source}. Comment info:`, event.commentDetails
);
});
}
Свойства
| change |
Представляет способ |
| comment |
|
| source | Указывает источник события. Он может быть локальным или удаленным (с помощью совместного редактирования). |
| type | Указывает тип события. Дополнительные сведения см. в этой |
Подробнее
changeType
Заметка
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен в зависимости от полученных нами отзывов. Не используйте этот API в рабочей среде.
Представляет способ commentChanged возникновения события.
changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited";Стоимость недвижимости
Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"
Замечания
commentDetails
Заметка
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен в зависимости от полученных нами отзывов. Не используйте этот API в рабочей среде.
CommentDetail Возвращает массив, содержащий идентификаторы и идентификаторы ответов участвующих комментариев.
commentDetails: Word.CommentDetail[];Стоимость недвижимости
Замечания
source
Заметка
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен в зависимости от полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает источник события. Он может быть локальным или удаленным (с помощью совместного редактирования).
source: Word.EventSource | "Local" | "Remote";Стоимость недвижимости
Word.EventSource | "Local" | "Remote"
Замечания
type
Заметка
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен в зависимости от полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает тип события. Дополнительные сведения см. в этой Word.EventType статье.
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";Стоимость недвижимости
Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"