Word.CritiquePopupOptions interface

Paket:

word

Eigenschaften, die das Verhalten des Popupmenüs für eine bestimmte Kritik definieren.

Hinweise

[ API-Satz: WordApi 1.8 ]

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: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  const options: Word.CritiquePopupOptions = {
    brandingTextResourceId: "PG.TabLabel",
    subtitleResourceId: "PG.HelpCommand.TipTitle",
    titleResourceId: "PG.HelpCommand.Label",
    suggestions: ["suggestion 1", "suggestion 2", "suggestion 3"]
  };
  const critique1: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.red,
    start: 1,
    length: 3,
    popupOptions: options
  };
  const critique2: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.green,
    start: 6,
    length: 1,
    popupOptions: options
  };
  const critique3: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.blue,
    start: 10,
    length: 3,
    popupOptions: options
  };
  const critique4: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.lavender,
    start: 14,
    length: 3,
    popupOptions: options
  };
  const critique5: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.berry,
    start: 18,
    length: 10,
    popupOptions: options
  };
  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

brandingTextResourceId	Ruft die Manifestressourcen-ID der Zeichenfolge ab, die für das Branding verwendet werden soll. Dieser Brandingtext wird neben dem Add-In-Symbol im Popupmenü angezeigt.
subtitleResourceId	Ruft die Manifestressourcen-ID der Zeichenfolge ab, die als Untertitel verwendet werden soll.
suggestions	Ruft die Vorschläge ab, die im Popupmenü Kritik angezeigt werden sollen.
titleResourceId	Ruft die Manifestressourcen-ID der Zeichenfolge ab, die als Titel verwendet werden soll.

Details zur Eigenschaft

brandingTextResourceId

Ruft die Manifestressourcen-ID der Zeichenfolge ab, die für das Branding verwendet werden soll. Dieser Brandingtext wird neben dem Add-In-Symbol im Popupmenü angezeigt.

brandingTextResourceId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.8 ]

subtitleResourceId

Ruft die Manifestressourcen-ID der Zeichenfolge ab, die als Untertitel verwendet werden soll.

subtitleResourceId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.8 ]

suggestions

Ruft die Vorschläge ab, die im Popupmenü Kritik angezeigt werden sollen.

suggestions: string[];

Eigenschaftswert

string[]

Hinweise

[ API-Satz: WordApi 1.8 ]

titleResourceId

Ruft die Manifestressourcen-ID der Zeichenfolge ab, die als Titel verwendet werden soll.

titleResourceId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.8 ]