Word.CommentEventArgs interface
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Proporciona información sobre los comentarios que generaron el evento de comentarios.
Comentarios
Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR)
Usada por
- Word. Body: onCommentAdded, onCommentChanged, onCommentDeleted, onCommentDeselected, onCommentSelected
- Word. Control de contenido: onCommentAdded, onCommentChanged, onCommentDeselected, onCommentSelected
- Word. Párrafo: onCommentAdded, onCommentChanged, onCommentDeleted, onCommentDeselected, onCommentSelected
- Word. Rango: onCommentAdded, onCommentChanged, onCommentDeselected, onCommentSelected
Ejemplos
// 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 });
});
}
Propiedades
| change |
Representa cómo se genera el |
| comment |
Obtiene la |
| source | Especifica el origen del evento. Puede ser local o remoto (mediante coautoría). |
| type | Especifica el tipo de evento. Vea |
Detalles de las propiedades
changeType
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Representa cómo se genera el commentChanged evento.
changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited";Valor de propiedad
Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"
Comentarios
commentDetails
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Obtiene la CommentDetail matriz que contiene los identificadores e identificadores de respuesta de los comentarios implicados.
commentDetails: Word.CommentDetail[];Valor de propiedad
Comentarios
source
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Especifica el origen del evento. Puede ser local o remoto (mediante coautoría).
source: Word.EventSource | "Local" | "Remote";Valor de propiedad
Word.EventSource | "Local" | "Remote"
Comentarios
type
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Especifica el tipo de evento. Vea Word.EventType para más información.
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 de propiedad
Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"