Word.Critique interface

パッケージ:

word

ドキュメント内の段落の指定した部分の下線としてレンダリングされる批判。

注釈

[ API セット: WordApi 1.7 ]

例

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

プロパティ

colorScheme	批判の配色を指定します。
length	段落内の批判の長さを指定します。
popupOptions	批判のポップアップ メニューの動作を指定します。
start	段落内の批判の開始インデックスを指定します。

プロパティの詳細

colorScheme

批判の配色を指定します。

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

プロパティ値

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

注釈

[ API セット: WordApi 1.7 ]

length

段落内の批判の長さを指定します。

length: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.7 ]

popupOptions

批判のポップアップ メニューの動作を指定します。

popupOptions?: Word.CritiquePopupOptions;

プロパティ値

Word.CritiquePopupOptions

注釈

[ API セット: WordApi 1.8 ]

start

段落内の批判の開始インデックスを指定します。

start: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.7 ]