Office.BeforeDocumentCloseNotification interface

  • Referência
Pacote:
office

Representa uma caixa de diálogo de notificação modal que pode ser apresentada quando o utilizador tenta fechar um documento. O documento não será fechado até que o utilizador responda. A caixa de diálogo de notificação permitirá ao utilizador confirmar o pedido para fechar o documento ou cancelar o pedido para fechar o documento. Esta API só é suportada no Excel.

Comentários

Conjunto de requisitos: SharedRuntime 1.2

Exemplos

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

Impede que a caixa de diálogo de notificação seja apresentada quando o utilizador tenta fechar um documento. A BeforeDocumentCloseNotification API só é suportada no Excel.
enable()

Ative uma caixa de diálogo de notificação modal que é apresentada quando o utilizador tenta fechar um documento. O documento não será fechado até que o utilizador responda. Esta caixa de diálogo de notificação pede ao utilizador para confirmar o pedido para fechar o documento ou permite que o utilizador cancele o pedido para fechar o documento. A BeforeDocumentCloseNotification API só é suportada no Excel.
onCloseActionCancelled(handler)

Adiciona um processador de eventos que deteta quando a BeforeDocumentCloseNotification operação de fecho é cancelada. Este processador de eventos será acionado se ambas as condições seguintes forem cumpridas.

  1. O suplemento chama o enable método no BeforeDocumentCloseNotification objeto .

  2. Quando a caixa de diálogo de notificação está aberta, o utilizador final clica no botão Não fechar na caixa de diálogo, clica no botão Fechar no canto superior direito da caixa de diálogo ou prime a tecla Esc.

A BeforeDocumentCloseNotification API só é suportada no Excel.

Detalhes do método

disable()

Impede que a caixa de diálogo de notificação seja apresentada quando o utilizador tenta fechar um documento. A BeforeDocumentCloseNotification API só é suportada no Excel.

disable(): Promise<void>;

Retornos

Promise<void>

Comentários

Conjunto de requisitos: SharedRuntime 1.2

enable()

Ative uma caixa de diálogo de notificação modal que é apresentada quando o utilizador tenta fechar um documento. O documento não será fechado até que o utilizador responda. Esta caixa de diálogo de notificação pede ao utilizador para confirmar o pedido para fechar o documento ou permite que o utilizador cancele o pedido para fechar o documento. A BeforeDocumentCloseNotification API só é suportada no Excel.

enable(): Promise<void>;

Retornos

Promise<void>

Comentários

Conjunto de requisitos: SharedRuntime 1.2

onCloseActionCancelled(handler)

Adiciona um processador de eventos que deteta quando a BeforeDocumentCloseNotification operação de fecho é cancelada. Este processador de eventos será acionado se ambas as condições seguintes forem cumpridas.

  1. O suplemento chama o enable método no BeforeDocumentCloseNotification objeto .

  2. Quando a caixa de diálogo de notificação está aberta, o utilizador final clica no botão Não fechar na caixa de diálogo, clica no botão Fechar no canto superior direito da caixa de diálogo ou prime a tecla Esc.

A BeforeDocumentCloseNotification API só é suportada no Excel.

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

Parâmetros

handler

() => void

O processador de eventos que é chamado quando a caixa de diálogo é cancelada.

Retornos

Promise<() => Promise<void>>

Uma promessa que é resolvida quando o processador de eventos é adicionado.

Comentários

Conjunto de requisitos: SharedRuntime 1.2