Eventos em projetos do Office

Artigo
02/25/2013

Cada modelo de projeto do Office gera automaticamente vários manipuladores de eventos.Os manipuladores de eventos para personalizações da nível são um pouco diferentes de manipuladores de eventos para suplementos do aplicativo.

Aplicáve a: As informações neste tópico se aplicam a projetos em nível de aplicativo e em nível de documento para o Office 2013 e o Office 2010. Consulte Recursos disponíveis pelo aplicativo do Office e o tipo de projeto.

Projetos de um documento Nível

Visual Studio fornece o código gerado code-behind novos ou existentes ou de documentos em planilhas personalizações da nível.Esse código gera dois eventos diferentes: Startup e Shutdown.

Eventos de inicialização

O evento de Startup é gerado para cada host que os itens (documento, pasta de trabalho ou planilha) após o documento está executando o e qualquer código de inicialização no assembly foi executado.É a coisa mais recente a executar no construtor da classe que seu código está sendo executado em.Para obter mais informações sobre os itens host, consulte Itens de host e visão geral sobre controles de Host.

Quando você cria um projeto de um documento nível, o Visual Studio cria manipuladores de eventos para o evento de Startup gerados nos arquivos de código a seguir:

Para projetos Microsoft Office Word, o manipulador de eventos é chamado ThisDocument_Startup.
Para projetos Microsoft Office Excel, os manipuladores de eventos possuem os seguintes nomes:
- Sheet1_Startup
- Sheet2_Startup
- Sheet3_Startup
- ThisWorkbook_Startup

Eventos de desligamento

O evento deShutdowné gerado para cada um dos itens de host (documento ou planilha) quando o domínio de aplicativo que seu código está carregado no é o ponto de descarregar.É a coisa mais recente seja chamado na classe como descarregar.

Quando você cria um projeto de um documento nível, o Visual Studio cria manipuladores de eventos para o evento deShutdowngerados nos arquivos de código a seguir:

Para projetos Microsoft Office Word, o manipulador de eventos é chamado ThisDocument_Shutdown.
Para projetos Microsoft Office Excel, os manipuladores de eventos possuem os seguintes nomes:
- Sheet1_Shutdown
- Sheet2_Shutdown
- Sheet3_Shutdown
- ThisWorkbook_Shutdown

Observação
Não remover programaticamente os controles no manipulador de eventos de Shutdown do documento.Os elementos de interface de usuário do documento não estão mais disponíveis quando o evento de Shutdown ocorre.Se você deseja remover os controles antes que o aplicativo seja fechada, adicione o código para outro manipulador de eventos, como BeforeClose ou BeforeSave.

Declarações de método manipulador de eventos

Cada declaração de método manipulador de eventos tem os mesmos argumentos passados para ele: sender e e.O excel, o argumento de sender refere-se à folha, como Sheet1 ou Sheet2; nas palavras, o argumento de sender refere-se ao documento.O argumento de e referem aos argumentos padrão para um evento, que não são usados em esse caso.

O exemplo de código a seguir mostra os manipuladores de eventos padrão em projetos de nível para a palavra.

Private Sub ThisDocument_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Startup

End Sub

Private Sub ThisDocument_Shutdown(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Shutdown

End Sub

private void ThisDocument_Startup(object sender, System.EventArgs e)
{
}

private void ThisDocument_Shutdown(object sender, System.EventArgs e)
{
}

O exemplo de código a seguir mostra os manipuladores de eventos padrão em projetos de um documento nível para o excel.

Observação
O exemplo de código a seguir mostra os manipuladores de eventos na classe de Sheet1 .Os nomes de manipuladores de eventos em outras classes de item host correspondem ao nome da classe.Por exemplo, a classe de Sheet2 , o manipulador de eventos de Startup é chamado Sheet2_Startup.Em a classe de ThisWorkbook , o manipulador de eventos de Startup é chamado ThisWorkbook_Startup.

Private Sub Sheet1_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Startup

End Sub

Private Sub Sheet1_Shutdown(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Shutdown

End Sub

private void Sheet1_Startup(object sender, System.EventArgs e)
{
}

private void Sheet1_Shutdown(object sender, System.EventArgs e)
{
}

Ordem dos eventos em projetos a Nível do excel

Os manipuladores de eventos de Startup em projetos do excel são chamados em esta ordem:

ThisWorkbook_Startup.
Sheet1_Startup.
Sheet2_Startup.
Sheet3_Startup.
outras folhas em ordem.

Os manipuladores de eventos deShutdown em uma solução de pasta de trabalho são chamados em esta ordem:

ThisWorkbook_Shutdown.
Sheet1_Shutdown.
Sheet2_Shutdown.
Sheet3_Shutdown.
outras folhas em ordem.

A ordem é determinado quando o projeto é criado.Se o usuário reordena as folhas em tempo de execução, não altera a ordem em que os eventos são gerados na próxima vez na pasta de trabalho estão abertos ou fechados.

Projetos de Nível de aplicativo

Visual Studio fornece o código gerado em suplementos do aplicativo.Esse código gera dois eventos diferentes: Startup e Shutdown.

Eventos de inicialização

O evento de Startup é gerado após o suplemento é carregado e qualquer código de inicialização no assembly foi executado.Este evento é tratado pelo método de ThisAddIn_Startup no arquivo de código gerado.

O código no manipulador de eventos de ThisAddIn_Startup é o primeiro código do usuário para executar, a menos que o suplemento substitua o método de RequestComAddInAutomationService .Em esse caso, o manipulador de eventos de ThisAddIn_Startup é chamado após RequestComAddInAutomationService.

Não adicionar o código no manipulador de eventos de ThisAdd-In_Startup se o código requer um documento ser aberto.Em vez de isso, adicione o código a um evento que o aplicativo do Office aumenta quando um usuário cria ou abre um documento.Para obter mais informações, consulte Acessando um documento quando o aplicativo for iniciado do Office.

Para obter mais informações sobre a seqüência de inicialização de suplementos, consulte Arquitetura dos suplementos de nível de aplicativo.

Eventos de desligamento

O evento de Shutdown é gerado quando o domínio de aplicativo que seu código está carregado no está prestes a ser descarregado.Este evento é tratado pelo método de ThisAddIn_Shutdown no arquivo de código gerado.Este manipulador de eventos é o último código do usuário a ser executado enquanto o suplemento é descarregado.

Eventos de desligamento em suplementos do Outlook

O evento de Shutdown é gerado apenas quando o usuário desativou o suplemento usando a caixa de diálogo de suplementos COM em Outlook.Não é gerado quando Outlook sai.Se você tiver código que deve executar quando Outlook termina, manipular qualquer um dos seguintes eventos:

O evento de Quit do objeto de Application .
O evento de Close do objeto de Explorer .

Observação
Você pode forçar Outlook para disparar o evento de Shutdown quando sai alterando o Registro.Em o entanto, se um administrador reverte essa configuração, qualquer código que você adicionar a execução do método de ThisAddIn_Shutdown não quando Outlook sair.Para obter mais informações, consulte O desligamento alterações para o Outlook 2010.