Word.AnnotationPopupActionEventArgs 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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onPopupActionHandler(args: Word.AnnotationPopupActionEventArgs) {
  await Word.run(async (context) => {
    let message = `AnnotationPopupAction: ID ${args.id} = `;
    if (args.action === "Accept") {
      message += `Accepted: ${args.critiqueSuggestion}`;
    } else {
      message += "Rejected";
    }

    console.log(message);
  });
}

プロパティ

action	ポップアップ メニューで選択したアクションを指定します。
critiqueSuggestion	受け入れられた提案を指定します (批判の提案を受け入れるときにのみ設定されます)。
id	イベントが発生した注釈 ID を指定します。

プロパティの詳細

action

ポップアップ メニューで選択したアクションを指定します。

action: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.8 ]

critiqueSuggestion

受け入れられた提案を指定します (批判の提案を受け入れるときにのみ設定されます)。

critiqueSuggestion: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.8 ]

id

イベントが発生した注釈 ID を指定します。

id: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.8 ]