Office.Addin interface

  • Referência
Pacote:
office

Representa a funcionalidade de nível de suplemento para operar ou configurar vários aspectos do suplemento.

Comentários

Conjunto de requisitos: SharedRuntime 1.1

Propriedades

beforeDocumentCloseNotification

Representa uma caixa de diálogo de notificação modal que pode ser exibida 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.

Métodos

getStartupBehavior()

Obtém o comportamento de inicialização atual para o suplemento.
hide()

Oculta o painel de tarefas.
onVisibilityModeChanged(handler)

Adiciona um manipulador para o onVisibilityModeChanged evento.
setStartupBehavior(behavior)

Define o comportamento de inicialização para o suplemento para quando o documento for aberto na próxima vez.
showAsTaskpane()

Mostra o painel de tarefas associado ao suplemento.

Detalhes da propriedade

beforeDocumentCloseNotification

Representa uma caixa de diálogo de notificação modal que pode ser exibida 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

Office.BeforeDocumentCloseNotification

Comentários

Conjunto de requisitos: SharedRuntime 1.2

Detalhes do método

getStartupBehavior()

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

getStartupBehavior(): Promise<Office.StartupBehavior>;

Retornos

Promise<Office.StartupBehavior>

Comentários

Conjunto de requisitos: SharedRuntime 1.1

hide()

Oculta o painel de tarefas.

hide(): Promise<void>;

Retornos

Promise<void>

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

Comentários

Conjunto de requisitos: SharedRuntime 1.1

onVisibilityModeChanged(handler)

Adiciona um manipulador para o onVisibilityModeChanged evento.

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

Parâmetros

handler

(message: Office.VisibilityModeChangedMessage) => void

A função de manipulador chamada quando o evento é emitido. Essa função leva uma mensagem para o componente receptor.

Retornos

Promise<() => Promise<void>>

Uma promessa que se resolve para 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) => {
        if (args.visibilityMode === Office.VisibilityMode.taskpane) {
            // Do something when the task pane is visible.
        }
    });

    // Other startup tasks.
});

setStartupBehavior(behavior)

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

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

Parâmetros

behavior
Office.StartupBehavior

Especifica o comportamento de inicialização do suplemento.

Retornos

Promise<void>

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

showAsTaskpane()

Mostra o painel de tarefas associado ao suplemento.

showAsTaskpane(): Promise<void>;

Retornos

Promise<void>

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

Comentários

Conjunto de requisitos: SharedRuntime 1.1