Procédure pas à pas : création de votre premier complément d'application pour Word

Article
03/04/2013

Cette première procédure pas à pas vous indique comment créer un complément d'application pour Microsoft Office Word.Les fonctionnalités créées dans ce type de solution sont disponibles pour l'application, quels que soient les documents ouverts.

S'applique à : Les informations contenues dans cette rubrique s'appliquent aux projets de niveau application pour Word 2013 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 complément Word
Écriture d'un code utilisant le modèle objet de Word pour ajouter du texte à un document lorsqu'il est enregistré
Génération et exécution du projet pour le tester
Nettoyage du projet terminé afin que le complément ne s'exécute plus automatiquement sur votre ordinateur de développement.

[!REMARQUE]

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 2012 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.110\).md).

Word 2013 ou Word 2010.

Création du projet

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

Démarrez Visual Studio.
Dans le menu Fichier, pointez sur Nouveau, puis cliquez sur Projet.
Dans le volet modèles, développez Visual C# ou Visual Basic, puis développez Office/SharePoint.
Sous le nœud développé Office/SharePoint , sélectionnez le nœud Les compléments Office .
Dans la liste de modèles de projet, sélectionnez Complément Word 2010 ou Complément Word 2013.
Dans la zone Nom, tapez FirstWordAddIn.
Cliquez sur OK.

Visual Studio crée le projet FirstWordAddIn et ouvre le fichier de code ThisAddIn dans l'éditeur.

Écriture de code pour ajouter du texte dans le document enregistré

L'étape suivante consiste à ajouter du code dans le fichier de code ThisAddIn.Le nouveau code utilise le modèle objet de Word pour ajouter du texte réutilisable à chaque document enregistré.Par défaut, le fichier de code ThisAddIn contient le code généré suivant :

Une définition partielle de la classe ThisAddIn.Cette classe fournit un point d'entrée pour votre code et offre un accès au modèle objet de Word.Pour plus d’informations, consultez Programmation de compléments d'application.Le reste de la classe ThisAddIn est défini dans un fichier de code masqué que vous ne devez pas modifier.
Les gestionnaires d'événements ThisAddIn_Startup et ThisAddIn_Shutdown.Ces gestionnaires d'événements sont appelés lorsque Word charge et décharge votre complément.Utilisez ces gestionnaires d'événements pour initialiser votre complément lorsqu'il est chargé et pour nettoyer les ressources utilisées par votre complément lorsqu'il est déchargé.Pour plus d’informations, consultez Événements dans les projets Office.

Pour ajouter un paragraphe de texte au document enregistré

Dans le fichier de code ThisAddIn, ajoutez le code suivant à la classe ThisAddIn.Le nouveau code définit un gestionnaire d'événements pour l'événement DocumentBeforeSave, déclenché lorsqu'un document est enregistré.

Lorsque l'utilisateur enregistre un document, le gestionnaire d'événements ajoute le nouveau texte au début de celui-ci.
```
Private Sub Application_DocumentBeforeSave(ByVal Doc As Word.Document, ByRef SaveAsUI As Boolean, _
    ByRef Cancel As Boolean) Handles Application.DocumentBeforeSave
    Doc.Paragraphs(1).Range.InsertParagraphBefore()
    Doc.Paragraphs(1).Range.Text = "This text was added by using code."
End Sub
```
```
void Application_DocumentBeforeSave(Word.Document Doc, ref bool SaveAsUI, ref bool Cancel)
{
    Doc.Paragraphs[1].Range.InsertParagraphBefore();
    Doc.Paragraphs[1].Range.Text = "This text was added by using code.";
}
```
[!REMARQUE]

Ce code utilise une valeur d'index de 1 pour accéder au premier paragraphe de la collection 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 Écriture de code dans les solutions Office.
Si vous utilisez C#, ajoutez le code requis suivant au gestionnaire d'événements ThisAddIn_Startup.Ce code est utilisé pour connecter le gestionnaire d'événements Application_DocumentBeforeSave à l'événement DocumentBeforeSave.
```
this.Application.DocumentBeforeSave += 
    new Word.ApplicationEvents4_DocumentBeforeSaveEventHandler(Application_DocumentBeforeSave);
```

Pour modifier le document lorsqu'il est enregistré, les exemples de code précédents utilisent les objets suivants :

Le champ Application de la classe ThisAddIn.Le champ Application renvoie un objet Microsoft.Office.Interop.Word.Application, qui représente l'instance actuelle de Word.
Le paramètre Doc du gestionnaire d'événements pour l'événement DocumentBeforeSave.Le paramètre Doc est un objet Microsoft.Office.Interop.Word.Document, qui représente le document enregistré.Pour plus d’informations, consultez Vue d'ensemble du modèle objet Word.

Test du projet

Pour tester le projet

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 qui est inclus dans le dossier de sortie correspondant.Visual Studio crée également un jeu d'entrées du Registre qui permet à Word de découvrir et de charger le complément, et il configure les paramètres de sécurité de l'ordinateur de développement pour permettre au complément de s'exécuter.Pour plus d’informations, consultez Génération de solutions Office.
Dans Word, enregistrez le document actif.
Vérifiez que le texte suivant a été ajouté au document.

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

Nettoyage du projet

Lorsque vous avez terminé de développer un projet, supprimez l'assembly de complément, les entrées du Registre et les paramètres de sécurité de votre ordinateur de développement.Sinon, le complément s'exécutera à chaque fois que vous ouvrirez Word sur votre ordinateur de développement.

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

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

Étapes suivantes

Maintenant que vous avez créé un complément d'application de base pour Word, vous pouvez en apprendre davantage sur la manière de développer des compléments dans ces rubriques :

Tâches de programmation générales que vous pouvez effectuer dans les compléments : Programmation de compléments d'application.
Tâches de programmation propres aux compléments 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 en ajoutant un onglet personnalisé au Ruban ou en créant votre propre volet de tâches personnalisé : Personnalisation de l'interface utilisateur Office.
Génération et débogage des compléments d'application pour Word : Génération de solutions Office.
Déploiement de compléments d'application pour Word : Déploiement d'une solution Office.