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 ]