Événements de projet Visual Studio Tools pour Office

  • Article

Mise à jour : novembre 2007

Chaque modèle de projet Visual Studio Tools pour Office génère automatiquement plusieurs gestionnaires d'événements. Les gestionnaires d'événements des personnalisations au niveau du document sont légèrement différents de ceux des compléments au niveau de l'application.

Pour plus d'informations sur les personnalisations et les compléments, consultez Vue d'ensemble du développement des solutions Office.

Personnalisations au niveau du document

Visual Studio Tools pour Office fournit du code généré derrière des documents ou feuilles de calcul nouveaux ou existants dans les personnalisations au niveau du document. Ce code déclenche deux événements différents : Startup et Shutdown.

Événement Startup

L'événement Startup est déclenché pour chacun des éléments hôtes (document ou feuille de calcul) dès que le document est en cours d'exécution et que tout le code d'initialisation dans l'assembly a été exécuté. Il s'agit de la dernière opération à exécuter dans le constructeur de la classe dans laquelle votre code s'exécute. Pour plus d'informations sur les éléments hôtes, consultez Vue d'ensemble des éléments hôtes et des contrôles hôtes.

Lorsque vous créez un projet au niveau du document, Visual Studio Tools pour Office crée des gestionnaires d'événements pour l'événement Startup dans les fichiers de code générés :

  • Pour les projets Microsoft Office Word, le gestionnaire d'événements s'appelle ThisDocument_Startup.

  • Pour les projets Microsoft Office Excel, les gestionnaires d'événements portent les noms suivants :

    • Sheet1_Startup

    • Sheet2_Startup

    • Sheet3_Startup

    • ThisWorkbook_Startup

Événement Shutdown

L'événement Shutdown est déclenché pour chacun des éléments hôtes (document ou feuille de calcul) lorsque le domaine d'application dans lequel votre code est chargé est sur le point d'être déchargé. Il s'agit de la dernière chose qui est appelée dans la classe pendant le déchargement.

Lorsque vous créez un projet au niveau du document, Visual Studio Tools pour Office crée des gestionnaires d'événements pour l'événement Shutdown dans les fichiers de code générés :

  • Pour les projets Microsoft Office Word, le gestionnaire d'événements s'appelle ThisDocument_Shutdown.

  • Pour les projets Microsoft Office Excel, les gestionnaires d'événements portent les noms suivants :

    • Sheet1_Shutdown

    • Sheet2_Shutdown

    • Sheet3_Shutdown

    • ThisWorkbook_Shutdown

Remarque :

Ne supprimez pas les contrôles par programme lorsque le gestionnaire d'événements Shutdown du document est actif. Les éléments d'interface du document ne sont plus disponibles lorsque l'événement Shutdown se produit. Pour supprimer les contrôles avant la fermeture de l'application, ajoutez votre code à un autre gestionnaire d'événements tel que BeforeClose ou BeforeSave.

Déclarations de méthode de gestionnaire d'événements

Les mêmes arguments sont passés aux déclarations de méthode de gestionnaire d'événements : sender et e. Dans Excel, l'argument sender fait référence à la feuille, par exemple Sheet1 ou Sheet2 ; dans Word, l'argument sender fait référence au document. L'argument e fait référence aux arguments standard d'un événement, qui ne sont pas utilisés dans ce cas.

L'exemple de code suivant affiche les gestionnaires d'événements par défaut des projets au niveau du document pour 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)
{
}

L'exemple de code suivant affiche les gestionnaires d'événements par défaut des projets au niveau du document pour Excel.

Remarque :

L'exemple de code suivant affiche les gestionnaires d'événements dans la classe Sheet1. Les noms des gestionnaires d'événements des autres classes d'élément hôte correspondent au nom de la classe. Par exemple, le gestionnaire d'événements Startup s'appelle Sheet2_Startup dans la classe Sheet2. Le gestionnaire d'événements Startup est appelé ThisWorkbook_Startup dans la classe ThisWorkbook.

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

Compléments au niveau de l'application

Visual Studio Tools pour Office fournit du code généré dans les compléments au niveau de l'application. Ce code déclenche deux événements différents : Startup et Shutdown.

Événement Startup

L'événement Startup est déclenché une fois que le complément est chargé et que tout le code d'initialisation de l'assembly a été exécuté. Cet événement est géré par la méthode ThisAddIn_Startup dans le fichier de code généré.

Le code du gestionnaire d'événements ThisAddIn_Startup est le premier code utilisateur à être exécuté, sauf si votre complément se substitue à la méthode RequestComAddInAutomationService. Dans ce cas, le gestionnaire d'événements ThisAddIn_Startup est appelé après RequestComAddInAutomationService. Dans les compléments destinés à la version 2007 de Microsoft Office System, le code gestionnaire d'événements ThisAddIn_Startup peut également être appelé après la méthode RequestService, si votre complément se substitue à cette méthode.

Pour plus d'informations sur la séquence de démarrage des compléments, consultez Architecture des compléments d'application.

Événement Shutdown

L'événement Shutdown est déclenché lorsque le domaine d'application dans lequel votre code est chargé est sur le point d'être déchargé. Cet événement est géré par la méthode ThisAddIn_Shutdown dans le fichier de code généré. Ce gestionnaire d'événements est le dernier code utilisateur à être exécuté lorsque le complément est déchargé.

Voir aussi

Tâches

Comment : créer des projets Visual Studio Tools pour Office

Concepts

Développement de solutions Office

Programmation de personnalisations au niveau du document

Programmation de compléments d'application

Vue d'ensemble des modèles de projet Visual Studio Tools pour Office