Partager via

Word.Critique interface

  • Référence
Paquet:
word

Critique qui sera rendue sous forme de soulignement pour la partie spécifiée du paragraphe dans le document.

Remarques

[ Ensemble d’API : WordApi 1.7 ]

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

colorScheme

Obtient le jeu de couleurs de la critique.
length

Obtient la longueur de la critique à l’intérieur du paragraphe.
popupOptions

Spécifie le comportement du menu contextuel pour la critique.
start

Obtient l’index de début de la critique à l’intérieur du paragraphe.

Détails de la propriété

colorScheme

Obtient le jeu de couleurs de la critique.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : WordApi 1.7 ]

length

Obtient la longueur de la critique à l’intérieur du paragraphe.

length: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.7 ]

popupOptions

Spécifie le comportement du menu contextuel pour la critique.

popupOptions: Word.CritiquePopupOptions;

Valeur de propriété

Word.CritiquePopupOptions

Remarques

[ Ensemble d’API : WordApi 1.8 ]

start

Obtient l’index de début de la critique à l’intérieur du paragraphe.

start: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.7 ]