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 comentario.
Comentarios
[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]
Ejemplos
// 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
);
});
}
Propiedades
| change |
Representa cómo se desencadena el evento de cambio de comentario. |
| comment |
Obtiene la matriz CommentDetail que contiene los identificadores y los identificadores de respuesta de los comentarios implicados. |
| source | Origen del evento. Puede ser local o remota (a través de la coautoría). |
| type | El tipo de evento. Consulte Word. EventType para obtener más información. |
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 desencadena el evento de cambio de comentario.
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 matriz CommentDetail que contiene los identificadores y los 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.
Origen del evento. Puede ser local o remota (a través de la 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.
El tipo de evento. Consulte Word. EventType para obtener más información.
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";Valor de propiedad
Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"