Office.BeforeDocumentCloseNotification interface

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

ユーザーがドキュメントを閉じようとしたときに表示されるモーダル通知ダイアログを表します。 ユーザーが応答するまで、ドキュメントは閉じられません。 通知ダイアログを使用すると、ユーザーはドキュメントを閉じる要求を確認したり、ドキュメントを閉じる要求を取り消したりできます。 この API は Excel でのみサポートされています。

注釈

要件セット: SharedRuntime 1.2

例

// Enable the before document close modal notification dialog. 
async function enableNotification() {
    await Office.addin.beforeDocumentCloseNotification.enable(); 
}

// Add an event handler to detect when the document close operation is cancelled.
Office.addin.beforeDocumentCloseNotification.onCloseActionCancelled(async function () {
    // When the document close attempt is cancelled, write a message to the active range in the worksheet.
    await Excel.run(async (context) => {
        const range = context.workbook.getSelectedRange();
        range.values = [["Detected onCloseActionCancelled event."]];
        await context.sync();
    });
});

メソッド

disable()

ユーザーがドキュメントを閉じようとしたときに通知ダイアログが表示されないようにします。 BeforeDocumentCloseNotificationこの API は Excel でのみサポートされています。
enable()

ユーザーがドキュメントを閉じようとしたときに表示されるモーダル通知ダイアログを有効にします。 ユーザーが応答するまで、ドキュメントは閉じられません。 この通知ダイアログでは、ドキュメントを閉じる要求の確認をユーザーに求めるか、ユーザーがドキュメントを閉じる要求を取り消すことができます。 BeforeDocumentCloseNotificationこの API は Excel でのみサポートされています。
onCloseActionCancelled(handler)

閉じる操作が取り消されたときに検出するイベント ハンドラーを BeforeDocumentCloseNotification 追加します。 このイベント ハンドラーは、次の両方の条件が満たされた場合にトリガーされます。

  1. アドインは、 オブジェクトの enable メソッドを BeforeDocumentCloseNotification 呼び出します。

  2. 通知ダイアログが開いている場合、エンド ユーザーはダイアログ内の [閉じない ] ボタンをクリックし、ダイアログの右上隅にある [閉じる] ボタンをクリックするか、Esc キーを押します。

BeforeDocumentCloseNotificationこの API は Excel でのみサポートされています。

メソッドの詳細

disable()

ユーザーがドキュメントを閉じようとしたときに通知ダイアログが表示されないようにします。 BeforeDocumentCloseNotificationこの API は Excel でのみサポートされています。

disable(): Promise<void>;

戻り値

Promise<void>

注釈

要件セット: SharedRuntime 1.2

enable()

ユーザーがドキュメントを閉じようとしたときに表示されるモーダル通知ダイアログを有効にします。 ユーザーが応答するまで、ドキュメントは閉じられません。 この通知ダイアログでは、ドキュメントを閉じる要求の確認をユーザーに求めるか、ユーザーがドキュメントを閉じる要求を取り消すことができます。 BeforeDocumentCloseNotificationこの API は Excel でのみサポートされています。

enable(): Promise<void>;

戻り値

Promise<void>

注釈

要件セット: SharedRuntime 1.2

onCloseActionCancelled(handler)

閉じる操作が取り消されたときに検出するイベント ハンドラーを BeforeDocumentCloseNotification 追加します。 このイベント ハンドラーは、次の両方の条件が満たされた場合にトリガーされます。

  1. アドインは、 オブジェクトの enable メソッドを BeforeDocumentCloseNotification 呼び出します。

  2. 通知ダイアログが開いている場合、エンド ユーザーはダイアログ内の [閉じない ] ボタンをクリックし、ダイアログの右上隅にある [閉じる] ボタンをクリックするか、Esc キーを押します。

BeforeDocumentCloseNotificationこの API は Excel でのみサポートされています。

onCloseActionCancelled(
            handler: () => void
        ): Promise<() => Promise<void>>;

パラメーター

handler

() => void

ダイアログが取り消されたときに呼び出されるイベント ハンドラー。

戻り値

Promise<() => Promise<void>>

イベント ハンドラーが追加されたときに解決される promise。

注釈

要件セット: SharedRuntime 1.2