Office.Addin interface

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. Essa API só tem suporte no Excel.

beforeDocumentCloseNotification: BeforeDocumentCloseNotification;

Valor da propriedade

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

Obtém o comportamento de inicialização atual do suplemento.

getStartupBehavior(): Promise<Office.StartupBehavior>;

Retornos

Comentários

Conjunto de requisitos: SharedRuntime 1.1

Oculta o painel de tarefas.

hide(): Promise<void>;

Retornos

Uma promessa que é resolvida quando a interface do usuário está oculta.

Comentários

Conjunto de requisitos: SharedRuntime 1.1

Adiciona um manipulador para o onVisibilityModeChanged evento.

onVisibilityModeChanged(
            handler: (message: VisibilityModeChangedMessage) => void,
        ): Promise<() => Promise<void>>;

Parâmetros

Retornos

Uma promessa que é resolvida como uma função quando o manipulador é adicionado. Chamá-lo remove o manipulador.

Comentários

Conjunto de requisitos: SharedRuntime 1.1

Exemplos

Office.onReady(() => {
    Office.addin.onVisibilityModeChanged((args: Office.VisibilityModeChangedMessage) => {
        if (args.visibilityMode === Office.VisibilityMode.taskpane) {
            // Do something when the task pane is visible.
        }
    });

    // Other startup tasks.
});

Define o comportamento de inicialização do suplemento para quando o documento for aberto da próxima vez.

setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;

Parâmetros

Retornos

Comentários

Conjunto de requisitos: SharedRuntime 1.1

Exemplos

// Configure your add-in to load and start running when the document is opened.
Office.addin.setStartupBehavior(Office.StartupBehavior.load);

Mostra o painel de tarefas associado ao suplemento.

showAsTaskpane(): Promise<void>;

Retornos

Uma promessa que é resolvida quando a interface do usuário é mostrada.

Comentários

Conjunto de requisitos: SharedRuntime 1.1