Word.CommentEventArgs interface

Paket:

word

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt Informationen zu den Kommentaren bereit, die das Kommentarereignis ausgelöst haben.

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

Beispiele

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

Eigenschaften

changeType	Stellt dar, wie das Kommentaränderungsereignis ausgelöst wird.
commentDetails	Ruft das CommentDetail-Array ab, das die IDs und Antwort-IDs der beteiligten Kommentare enthält.
source	Die Quelle des Ereignisses. Sie kann lokal oder remote sein (durch gemeinsame Dokumenterstellung).
type	Der Ereignistyp. Weitere Informationen finden Sie unter Word. EventType für Details.

Details zur Eigenschaft

changeType

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt dar, wie das Kommentaränderungsereignis ausgelöst wird.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

commentDetails

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft das CommentDetail-Array ab, das die IDs und Antwort-IDs der beteiligten Kommentare enthält.

commentDetails: Word.CommentDetail[];

Eigenschaftswert

Word.CommentDetail[]

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

source

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die Quelle des Ereignisses. Sie kann lokal oder remote sein (durch gemeinsame Dokumenterstellung).

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

Eigenschaftswert

Word.EventSource | "Local" | "Remote"

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

type

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Ereignistyp. Weitere Informationen finden Sie unter Word. EventType für Details.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]