Word.CritiquePopupOptions interface

  • リファレンス
パッケージ:
word

特定の批判に対するポップアップ メニューの動作を定義するプロパティ。

注釈

[ API セット: WordApi 1.8 ]

例

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

プロパティ

brandingTextResourceId

ブランド化に使用する文字列のマニフェスト リソース ID を取得します。 このブランド化テキストは、ポップアップ メニューのアドイン アイコンの横に表示されます。
subtitleResourceId

サブタイトルとして使用する文字列のマニフェスト リソース ID を取得します。
suggestions

批判ポップアップ メニューに表示する候補を取得します。
titleResourceId

タイトルとして使用する文字列のマニフェスト リソース ID を取得します。

プロパティの詳細

brandingTextResourceId

ブランド化に使用する文字列のマニフェスト リソース ID を取得します。 このブランド化テキストは、ポップアップ メニューのアドイン アイコンの横に表示されます。

brandingTextResourceId: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.8 ]

subtitleResourceId

サブタイトルとして使用する文字列のマニフェスト リソース ID を取得します。

subtitleResourceId: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.8 ]

suggestions

批判ポップアップ メニューに表示する候補を取得します。

suggestions: string[];

プロパティ値

string[]

注釈

[ API セット: WordApi 1.8 ]

titleResourceId

タイトルとして使用する文字列のマニフェスト リソース ID を取得します。

titleResourceId: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.8 ]