Word.CommentEventArgs interface
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Fornece informações sobre os comentários que geraram o evento de comentário.
Comentários
Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)
Usada por
- Word. Corpo: onCommentAdded, onCommentChanged, onCommentDeleted, onCommentDeselected, onCommentSelected
- Word. ContentControl: onCommentAdded, onCommentChanged, onCommentDeselected, onCommentSelected
- Word. Parágrafo: onCommentAdded, onCommentChanged, onCommentDeleted, onCommentDeselected, onCommentSelected
- Word. Intervalo: onCommentAdded, onCommentChanged, onCommentDeselected, onCommentSelected
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/comment-events.yaml
async function onEventHandler(event: Word.CommentEventArgs) {
// Report the event source and the IDs of affected comments and replies.
const remoteSource: Word.EventSource = Word.EventSource.remote;
console.log(`${event.type} event. Source: ${event.source}.`);
if (event.source === remoteSource) {
console.log("A coauthor triggered this event.");
}
event.commentDetails.forEach((comment: Word.CommentDetail) => {
console.log("Affected comment:", { id: comment.id, replyIds: comment.replyIds });
});
}
Propriedades
| change |
Representa como o |
| comment |
Obtém a |
| source | Especifica a origem do evento. Pode ser local ou remoto (por meio de coautoria). |
| type | Especifica o tipo de evento. Consulte |
Detalhes da propriedade
changeType
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Representa como o commentChanged evento é gerado.
changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited";Valor da propriedade
Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"
Comentários
commentDetails
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a CommentDetail matriz que contém as IDs e IDs de resposta dos comentários envolvidos.
commentDetails: Word.CommentDetail[];Valor da propriedade
Comentários
source
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Especifica a origem do evento. Pode ser local ou remoto (por meio de coautoria).
source: Word.EventSource | "Local" | "Remote";Valor da propriedade
Word.EventSource | "Local" | "Remote"
Comentários
type
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Especifica o tipo de evento. Consulte Word.EventType para obter detalhes.
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";Valor da propriedade
Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"