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

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

Комментарии

Набор обязательных требований: SharedRuntime 1.2