Procédure pas à pas : créer votre premier complément VSTO pour Word

  • Article

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

S’applique à : Les informations contenues dans cette rubrique s’appliquent 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.

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

  • Création d'un projet de complément VSTO Word

  • Écriture d'un code qui utilise le modèle objet de Word pour ajouter du texte à un document quand il est enregistré

  • Génération et exécution du projet pour le tester

  • Nettoyage du projet terminé, pour que le complément VSTO ne s’exécute plus automatiquement sur votre ordinateur de développement

    Remarque

    Il est possible que pour certains des éléments de l'interface utilisateur de Visual Studio, votre ordinateur affiche des noms ou des emplacements différents de ceux indiqués 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 Personnaliser l’IDE.

Prérequis

Vous devez disposer des éléments suivants pour exécuter cette procédure pas à pas :

Créer le projet

Pour créer un projet de complément VSTO Word dans Visual Studio

  1. Démarrez Visual Studio.

  2. Dans le menu Fichier , pointez sur Nouveau, puis cliquez sur Projet.

  3. Dans le volet Modèles, développez Visual C# ou Visual Basic, puis développez Office/SharePoint.

  4. Sous le nœud développé Office/SharePoint , sélectionnez le nœud Compléments Office .

  5. Dans la liste des modèles de projet, sélectionnez un projet de complément VSTO Word.

  6. Dans la zone Nom , tapez FirstWordAddIn.

  7. Cliquez sur OK.

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

Écrire du code pour ajouter du texte au document enregistré

L'étape suivante consiste à ajouter du code au fichier de code ThisAddIn. Le nouveau code utilise le modèle objet de Word pour ajouter du texte réutilisable dans 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 Les compléments VSTO program. Le reste de la ThisAddIn classe 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 quand Word charge et décharge votre complément VSTO. Utilisez ces gestionnaires d'événements pour initialiser votre complément VSTO quand il est chargé, ainsi que pour nettoyer les ressources utilisées par votre complément VSTO quand il est déchargé. Pour plus d’informations, consultez Événements dans Bureau projets.

Pour ajouter un paragraphe de texte au document enregistré

  1. 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, qui est déclenché quand un document est enregistré.

    Quand l'utilisateur enregistre un document, le gestionnaire d'événements ajoute le nouveau texte au début du document.

    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 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 ont la valeur 1. Pour plus d’informations, consultez Écrire du code dans Bureau solutions.

  2. Si vous utilisez C#, ajoutez le code requis suivant au gestionnaire d'événements ThisAddIn_Startup . Ce code permet de 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 quand il est enregistré, les exemples de code précédents utilisent les objets suivants :

  • Le champ Application de la classe ThisAddIn . Le champ Application retourne un objet 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 Document qui représente le document enregistré. Pour plus d’informations, consultez la vue d’ensemble du modèle objet Word.

Tester le projet

Pour tester le projet

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

    Quand vous générez le projet, le code est compilé dans un assembly qui est inclus dans le dossier de sortie de la génération du projet. Visual Studio crée également un jeu d’entrées du Registre qui permet à Word de détecter et de charger le complément VSTO, et il configure les paramètres de sécurité de l’ordinateur de développement pour permettre au complément VSTO de s’exécuter. Pour plus d’informations, consultez Générer des solutions Bureau.

  2. Dans Word, enregistrez le document actif.

  3. Vérifiez que le texte suivant est ajouté au document.

    Ce texte a été ajouté via le code.

  4. Fermez Word.

Nettoyer le projet

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

Pour nettoyer le projet terminé sur votre ordinateur de développement

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

Étapes suivantes

Maintenant que vous avez créé un complément VSTO de base pour Word, vous pouvez perfectionner votre connaissance du développement des compléments VSTO en consultant les rubriques suivantes :

  • Tâches de programmation générales que vous pouvez effectuer dans les compléments VSTO : Programmes de compléments VSTO.

  • Tâches de programmation spécifiques aux compléments VSTO 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 exemple, en ajoutant un onglet personnalisé au ruban ou en créant votre propre volet Office personnalisé : Bureau personnalisation de l’interface utilisateur.

  • Création et débogage de compléments VSTO pour Word : Créer des solutions Bureau.

  • Déploiement de compléments VSTO pour Word : Déployer une solution Bureau.

Contenu connexe