Word.Critique interface

  • Referenz
Paket:
word

Kritik, die als Unterstreichung für den angegebenen Teil des Absatzes im Dokument gerendert wird.

Hinweise

[ API-Satz: WordApi 1.7 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Adds annotations to the selected paragraph.
await Word.run(async (context) => {
  const paragraph = context.document.getSelection().paragraphs.getFirst();
  const critique1 = {
    colorScheme: Word.CritiqueColorScheme.red,
    start: 1,
    length: 3
  };
  const critique2 = {
    colorScheme: Word.CritiqueColorScheme.green,
    start: 6,
    length: 1
  };
  const critique3 = {
    colorScheme: Word.CritiqueColorScheme.blue,
    start: 10,
    length: 3
  };
  const critique4 = {
    colorScheme: Word.CritiqueColorScheme.lavender,
    start: 14,
    length: 3
  };
  const critique5 = {
    colorScheme: Word.CritiqueColorScheme.berry,
    start: 18,
    length: 10
  };
  const annotationSet: Word.AnnotationSet = {
    critiques: [critique1, critique2, critique3, critique4, critique5]
  };

  const annotationIds = paragraph.insertAnnotations(annotationSet);

  await context.sync();

  console.log("Annotations inserted:", annotationIds.value);
});

Eigenschaften

colorScheme

Ruft das Farbschema der Kritik ab.
length

Ruft die Länge der Kritik innerhalb des Absatzes ab.
popupOptions

Gibt das Verhalten des Popupmenüs für die Kritik an.
start

Ruft den Startindex der Kritik innerhalb des Absatzes ab.

Details zur Eigenschaft

colorScheme

Ruft das Farbschema der Kritik ab.

colorScheme: Word.CritiqueColorScheme | "Red" | "Green" | "Blue" | "Lavender" | "Berry";

Eigenschaftswert

Word.CritiqueColorScheme | "Red" | "Green" | "Blue" | "Lavender" | "Berry"

Hinweise

[ API-Satz: WordApi 1.7 ]

length

Ruft die Länge der Kritik innerhalb des Absatzes ab.

length: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.7 ]

popupOptions

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.

Gibt das Verhalten des Popupmenüs für die Kritik an.

popupOptions: Word.CritiquePopupOptions;

Eigenschaftswert

Word.CritiquePopupOptions

Hinweise

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

start

Ruft den Startindex der Kritik innerhalb des Absatzes ab.

start: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.7 ]