Word.CritiquePopupOptions interface

Package:
word

Propriétés définissant le comportement du menu contextuel pour une critique donnée.

Remarques

Jeu d’API : WordApi 1.8

Les cartes d’annotation de critique Word affichent un maximum de trois suggestions. Si plus de trois suggestions sont fournies, le reste n’est pas affiché dans le menu contextuel.

Utilisateur

Exemples

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

Propriétés

brandingTextResourceId

Spécifie l’ID de ressource de manifeste de la chaîne à utiliser pour la personnalisation. Ce texte de personnalisation apparaît à côté de l’icône de votre complément dans le menu contextuel.
subtitleResourceId

Spécifie l’ID de ressource de manifeste de la chaîne à utiliser comme sous-titre.
suggestions

Spécifie les suggestions à afficher dans le menu contextuel critique.
titleResourceId

Spécifie l’ID de ressource de manifeste de la chaîne à utiliser comme titre.

Détails de la propriété

brandingTextResourceId

Spécifie l’ID de ressource de manifeste de la chaîne à utiliser pour la personnalisation. Ce texte de personnalisation apparaît à côté de l’icône de votre complément dans le menu contextuel.

brandingTextResourceId: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApi 1.8

subtitleResourceId

Spécifie l’ID de ressource de manifeste de la chaîne à utiliser comme sous-titre.

subtitleResourceId: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApi 1.8

suggestions

Spécifie les suggestions à afficher dans le menu contextuel critique.

suggestions: string[];

Valeur de propriété

string[]

Remarques

Jeu d’API : WordApi 1.8

titleResourceId

Spécifie l’ID de ressource de manifeste de la chaîne à utiliser comme titre.

titleResourceId: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApi 1.8