Eventos de proyectos de Visual Studio Tools para Office

Artículo
04/28/2010

Actualización: noviembre 2007

Cada plantilla de proyecto de Visual Studio Tools para Office genera automáticamente varios controladores de eventos. Los controladores de eventos de las personalizaciones de nivel de documento son ligeramente diferentes de los controladores de eventos de los complementos de nivel de aplicación.

Para obtener más información sobre personalizaciones y complementos, vea Información general sobre el desarrollo de soluciones de Office.

Personalizaciones de nivel de documento

Visual Studio Tools para Office proporciona código generado detrás de los documentos u hojas de cálculo nuevos o existentes en las personalizaciones de nivel de documento. Este código produce dos eventos diferentes: Startup y Shutdown.

Evento Startup

El evento Startup se provoca para cada uno de los elementos host (documento u hoja de cálculo) después de que el documento se esté ejecutando y se haya ejecutado todo el código de inicialización del ensamblado. Es el último elemento que se ejecuta en el constructor de la clase donde se ejecuta el código. Para obtener más información sobre los elementos host, vea Información general sobre elementos y controles Host.

Al crear un proyecto de nivel de documento, Visual Studio Tools para Office crea los controladores de eventos para el evento Startup en los archivos de código generados:

En los proyectos de Microsoft Office Word, el controlador de eventos se denomina ThisDocument_Startup.
En los proyectos Microsoft Office Excel, los controladores de eventos tienen los nombres siguientes:
- Sheet1_Startup
- Sheet2_Startup
- Sheet3_Startup
- ThisWorkbook_Startup

Evento Shutdown

El evento Shutdown se genera para cada uno de los elementos host (documento u hoja de cálculo) cuando el dominio de aplicación donde se ha cargado el código está a punto de descargarse. Es el último elemento al que se llama en la clase cuando ésta se descarga.

Al crear un proyecto de nivel de documento, Visual Studio Tools para Office crea los controladores de eventos para el evento Shutdown en los archivos de código generados:

En los proyectos de Microsoft Office Word, el controlador de eventos se denomina ThisDocument_Shutdown.
En los proyectos Microsoft Office Excel, los controladores de eventos tienen los nombres siguientes:
- Sheet1_Shutdown
- Sheet2_Shutdown
- Sheet3_Shutdown
- ThisWorkbook_Shutdown

Nota:
No quite controles mediante programación durante el funcionamiento del controlador de eventos Shutdown del documento. Los elementos de la interfaz de usuario del documento dejan de estar disponibles cuando se produce el evento Shutdown. Si desea quitar controles antes de que se cierre la aplicación, agregue el código a otro controlador de eventos, como BeforeClose o BeforeSave.

Declaraciones del método controlador de eventos

Cada declaración del método de control de eventos tiene los mismos argumentos que se le han pasado: sender y e. En Excel, el argumento sender hace referencia a la hoja (por ejemplo, Sheet1 o Sheet2); en Word, el argumento sender hace referencia al documento. El argumento e hace referencia a los argumentos estándar de un evento, que no se utilizan en este caso.

El ejemplo de código siguiente muestra los controladores de eventos predeterminados en los proyectos de nivel de documento para Word.

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)
{
}

El ejemplo de código siguiente muestra los controladores de eventos predeterminados en los proyectos de nivel de documento para Excel.

Nota:
En el ejemplo de código siguiente se muestran los controladores de eventos de la clase Sheet1. Los nombres de los controladores de eventos de otras clases de elementos host corresponden al nombre de clase. Por ejemplo, en la clase Sheet2, el controlador de eventos Startup se denomina Sheet2_Startup. En la clase ThisWorkbook, el controlador de eventos Startup se denomina 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)
{
}

Complementos de nivel de aplicación

Visual Studio Tools para Office proporciona código generado en los complementos de nivel de aplicación. Este código produce dos eventos diferentes: Startup y Shutdown.

Evento Startup

El evento Startup se genera cuando el complemento se carga y se ha ejecutado todo el código de inicialización del ensamblado. El método ThisAddIn_Startup del archivo de código generado administra este evento.

El código del controlador de eventos ThisAddIn_Startup es el primer código de usuario que se ejecuta, a menos que el complemento invalide el método RequestComAddInAutomationService. En este caso, se llama al controlador de eventos ThisAddIn_Startup después de RequestComAddInAutomationService. En complementos para Microsoft Office System 2007, también se puede llamar al código del controlador de eventos ThisAddIn_Startup después del método RequestService, si el complemento invalida este método.

Para obtener más información acerca de la secuencia de arranque en los complementos, vea Arquitectura de los complementos de nivel de aplicación.

Evento Shutdown

El evento Shutdown se genera cuando está a punto de descargarse el dominio de aplicación donde está cargado el código. El método ThisAddIn_Shutdown del archivo de código generado administra este evento. Este controlador de eventos es el último código de usuario que se ejecuta al descargar el complemento.