Élément hôte de classeur

L’élément hôte Workbook est un type qui étend le type Workbook à partir de l’assembly PIA (Primary Interop Assembly) pour Excel. L’élément hôte Workbook fournit les mêmes propriétés, méthodes et événements qu’un objet Workbook , mais il offre également d’autres fonctionnalités.

S’applique à : les informations contenues dans cette rubrique s’appliquent aux projets au niveau du document et aux projets de complément VSTO pour Excel. Pour plus d’informations, consultez Fonctionnalités disponibles par application Office lication et le type de projet.

Dans les projets au niveau du document se trouve un élément hôte Workbook par défaut qui représente le classeur dans votre projet. Dans les projets de compléments VSTO, vous pouvez générer des éléments hôtes Workbook au moment de l'exécution.

Comprendre l’élément hôte du classeur dans les projets au niveau du document

Pour accéder au classeur dans votre projet, utilisez la classe ThisWorkbook . La classe ThisWorkbook vous permet d’accéder aux membres de l’élément hôte Workbook pour effectuer des tâches de base dans votre personnalisation, comme l’exécution de code à l’ouverture ou la fermeture du classeur. Pour plus d’informations, consultez Les personnalisations au niveau du document du programme.

La classe ThisWorkbook fournit un emplacement dans lequel vous pouvez commencer à écrire du code dans votre projet. Étant donné que la classe fournit les mêmes propriétés, méthodes et événements que l’objet Workbook dans l’assembly PIA pour Excel, vous pouvez aussi utiliser ThisWorkbook pour accéder au modèle objet d’Excel. Pour plus d’informations, consultez vue d’ensemble du modèle objet Excel.

Double-cliquez sur l’élément de projet ThisWorkbook dans l’ Explorateur de solutions pour afficher le Concepteur de classeurs et afficher les propriétés et événements du classeur dans la fenêtre Propriétés .

Limitations de l’élément hôte du classeur dans les projets au niveau du document

Un projet au niveau du document peut contenir un seul élément hôte Workbook (autrement dit, la classe ThisWorkbook ). Vous ne pouvez pas ajouter de nouveaux éléments hôtes Workbook à votre projet au moment du design. Vous ne pouvez pas non plus créer des éléments hôtes Workbook au moment de l’exécution à partir d’une personnalisation au niveau du document.

Si vous créez un classeur Excel au moment de l’exécution, son type est Workbook. Comme il ne s’agit pas d’un élément hôte, il ne peut pas contenir de contrôles hôtes ni de contrôles Windows Forms. Pour plus d’informations sur la création de classeurs au moment de l’exécution, consultez Guide pratique pour créer des classeurs par programmation.

L’élément hôte Workbook n’agit pas comme un conteneur pour les contrôles hôtes. Ainsi, vous ne pouvez pas ajouter de contrôles visibles au classeur, mais vous pouvez ajouter des composants, comme DataSet, pour pouvoir les partager dans toutes les feuilles de calcul. Dans un projet au niveau du document, les composants disponibles pour le classeur se trouvent sous les onglets Composant , Données et Tous les Windows Forms de la Boîte à outils.

Remarque

Les outils de développement Office dans Visual Studio ne prennent pas en charge les classeurs partagés.

Comprendre les éléments hôtes de classeur dans les projets de complément VSTO

Dans les projets complément VSTO, vous pouvez générer un élément hôte Workbook au moment de l’exécution pour tout classeur ouvert dans Excel. Pour générer un élément hôte Workbook, utilisez la méthode GetVstoObject. Pour plus d’informations, consultez Étendre les documents Word et les classeurs Excel dans les compléments VSTO au moment de l’exécution.