Procédure pas à pas : création de votre premier complément d'application pour Word
Mise à jour : Juillet 2008
S'applique à |
---|
Les informations de cette rubrique s'appliquent uniquement aux projets Visual Studio Tools pour Office et versions de Microsoft Office spécifiés. Type de projet
Version de Microsoft Office
Pour plus d'informations, consultez Fonctionnalités disponibles par type d'application et de projet. |
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.
Cette procédure pas à pas décrit les tâches suivantes :
Création d'un projet de complément pour Word 2003 ou Word 2007
É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 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 :
Visual Studio Tools pour Office (un composant facultatif de Visual Studio 2008 Professional et Visual Studio Team System).
Word 2003 ou Word 2007.
Par défaut, Visual Studio Tools pour Office est installé avec les versions répertoriées de Visual Studio. Pour vérifier s'il est installé sur votre ordinateur, consultez Installation de Visual Studio Tools pour Office.
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 Types de projets, développez Visual C# ou Visual Basic, puis Office.
Sélectionnez le dossier 2007 si vous développez un complément Word 2007 ou 2003 pour un complément Word 2003.
Dans le volet Modèles, sélectionnez Complément Word 2003 ou Complément Word 2007.
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 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 Élément hôte AddIn. 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 de projet Visual Studio Tools pour Office.
Pour ajouter un paragraphe de texte au document enregistré
Dans le fichier de code ThisAddIn, insérez le code suivant dans 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 inférieures d'index de tableau de la plupart des collections dans le modèle objet Word sont de 1. Pour plus d'informations, consultez Comparaison de la programmation avec Visual Basic et avec C#.
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 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 Vue d'ensemble du processus de 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 de 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 celui-ci terminé
- Sous 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 : Développement d'un complément d'application pour 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 et débogage de solutions Office.
Déploiement de compléments d'application pour Word : Déploiement de solutions Office.
Voir aussi
Concepts
Vue d'ensemble du développement des solutions Office
Développement d'un complément d'application pour Word
Programmation de compléments d'application
Vue d'ensemble du modèle objet Word
Personnalisation de l'interface utilisateur Office
Vue d'ensemble des modèles de projet Visual Studio Tools pour Office
Référence
Modèles de projet de complément Microsoft Office 2003
Modèles de projet de complément Microsoft Office 2007
Autres ressources
Génération et débogage de solutions Office
Déploiement de solutions Office
Historique des modifications
Date |
Historique |
Raison |
---|---|---|
Juillet 2008 |
Ajout d'une rubrique. |
Améliorations apportées aux informations. |