Word.CommentEventArgs interface

Paquete:

word

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)

Usada por

• Word. Cuerpo: onCommentAdded, onCommentChanged, onCommentDeleted, onCommentDeselected, onCommentSelected
• Word. ContentControl: onCommentAdded, onCommentChanged, onCommentDeselected, onCommentSelected
• Word. Párrafo: onCommentAdded, onCommentChanged, onCommentDeleted, onCommentDeselected, onCommentSelected
• Word. Intervalo: onCommentAdded, onCommentChanged, onCommentDeselected, onCommentSelected

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

changeType	Representa cómo se genera el commentChanged evento.
commentDetails	Obtiene la CommentDetail matriz que contiene los identificadores y los identificadores de respuesta de los comentarios implicados.
source	Especifica el origen del evento. Puede ser local o remota (a través de la coautoría).
type	Especifica el tipo de evento. Vea Word.EventType para 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 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

Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR)

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 y los identificadores de respuesta de los comentarios implicados.

commentDetails: Word.CommentDetail[];

Valor de propiedad

Word.CommentDetail[]

Comentarios

Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR)

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 remota (a través de la coautoría).

source: Word.EventSource | "Local" | "Remote";

Valor de propiedad

Word.EventSource | "Local" | "Remote"

Comentarios

Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR)

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" | "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"

Comentarios

Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR)