Office.BeforeDocumentCloseNotification interface

Pacote:
office

Representa uma caixa de diálogo de notificação modal que pode aparecer quando o usuário tenta fechar um documento. O documento não será fechado até que o usuário responda. A caixa de diálogo de notificação permitirá que o usuário confirme a solicitação para fechar o documento ou cancele a solicitação para fechar o documento. Essa API só tem suporte no Excel.

Comentários

Conjunto de requisitos: SharedRuntime 1.2

Usada por

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 apareça quando o usuário tenta fechar um documento. A API só é suportada BeforeDocumentCloseNotification no Excel.
enable()

Ative uma caixa de diálogo de notificação modal que aparece quando o usuário tenta fechar um documento. O documento não será fechado até que o usuário responda. Essa caixa de diálogo de notificação solicita que o usuário confirme a solicitação para fechar o documento ou permite que o usuário cancele a solicitação para fechar o documento. A API só é suportada BeforeDocumentCloseNotification no Excel.
onCloseActionCancelled(handler)

Adiciona um manipulador de eventos que detecta quando a operação de BeforeDocumentCloseNotification fechamento é cancelada. Esse manipulador de eventos será disparado se ambas as condições a seguir forem atendidas.

  1. O suplemento chama o enableBeforeDocumentCloseNotification método no objeto.

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

A API só é suportada BeforeDocumentCloseNotification no Excel.

Detalhes do método

disable()

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

disable(): Promise<void>;

Retornos

Promise<void>

Comentários

Conjunto de requisitos: SharedRuntime 1.2

Exemplos

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

enable()

Ative uma caixa de diálogo de notificação modal que aparece quando o usuário tenta fechar um documento. O documento não será fechado até que o usuário responda. Essa caixa de diálogo de notificação solicita que o usuário confirme a solicitação para fechar o documento ou permite que o usuário cancele a solicitação para fechar o documento. A API só é suportada BeforeDocumentCloseNotification no Excel.

enable(): Promise<void>;

Retornos

Promise<void>

Comentários

Conjunto de requisitos: SharedRuntime 1.2

Exemplos

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

Adiciona um manipulador de eventos que detecta quando a operação de BeforeDocumentCloseNotification fechamento é cancelada. Esse manipulador de eventos será disparado se ambas as condições a seguir forem atendidas.

  1. O suplemento chama o enableBeforeDocumentCloseNotification método no objeto.

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

A API só é suportada BeforeDocumentCloseNotification no Excel.

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

Parâmetros

handler

() => void

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

Retornos

Promise<() => Promise<void>>

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

Comentários

Conjunto de requisitos: SharedRuntime 1.2