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()

Предотвращает появление диалогового окна уведомления, когда пользователь пытается закрыть документ. API BeforeDocumentCloseNotification поддерживается только в Excel.
enable()

Включение модального диалогового окна, которое появляется, когда пользователь пытается закрыть документ. Документ не закроется, пока пользователь не ответит. Это диалоговое окно уведомления просит пользователя подтвердить запрос на закрытие документа или позволяет пользователю отменить запрос на закрытие документа. API BeforeDocumentCloseNotification поддерживается только в Excel.
onCloseActionCancelled(handler)

Добавляет обработчик событий, определяющий отмену операции закрытия BeforeDocumentCloseNotification . Этот обработчик событий срабатывает, если выполняются оба следующих условия.

  1. Надстройка вызывает enable метод объекта BeforeDocumentCloseNotification .

  2. Когда диалоговое окно уведомления открыто, конечный пользователь нажимает кнопку "Не закрывать " в диалоговом окне, кнопку "Закрыть" в правом верхнем углу диалогового окна или клавишу ESC .

API BeforeDocumentCloseNotification поддерживается только в Excel.

Сведения о методе

disable()

Предотвращает появление диалогового окна уведомления, когда пользователь пытается закрыть документ. API BeforeDocumentCloseNotification поддерживается только в Excel.

disable(): Promise<void>;

Возвращаемое значение

Promise<void>

Комментарии

Набор требований: SharedRuntime 1.2

Примеры

// Disable the dialog that pops up when the user tries to close the document.
async function disableCloseNotification() {
    await Office.addin.beforeDocumentCloseNotification.disable(); 
}

enable()

Включение модального диалогового окна, которое появляется, когда пользователь пытается закрыть документ. Документ не закроется, пока пользователь не ответит. Это диалоговое окно уведомления просит пользователя подтвердить запрос на закрытие документа или позволяет пользователю отменить запрос на закрытие документа. API BeforeDocumentCloseNotification поддерживается только в Excel.

enable(): Promise<void>;

Возвращаемое значение

Promise<void>

Комментарии

Набор требований: SharedRuntime 1.2

Примеры

// Enable the dialog that pops up and asks the user for confirmation when they try to close the document.
async function enableCloseNotification() {
    await Office.addin.beforeDocumentCloseNotification.enable(); 
}

onCloseActionCancelled(handler)

Добавляет обработчик событий, определяющий отмену операции закрытия BeforeDocumentCloseNotification . Этот обработчик событий срабатывает, если выполняются оба следующих условия.

  1. Надстройка вызывает enable метод объекта BeforeDocumentCloseNotification .

  2. Когда диалоговое окно уведомления открыто, конечный пользователь нажимает кнопку "Не закрывать " в диалоговом окне, кнопку "Закрыть" в правом верхнем углу диалогового окна или клавишу ESC .

API BeforeDocumentCloseNotification поддерживается только в Excel.

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

Параметры

handler

() => void

Обработчик событий, вызываемый при отмене диалогового окна.

Возвращаемое значение

Promise<() => Promise<void>>

Отложенный результат, который разрешается при добавлении обработчика событий.

Комментарии

Набор требований: SharedRuntime 1.2