Partager via

Word.CommentEventArgs interface

Colis:
word

Note

Cette API est fournie en avant-première pour les développeurs et peut être modifiée en fonction des commentaires que nous recevons. N’utilisez pas cette API dans un environnement de production.

Fournit des informations sur les commentaires qui ont déclenché l’événement de commentaire.

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Exemples

// 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
    );
  });
}

Propriétés

changeType

Représente la façon dont l’événement commentChanged est déclenché.
commentDetails

Obtient le CommentDetail tableau qui contient les ID et les ID de réponse des commentaires impliqués.
source

Spécifie la source de l’événement. Il peut être local ou distant (via la co-création).
type

Spécifie le type d’événement. Pour plus d’informations, consultez Word.EventType .

Détails de la propriété

changeType

Note

Cette API est fournie en avant-première pour les développeurs et peut être modifiée en fonction des commentaires que nous recevons. N’utilisez pas cette API dans un environnement de production.

Représente la façon dont l’événement commentChanged est déclenché.

changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited";

Valeur de la propriété

Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

commentDetails

Note

Cette API est fournie en avant-première pour les développeurs et peut être modifiée en fonction des commentaires que nous recevons. N’utilisez pas cette API dans un environnement de production.

Obtient le CommentDetail tableau qui contient les ID et les ID de réponse des commentaires impliqués.

commentDetails: Word.CommentDetail[];

Valeur de la propriété

Word.CommentDetail[]

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

source

Note

Cette API est fournie en avant-première pour les développeurs et peut être modifiée en fonction des commentaires que nous recevons. N’utilisez pas cette API dans un environnement de production.

Spécifie la source de l’événement. Il peut être local ou distant (via la co-création).

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

Valeur de la propriété

Word.EventSource | "Local" | "Remote"

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

type

Note

Cette API est fournie en avant-première pour les développeurs et peut être modifiée en fonction des commentaires que nous recevons. N’utilisez pas cette API dans un environnement de production.

Spécifie le type d’événement. Pour plus d’informations, consultez Word.EventType .

type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";

Valeur de la propriété

Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]