Procédure pas à pas : création de votre première personnalisation au niveau du document pour Word

Article
08/10/2011

Cette première procédure pas à pas vous indique comment créer une personnalisation au niveau du document pour Microsoft Office Word. Les fonctionnalités créées dans ce type de solution ne sont disponibles que lorsqu'un document spécifique est ouvert. Vous ne pouvez pas utiliser de personnalisation au niveau du document pour apporter des modifications à l'échelle de l'application, comme afficher un nouvel onglet Ruban lorsqu'un document est ouvert.

S'applique à : Les informations contenues dans cette rubrique s'appliquent aux projets de niveau document pour Word 2007 et Word 2010. Pour en savoir plus, consultez Fonctionnalités disponibles par type d'application et de projet Office.

Cette procédure pas à pas décrit les tâches suivantes :

Création d'un projet de document Word
Ajout de texte au document hébergé dans le concepteur Visual Studio
Rédaction de code qui utilise le modèle objet de Word pour ajouter du texte au document personnalisé lorsqu'il est ouvert
Génération et exécution du projet pour le tester
Nettoyage du projet pour supprimer des fichiers de génération inutiles et des paramètres de sécurité de votre ordinateur de développement

Notes

Il est possible que votre ordinateur affiche des noms ou des emplacements différents pour certains des éléments d'interface utilisateur de Visual Studio dans les instructions suivantes. L'édition de Visual Studio dont vous disposez et les paramètres que vous utilisez déterminent ces éléments. Pour plus d'informations, consultez Paramètres Visual Studio.

Composants requis

Pour exécuter cette procédure pas à pas, vous devez disposer des composants suivants :

Une édition de Visual Studio 2010 qui inclut les outils de développement Microsoft Office. Pour plus d'informations, consultez [Configuration d'un ordinateur pour développer des solutions Office](bb398242\(v=vs.100\).md).

Word 2007 ou Word 2010.

Création du projet

Pour créer un projet de document Word dans Visual Studio

Démarrez Visual Studio.
Dans le menu Fichier, pointez sur Nouveau, puis cliquez sur Projet.
Dans le volet de modèles, développez Visual C# ou Visual Basic, puis développez Office.
Sous le nœud Office développé, sélectionnez 2007 si Word 2007 est installé sur votre ordinateur ou le nœud 2010 si vous avez Word 2010.
Dans la liste de modèles de projet, sélectionnez Document Word 2007 ou Document Word 2010.
Dans la zone Nom, tapez FirstDocumentCustomization.
Cliquez sur OK.

L'Assistant Projet Visual Studio Tools pour Office s'ouvre.
Sélectionnez Créer un nouveau document, puis cliquez sur OK.

Visual Studio crée le projet FirstDocumentCustomization et ajoute le document FirstDocumentCustomization et le fichier de code ThisDocument au projet. Le document FirstDocumentCustomization est ouvert automatiquement dans le concepteur.

Fermeture et réouverture du document dans le concepteur

Si vous fermez délibérément ou accidentellement le document dans le concepteur pendant que vous développez votre projet, vous pouvez le rouvrir.

Pour fermer et rouvrir le document dans le concepteur

Fermez le document en cliquant sur le bouton Fermer (X) de la fenêtre du concepteur.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le fichier de code ThisDocument, puis cliquez sur Concepteur de vues.

- ou -

Dans l'Explorateur de solutions, double-cliquez sur le fichier de code ThisDocument.

Ajout de texte au document dans le concepteur

Vous pouvez concevoir l'interface utilisateur de votre personnalisation en modifiant le document qui est ouvert dans le concepteur. Par exemple, vous pouvez ajouter du texte, des tables ou des contrôles Word. Pour plus d'informations sur l'utilisation du concepteur, consultez Projets Office dans l'environnement Visual Studio.

Pour ajouter du texte à votre document à l'aide du concepteur

Dans le document ouvert dans le concepteur, entrez le texte suivant.

Ce texte a été ajouté à l'aide du concepteur.

Ajout de texte au document par programmation

L'étape suivante consiste à ajouter du code dans le fichier ThisDocument. Le nouveau code utilise le modèle objet de Word pour ajouter un deuxième paragraphe de texte au document. Par défaut, le fichier de code ThisDocument contient le code généré suivant :

Une définition de la classe ThisDocument, qui représente le modèle de programmation du document et fournit un accès au modèle objet de Word. Pour plus d'informations, consultez Élément hôte de document et Vue d'ensemble du modèle objet Word. Le reste de la classe ThisDocument est défini dans un fichier de code masqué que vous ne devez pas modifier.
Les gestionnaires d'événements ThisDocument_Startup et ThisDocument_Shutdown. Ces gestionnaires d'événements sont appelés à l'ouverture et à la fermeture du document. Utilisez ces gestionnaires d'événements pour initialiser votre personnalisation à l'ouverture du document et pour nettoyer les ressources utilisées par votre personnalisation à la fermeture du document. Pour plus d'informations, consultez Événements dans les projets Office.

Pour ajouter un deuxième paragraphe de texte au document à l'aide de code

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ThisDocument, puis cliquez sur Afficher le code.

Le fichier de code s'ouvre dans Visual Studio.
Remplacez le gestionnaire d'événements ThisDocument_Startup par le code suivant. Lorsque le document s'ouvre, ce code ajoute un deuxième paragraphe de texte au document.
```
Private Sub ThisDocument_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
    Me.Paragraphs(1).Range.InsertParagraphAfter()
    Me.Paragraphs(2).Range.Text = "This text was added by using code."
End Sub
```
```
private void ThisDocument_Startup(object sender, System.EventArgs e)
{
    this.Paragraphs[1].Range.InsertParagraphAfter();
    this.Paragraphs[2].Range.Text = "This text was added by using code.";
}
```
Notes

Ce code utilise la valeur d'index 1 pour accéder au premier paragraphe de la propriété Paragraphs. Bien que Visual Basic et Visual C# utilisent des tableaux basés sur 0, les limites d'index de tableau inférieures de la plupart des collections du modèle objet Word possèdent la valeur 1. Pour plus d'informations, consultez Programmation avec Visual Basic et Visual C# dans les solutions Office.

Test du projet

Pour tester votre document

Appuyez sur F5 pour générer et exécuter votre projet.

Lorsque vous générez le projet, le code est compilé dans un assembly associé au document. Visual Studio place une copie du document et l'assembly dans le dossier de sortie de la génération du projet, et il configure les paramètres de sécurité de l'ordinateur de développement pour permettre l'exécution de la personnalisation. Pour plus d'informations, consultez Vue d'ensemble du processus de génération de solutions Office.
Dans le document, vérifiez que vous voyez le texte suivant.

Ce texte a été ajouté à l'aide du concepteur.

Ce texte a été ajouté en utilisant le code.
Fermez le document.

Nettoyage du projet

Lorsque vous avez terminé de développer un projet, vous devez supprimer les fichiers du dossier de sortie et les paramètres de sécurité créés par le processus de génération.

Pour nettoyer le projet de votre ordinateur de développement une fois celui-ci terminé

Sous Visual Studio, dans le menu Générer, cliquez sur Nettoyer la solution.

Étapes suivantes

Maintenant que vous avez créé une personnalisation au niveau de document de base pour Word, vous pouvez en apprendre davantage sur la manière de développer des personnalisations dans ces rubriques :

Tâches de programmation générales que vous pouvez effectuer dans les personnalisations au niveau du document : Programmation de personnalisations au niveau du document.
Tâches de programmation spécifiques aux personnalisations au niveau du document pour Word : Solutions Word.
Utilisation du modèle objet de Word : Vue d'ensemble du modèle objet Word.
Personnalisation de l'interface utilisateur de Word par l'ajout d'un onglet personnalisé au Ruban ou la création de votre propre volet d'actions : Personnalisation de l'interface utilisateur Office.
À l'aide d'objets Word étendus fournis par Visual Studio Tools pour Office pour effectuer des tâches qui ne sont pas possibles en utilisant le modèle objet Word (par exemple, héberger des contrôles managés sur des documents et lier des contrôles Word aux données en utilisant le modèle de liaison de données Windows Forms) : Automatisation de Word à l'aide d'objets étendus.
Génération et débogage des personnalisations au niveau du document pour Word : Génération et débogage de solutions Office.
Déploiement de personnalisations au niveau du document pour Word : Déploiement de solutions Office.