Procédure pas à pas : Créer votre premier complément pour WordWalkthrough: Create your first VSTO Add-in for Word

Cette première procédure pas à pas montre comment créer un complément VSTO pour Microsoft Office Word.This introductory walkthrough shows you how to create a VSTO Add-in for 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.The features that you create in this kind of solution are available to the application itself, regardless of which documents are open.

S’applique à : les informations contenues dans cette rubrique s’applique à VSTO ajouter-dans les projets pour Word.Applies to: The information in this topic applies to VSTO Add-in projects for Word. Pour plus d’informations, consultez fonctionnalités disponibles par type d’application et de projet Office.For more information, see Features available by Office application and project type.

Cette procédure pas à pas décrit les tâches suivantes :This walkthrough illustrates the following tasks:

  • Création d'un projet de complément VSTO WordCreating a Word VSTO Add-in project.

  • Écriture d'un code qui utilise le modèle objet de Word pour ajouter du texte à un document quand il est enregistréWriting code that uses the object model of Word to add text to a document when it is saved.

  • Génération et exécution du projet à des fins de testBuilding and running the project to test it.

  • Nettoyage du projet terminé, pour que le complément VSTO ne s’exécute plus automatiquement sur votre ordinateur de développementCleaning up the completed project so that the VSTO Add-in no longer runs automatically on your development computer.

    Note

    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.Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. L’édition de Visual Studio dont vous disposez et les paramètres que vous utilisez déterminent ces éléments.The Visual Studio edition that you have and the settings that you use determine these elements. Pour plus d’informations, consultez personnaliser l’IDE.For more information, see Personalize the IDE.

PrérequisPrerequisites

Pour exécuter cette procédure pas à pas, vous devez disposer des composants suivants :You need the following components to complete this walkthrough:

Créer le projetCreate the project

Pour créer un projet de complément VSTO Word dans Visual StudioTo create a new Word VSTO Add-in project in Visual Studio

  1. Démarrez Visual StudioVisual Studio.Start Visual StudioVisual Studio.

  2. Dans le menu Fichier , pointez sur Nouveau, puis cliquez sur Projet.On the File menu, point to New, and then click Project.

  3. Dans le volet Modèles, développez Visual C# ou Visual Basic, puis développez Office/SharePoint.In the templates pane, expand Visual C# or Visual Basic, and then expand Office/SharePoint.

  4. Sous le nœud développé Office/SharePoint , sélectionnez le nœud Compléments Office .Under the expanded Office/SharePoint node, select the Office Add-ins node.

  5. Dans la liste des modèles de projet, sélectionnez un projet de complément VSTO Word.In the list of project templates, select a Word VSTO Add-in project.

  6. Dans le nom , tapez Premiercomplémentexcel.In the Name box, type FirstWordAddIn.

  7. Cliquez sur OK.Click OK.

    Visual StudioVisual Studio crée le Premiercomplémentexcel de projet et ouvre le fichier de code ThisAddIn dans l’éditeur. creates the FirstWordAddIn project and opens the ThisAddIn code file in the editor.

Écrire du code pour ajouter du texte au document enregistréWrite code to add text to the saved document

L'étape suivante consiste à ajouter du code au fichier de code ThisAddIn.Next, add code to the ThisAddIn code file. Le nouveau code utilise le modèle objet de Word pour ajouter du texte réutilisable dans chaque document enregistré.The new code uses the object model of Word to add boilerplate text to each saved document. Par défaut, le fichier de code ThisAddIn contient le code généré suivant :By default, the ThisAddIn code file contains the following generated code:

  • Une définition partielle de la classe ThisAddIn .A partial definition of the ThisAddIn class. Cette classe fournit un point d'entrée pour votre code et offre un accès au modèle objet de Word.This class provides an entry point for your code and provides access to the object model of Word. Pour plus d’informations, consultez programme VSTO Add-ins. Le reste de la classe ThisAddIn est défini dans un fichier de code masqué que vous ne devez pas modifier.For more information, see Program VSTO Add-ins. The remainder of the ThisAddIn class is defined in a hidden code file that you should not modify.

  • Les gestionnaires d'événements ThisAddIn_Startup et ThisAddIn_Shutdown .The ThisAddIn_Startup and ThisAddIn_Shutdown event handlers. Ces gestionnaires d'événements sont appelés quand Word charge et décharge votre complément VSTO.These event handlers are called when Word loads and unloads your VSTO Add-in. 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é.Use these event handlers to initialize your VSTO Add-in when it is loaded, and to clean up resources used by your VSTO Add-in when it is unloaded. Pour plus d’informations, consultez événements dans les projets Office.For more information, see Events in Office projects.

Pour ajouter un paragraphe de texte au document enregistréTo add a paragraph of text to the saved document

  1. Dans le fichier de code ThisAddIn, ajoutez le code suivant à la classe ThisAddIn .In the ThisAddIn code file, add the following code to the ThisAddIn class. Le nouveau code définit un gestionnaire d'événements pour l'événement DocumentBeforeSave, qui est déclenché quand un document est enregistré.The new code defines an event handler for the DocumentBeforeSave event, which is raised when a document is saved.

    Quand l'utilisateur enregistre un document, le gestionnaire d'événements ajoute le nouveau texte au début du document.When the user saves a document, the event handler adds new text at the start of the document.

    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.";
    }
    

    Note

    Ce code utilise une valeur d'index 1 pour accéder au premier paragraphe de la collection Paragraphs.This code uses an index value of 1 to access the first paragraph in the Paragraphs collection. 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.Although Visual Basic and Visual C# use 0-based arrays, the lower array bounds of most collections in the Word object model is 1. Pour plus d’informations, consultez écrire du code dans les solutions Office.For more information, see Write code in Office solutions.

  2. Si vous utilisez C#, ajoutez le code requis suivant au gestionnaire d'événements ThisAddIn_Startup .If you are using C#, add the following required code to the ThisAddIn_Startup event handler. Ce code permet de connecter le gestionnaire d'événements Application_DocumentBeforeSave à l'événement DocumentBeforeSave.This code is used to connect the Application_DocumentBeforeSave event handler with the DocumentBeforeSave event.

    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 :To modify the document when it is saved, the previous code examples use the following objects:

  • Le champ Application de la classe ThisAddIn.The Application field of the ThisAddIn class. Le champ Application retourne un objet Application, qui représente l'instance actuelle de Word.The Application field returns a Application object, which represents the current instance of Word.

  • Le paramètre Doc du gestionnaire d'événements pour l'événement DocumentBeforeSave.The Doc parameter of the event handler for the DocumentBeforeSave event. Le paramètre Doc est un objet Document qui représente le document enregistré.The Doc parameter is a Document object, which represents the saved document. Pour plus d’informations, consultez vue d’ensemble du modèle d’objet Word.For more information, see Word object model overview.

Le projet de testTest the project

Pour tester le projetTo test the project

  1. Appuyez sur F5 pour générer et exécuter votre projet.Press F5 to build and run your project.

    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.When you build the project, the code is compiled into an assembly that is included in the build output folder for the project. 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.Visual Studio also creates a set of registry entries that enable Word to discover and load the VSTO Add-in, and it configures the security settings on the development computer to enable the VSTO Add-in to run. Pour plus d’informations, consultez solutions Office Build.For more information, see Build Office solutions.

  2. Dans Word, enregistrez le document actif.In Word, save the active document.

  3. Vérifiez que le texte suivant est ajouté au document.Verify that the following text is added to the document.

    Ce texte a été ajouté via le code.This text was added by using code.

  4. Fermez Word.Close Word.

Nettoyer le projetClean up the project

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.When you finish developing a project, remove the VSTO Add-in assembly, registry entries, and security settings from your development computer. Sinon, le complément VSTO s'exécutera chaque fois que vous ouvrirez Word sur votre ordinateur de développement.Otherwise, the VSTO Add-in will continue to run every time that you open Word on your development computer.

Pour nettoyer le projet terminé sur votre ordinateur de développementTo clean up the completed project on your development computer

  1. Dans Visual Studio, dans le menu Générer , cliquez sur Nettoyer la solution.In Visual Studio, on the Build menu, click Clean Solution.

Étapes suivantesNext steps

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 :Now that you have created a basic VSTO Add-in for Word, you can learn more about how to develop VSTO Add-ins from these topics:

Voir aussiSee also

Vue d’ensemble du développement de solutions Office (VSTO) Office solutions development overview (VSTO)
Solutions Word Word solutions
Programmer des Compléments VSTO Program VSTO Add-ins
Vue d’ensemble du modèle d’objet Word Word object model overview
Personnalisation de l’interface utilisateur Office Office UI customization
Générer des solutions Office Build Office solutions
Déployer une solution Office Deploy an Office solution
Vue d’ensemble des modèles de projet OfficeOffice project templates overview