Office.BeforeDocumentCloseNotification interface

  • Referencia
Paquete:
office

Representa un cuadro de diálogo de notificación modal que puede aparecer cuando el usuario intenta cerrar un documento. El documento no se cerrará hasta que el usuario responda. El cuadro de diálogo de notificación permitirá al usuario confirmar la solicitud para cerrar el documento o cancelar la solicitud para cerrar el documento. Esta API solo se admite en Excel.

Comentarios

Conjunto de requisitos: SharedRuntime 1.2

Ejemplos

// 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();
    });
});

Métodos

disable()

Impide que aparezca el cuadro de diálogo de notificación cuando el usuario intenta cerrar un documento. La BeforeDocumentCloseNotification API solo se admite en Excel.
enable()

Habilite un cuadro de diálogo de notificación modal que aparece cuando el usuario intenta cerrar un documento. El documento no se cerrará hasta que el usuario responda. Este cuadro de diálogo de notificación solicita al usuario que confirme la solicitud para cerrar el documento o permite al usuario cancelar la solicitud para cerrar el documento. La BeforeDocumentCloseNotification API solo se admite en Excel.
onCloseActionCancelled(handler)

Agrega un controlador de eventos que detecta cuándo se cancela la BeforeDocumentCloseNotification operación de cierre. Este controlador de eventos se desencadenará si se cumplen las dos condiciones siguientes.

  1. El complemento llama al enable método en el BeforeDocumentCloseNotification objeto .

  2. Cuando el cuadro de diálogo de notificación está abierto, el usuario final hace clic en el botón No cerrar dentro del cuadro de diálogo, hace clic en el botón Cerrar de la esquina superior derecha del cuadro de diálogo o presiona la tecla Esc.

La BeforeDocumentCloseNotification API solo se admite en Excel.

Detalles del método

disable()

Impide que aparezca el cuadro de diálogo de notificación cuando el usuario intenta cerrar un documento. La BeforeDocumentCloseNotification API solo se admite en Excel.

disable(): Promise<void>;

Devoluciones

Promise<void>

Comentarios

Conjunto de requisitos: SharedRuntime 1.2

enable()

Habilite un cuadro de diálogo de notificación modal que aparece cuando el usuario intenta cerrar un documento. El documento no se cerrará hasta que el usuario responda. Este cuadro de diálogo de notificación solicita al usuario que confirme la solicitud para cerrar el documento o permite al usuario cancelar la solicitud para cerrar el documento. La BeforeDocumentCloseNotification API solo se admite en Excel.

enable(): Promise<void>;

Devoluciones

Promise<void>

Comentarios

Conjunto de requisitos: SharedRuntime 1.2

onCloseActionCancelled(handler)

Agrega un controlador de eventos que detecta cuándo se cancela la BeforeDocumentCloseNotification operación de cierre. Este controlador de eventos se desencadenará si se cumplen las dos condiciones siguientes.

  1. El complemento llama al enable método en el BeforeDocumentCloseNotification objeto .

  2. Cuando el cuadro de diálogo de notificación está abierto, el usuario final hace clic en el botón No cerrar dentro del cuadro de diálogo, hace clic en el botón Cerrar de la esquina superior derecha del cuadro de diálogo o presiona la tecla Esc.

La BeforeDocumentCloseNotification API solo se admite en Excel.

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

Parámetros

handler

() => void

Controlador de eventos al que se llama cuando se cancela el cuadro de diálogo.

Devoluciones

Promise<() => Promise<void>>

Promesa que se resuelve cuando se agrega el controlador de eventos.

Comentarios

Conjunto de requisitos: SharedRuntime 1.2