通过

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 ]