Office.EventType enum

発生したイベントの種類を指定します。 *EventArgs オブジェクトの type プロパティによって返されます。

Project 用アドインでは、 Office.EventType.ResourceSelectionChangedOffice.EventType.TaskSelectionChangedOffice.EventType.ViewSelectionChanged イベントの種類がサポートされています。

Outlook 用の作業ウィンドウ アドインのみが、メールボックス API セットのイベントの種類をサポートします。

注釈

// This sample shows how to register an event handler in Outlook.
Office.onReady(() => {
    // Registers an event handler to identify when messages are selected.
    Office.context.mailbox.addHandlerAsync(Office.EventType.SelectedItemsChanged, getMessageProperties, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            return;
        }

        console.log("Event handler added for the SelectedItemsChanged event.");
    });
});

function getMessageProperties() {
    // Retrieves the selected messages' properties and logs them to the console.
    Office.context.mailbox.getSelectedItemsAsync((asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            return;
        }

        asyncResult.value.forEach((message) => {
            console.log(`Item ID: ${message.itemId}`);
            console.log(`Subject: ${message.subject}`);
            console.log(`Item type: ${message.itemType}`);
            console.log(`Item mode: ${message.itemMode}`);
        });
    });
}

フィールド

ActiveViewChanged

PowerPointで Document.ActiveViewChanged イベントが発生しました。

AppointmentTimeChanged

Outlook で選択した予定または系列の日付または時刻が変更されたときに発生します。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

AppointmentTimeChanged イベントのイベント ハンドラーを追加するには、Item オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.AppointmentTimeChangedEventArgs 型の引数を受け取ります。

[ API セット: メールボックス 1.7 ]

AttachmentsChanged

添付ファイルがアイテムに追加またはアイテムから削除されたときに発生します。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

AttachmentsChanged イベントのイベント ハンドラーを追加するには、Item オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.AttachmentsChangedEventArgs 型の引数を受け取ります。

[ API セット: メールボックス 1.8 ]

BindingDataChanged

バインド内のデータが Excel または Word で変更されたときに発生します。

バインドの BindingDataChanged イベントのイベント ハンドラーを追加するには、Binding オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.BindingDataChangedEventArgs 型の引数を受け取ります。

BindingSelectionChanged

Excel または Word のバインド内で選択範囲が変更されたときに発生します。

バインドのBindingSelectionChanged イベントのイベント ハンドラーを追加するには、Binding オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.BindingSelectionChangedEventArgs 型の引数を受け取ります。

DialogEventReceived

ダイアログが閉じたり、ダイアログ ナビゲーションが失敗するなど、ダイアログにイベントがある場合にトリガーされます。

DialogMessageReceived

ダイアログが messageParentを介してメッセージを送信するときにトリガーされます。

DialogParentMessageReceived

ホスト ページが、 messageChildを含む子ダイアログ ボックスにメッセージを送信するときにトリガーされます。

DocumentSelectionChanged

Excel または Word でドキュメント レベルの選択が行われるときにトリガーされます。

EnhancedLocationsChanged

Outlook で予定の場所が変更されたときに発生します。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

EnhancedLocationsChanged イベントのイベント ハンドラーを追加するには、Item オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.EnhancedLocationsChangedEventArgs 型の引数を受け取ります。

[ API セット: メールボックス 1.8 ]

InfobarClicked

カスタム アクションが定義された通知メッセージでアクションが選択されている場合に Outlook で発生。 現時点では、このイベントを発生する唯一のサポートされているアクションは "Dismiss" です。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

InfobarClicked イベントのイベント ハンドラーを追加するには、Item オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.InfobarClickedEventArgs 型の引数を受け取ります。

[ API セット: メールボックス 1.10 ]

ItemChanged

作業ウィンドウがピン留めされている間に、別の Outlook アイテムが表示用に選択されている場合に発生します。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

ItemChanged イベントのイベント ハンドラーを追加するには、Mailbox オブジェクトの addHandlerAsync メソッドを使用します。

[ API セット: メールボックス 1.5 ]

NodeDeleted

customXmlPart ノードが削除されたときにトリガーされます。

NodeInserted

customXmlPart ノードが挿入されたときにトリガーされます。

NodeReplaced

customXmlPart ノードが置き換えられたときにトリガーされます。

OfficeThemeChanged

Outlook で OfficeTheme が変更されたときに発生します。

OfficeThemeChanged イベントのイベント ハンドラーを追加するには、Mailbox オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.OfficeThemeChangedEventArgs 型の引数を受け取ります。

重要:

  • OfficeThemeChanged イベントは、作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

  • OfficeThemeChanged イベントは、イベント ベースのアクティブ化を実装するアドインではサポートされていません

[ API セット: メールボックス 1.14 ]

RecipientsChanged

選択したアイテムの受信者リストまたは予定の場所が Outlook で変更されたときに発生します。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

RecipientsChanged イベントのイベント ハンドラーを追加するには、Item オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.RecipientsChangedEventArgs 型の引数を受け取ります。

[ API セット: メールボックス 1.7 ]

RecurrenceChanged

Outlook で選択した系列の繰り返しパターンが変更されたときに発生します。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

RecurrenceChanged イベントのイベント ハンドラーを追加するには、Item オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.RecurrenceChangedEventArgs 型の引数を受け取ります。

[ API セット: メールボックス 1.7 ]

ResourceSelectionChanged

Project でリソースの選択が行われるときにトリガーされます。

SelectedItemsChanged

1 つ以上のメッセージが選択または選択解除されると、Outlook で発生します。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

SelectedItemsChanged イベントのイベント ハンドラーを追加するには、Mailbox オブジェクトの addHandlerAsync メソッドを使用します。

[ API セット: メールボックス 1.13 ]

SensitivityLabelChanged

メッセージまたは予定の秘密度ラベルが変更されたときに Outlook で発生します。

重要: このイベントは作業ウィンドウでのみ処理できます。 関数コマンドでは、このイベントのハンドラーを登録できません。

SensitivityLabelChanged イベントのイベント ハンドラーを追加するには、Item オブジェクトの addHandlerAsync メソッドを使用します。 イベント ハンドラーは、 Office.SensitivityLabelChangedEventArgs 型の引数を受け取ります。

[ API セット: メールボックス 1.13 ]

SettingsChanged

Excel、PowerPoint、または Word で Settings.settingsChanged イベントが発生しました。

SpamReporting

未承諾メッセージが報告されると、Outlook で発生します。 イベント ハンドラーは、 Office.SpamReportingEventArgs 型の引数を受け取ります。

[ API セット: メールボックス 1.14 ]

TaskSelectionChanged

Project でタスクの選択が行われるときにトリガーされます。

ViewSelectionChanged

プロジェクトでビューの選択が行われるときにトリガーされます。