Élément hôte de document

L’élément hôte Document est un type qui étend le type Document à partir de l’assembly PIA (Primary Interop Assembly) de Word. L’élément hôte Document fournit les mêmes propriétés, méthodes et événements qu’un objet Document , mais il expose également des événements supplémentaires et agit comme conteneur pour les contrôles hôtes et les contrôles Windows Forms.

S’applique à : les informations contenues dans cette rubrique s’appliquent aux projets au niveau du document et aux projets de complément VSTO pour Word. 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 Document par défaut qui représente le document dans votre projet. Dans les projets de compléments VSTO, vous pouvez générer des éléments hôtes Document au moment de l'exécution.

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

Pour accéder au document dans votre projet, utilisez la classe ThisDocument . Lorsque vous créez un projet au niveau du document, Visual Studio génère la classe ThisDocument pour servir de liaison entre Word et votre code de personnalisation. La classe ThisDocument vous permet d’accéder aux membres de l’élément hôte Document pour effectuer des tâches de base dans votre personnalisation, comme l’exécution de code à l’ouverture ou la fermeture du document. Vous pouvez aussi utiliser la classe pour ajouter des contrôles au document. En combinant plusieurs jeux de contrôles et en écrivant du code, vous pouvez lier les contrôles à des données, recueillir des informations de l’utilisateur et répondre à des actions utilisateur. Pour plus d’informations, consultez Les personnalisations au niveau du document du programme.

La classe ThisDocument 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 Document dans l’assembly PIA pour Word, vous pouvez aussi utiliser ThisDocument pour accéder au modèle objet de Word. Pour plus d’informations, consultez la vue d’ensemble du modèle objet Word.

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

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

Si vous créez un document Word au moment de l’exécution, il sera de type Document. 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 documents au moment de l’exécution, consultez Guide pratique pour créer des documents par programmation.

Comprendre les éléments hôtes de document dans les projets au niveau de l’application

Dans les projets complément VSTO, vous pouvez générer un élément hôte Document au moment de l’exécution pour tout document ouvert dans Word. Vous pouvez utiliser l’élément hôte Document pour ajouter des contrôles au document associé ou pour gérer des événements qui ne sont pas disponibles sur des objets Document .

Pour générer un élément hôte Document, 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.