Word.ContentControlEventArgs interface

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

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

イベントを発生させたコンテンツ コントロールに関する情報を提供します。

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

プロパティ

contentControl

イベントを発生させたオブジェクト。 このオブジェクトを読み込み、そのプロパティを取得します。
eventType

イベントの種類。 詳細については、「Word.EventType」を参照してください。
ids

コンテンツ コントロール ID を取得します。
source

イベントのソース。 ローカルまたはリモート (共同編集を使用) できます。

プロパティの詳細

contentControl

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

イベントを発生させたオブジェクト。 このオブジェクトを読み込み、そのプロパティを取得します。

contentControl: Word.ContentControl;

プロパティ値

Word.ContentControl

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/content-control-ondeleted-event.yaml
async function contentControlDeleted(event: Word.ContentControlEventArgs) {
  await Word.run(async (context) => {
    // Display the deleted content control's ID.
    console.log(`${event.eventType} event detected. ID of content control that was deleted: ${event.contentControl.id}`);
  });
}

eventType

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

イベントの種類。 詳細については、「Word.EventType」を参照してください。

eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";

プロパティ値

Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited"

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/content-control-ondeleted-event.yaml
async function contentControlDeleted(event: Word.ContentControlEventArgs) {
  await Word.run(async (context) => {
    // Display the deleted content control's ID.
    console.log(`${event.eventType} event detected. ID of content control that was deleted: ${event.contentControl.id}`);
  });
}

ids

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コンテンツ コントロール ID を取得します。

ids: number[];

プロパティ値

number[]

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

source

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

イベントのソース。 ローカルまたはリモート (共同編集を使用) できます。

source: Word.EventSource | "Local" | "Remote";

プロパティ値

Word.EventSource | "Local" | "Remote"

注釈

[ API セット: WordApi BETA (プレビューのみ) ]