Procédure pas à pas : Créer votre première personnalisation au niveau du document pour WordWalkthrough: Create your first document-level customization for Word

Cette procédure pas à pas d'introduction vous indique comment créer une personnalisation au niveau du document pour Microsoft Office Word.This introductory walkthrough shows you how to create a document-level customization for Microsoft Office Word. Les fonctionnalités que vous créez dans ce genre de solution sont disponibles uniquement quand un document spécifique est ouvert.The features that you create in this kind of solution are available only when a specific document is open. Vous ne pouvez pas utiliser une personnalisation au niveau du document pour apporter des apporter de modifications au niveau de l'application, comme afficher un nouvel onglet de ruban quand un document est ouvert.You cannot use a document-level customization to make application-wide changes, for example, displaying a new Ribbon tab when any document is open.

S’applique à : Les informations contenues dans cette rubrique s’appliquent aux projets de niveau document pour Word.Applies to: The information in this topic applies to document-level 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 document Word.Creating a Word document project.

  • Ajout de texte au document hébergé dans le concepteur Visual Studio.Adding text to the document that is hosted in the Visual Studio designer.

  • Écriture de code qui utilise le modèle objet de Word pour ajouter du texte au document personnalisé lorsqu'il est ouvert.Writing code that uses the object model of Word to add text to the customized document when it is opened.

  • Génération et exécution du projet pour le testerBuilding and running the project to test it.

  • Nettoyage du projet pour supprimer les fichiers de build inutiles et les paramètres de sécurité de votre ordinateur de développement.Cleaning up the project to remove unnecessary build files and security settings from 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 document Word dans Visual StudioTo create a new Word document 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 document VSTO Word.In the list of project templates, select a Word VSTO document project .

  6. Dans le nom , tapez FirstDocumentCustomization.In the Name box, type FirstDocumentCustomization.

  7. Cliquez sur OK.Click OK.

    L' Assistant Projet Visual Studio Tools pour Office s'ouvre.The Visual Studio Tools for Office Project Wizard opens.

  8. Sélectionnez créer un nouveau document, puis cliquez sur OK.Select Create a new document, and click OK.

    Visual StudioVisual Studio crée le FirstDocumentCustomization de projet et ajoute le FirstDocumentCustomization document et le fichier de code ThisDocument au projet. creates the FirstDocumentCustomization project, and adds the FirstDocumentCustomization document and ThisDocument code file to the project. Le FirstDocumentCustomization document est ouvert automatiquement dans le concepteur.The FirstDocumentCustomization document is opened automatically in the designer.

Fermez et rouvrez le document dans le ConcepteurClose and reopen the document in the designer

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.If you deliberately or accidentally close the document in the designer while you are developing your project, you can reopen it.

Pour fermer et rouvrir le document dans le concepteurTo close and reopen the document in the designer

  1. Fermez le document en cliquant sur le fermer bouton (X) de la fenêtre du concepteur.Close the document by clicking the Close button (X) for the designer window.

  2. Dans l’Explorateur de solutions, avec le bouton droit le ThisDocument fichier de code, puis cliquez sur Concepteur de vues.In Solution Explorer, right-click the ThisDocument code file, and click View Designer.

    - ou -- or -

    Dans l’Explorateur de solutions, double-cliquez sur le ThisDocument fichier de code.In Solution Explorer, double-click the ThisDocument code file.

Ajouter du texte au document dans le ConcepteurAdd text to the document in the designer

Vous pouvez concevoir l'interface utilisateur de votre personnalisation en modifiant le document qui est ouvert dans le concepteur.You can design the user interface (UI) of your customization by modifying the document that is open in the designer. Par exemple, vous pouvez ajouter du texte, des tableaux ou des contrôles Word.For example, you can add text, tables, or Word controls. Pour plus d’informations sur l’utilisation du concepteur, consultez les projets Office dans l’environnement Visual Studio.For more information about how to use the designer, see Office projects in the Visual Studio environment.

Pour ajouter du texte à votre document à l'aide du concepteurTo add text to your document by using the designer

  1. Dans le document ouvert dans le concepteur, tapez le texte suivant.In the document that is open in the designer, type the following text.

    Ce texte a été ajouté à l’aide du concepteur.This text was added by using the designer.

Ajouter du texte au document par programmationAdd text to the document programmatically

L'étape suivante consiste à ajouter du code dans le fichier ThisDocument.Next, add code to the ThisDocument code file. Le nouveau code utilise le modèle objet de Word pour ajouter un deuxième paragraphe de texte au document.The new code uses the object model of Word to add a second paragraph of text to the document. Par défaut, le fichier de code ThisDocument contient le code généré suivant :By default, the ThisDocument code file contains the following generated code:

  • Une définition partielle de la classe ThisDocument, qui représente le modèle de programmation du document et permet d'accéder au modèle objet de Word.A partial definition of the ThisDocument class, which represents the programming model of the document and provides access to the object model of Word. Pour plus d’informations, consultez élément hôte de Document et vue d’ensemble du modèle d’objet Word.For more information, see Document host item and Word object model overview. Le reste de la classe ThisDocument est défini dans un fichier de code masqué que vous ne devez pas modifier.The remainder of the ThisDocument class is defined in a hidden code file that you should not modify.

  • Les gestionnaires d'événements ThisDocument_Startup et ThisDocument_Shutdown.The ThisDocument_Startup and ThisDocument_Shutdown event handlers. Ces gestionnaires d'événements sont appelés à l'ouverture et à la fermeture du document.These event handlers are called when the document is opened and closed. 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.Use these event handlers to initialize your customization when the document is opened, and to clean up resources used by your customization when the document is closed. Pour plus d’informations, consultez événements dans les projets Office.For more information, see Events in Office projects.

Pour ajouter un deuxième paragraphe de texte au document à l'aide de codeTo add a second paragraph of text to the document by using code

  1. Dans l’Explorateur de solutions, avec le bouton droit ThisDocument, puis cliquez sur afficher le Code.In Solution Explorer, right-click ThisDocument, and then click View Code.

    Le fichier de code s'ouvre dans Visual Studio.The code file opens in Visual Studio.

  2. Remplacez le gestionnaire d'événements ThisDocument_Startup par le code suivant.Replace the ThisDocument_Startup event handler with the following code. Lorsque le document s'ouvre, ce code ajoute un deuxième paragraphe de texte au document.When the document is opened, this code adds a second paragraph of text to the 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.";
    }
    

    Note

    Ce code utilise la valeur d'index 1 pour accéder au premier paragraphe de la propriété Paragraphs.This code uses the index value 1 to access the first paragraph in the Paragraphs property. 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.

Le projet de testTest the project

Pour tester votre documentTo test your document

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

    Lorsque vous générez le projet, le code est compilé dans un assembly qui est associé au document.When you build the project, the code is compiled into an assembly that is associated with the 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é sur l’ordinateur de développement pour permettre l’exécution de la personnalisation.Visual Studio puts a copy of the document and the assembly in the build output folder for the project, and it configures the security settings on the development computer to enable the customization to run. Pour plus d’informations, consultez solutions Office Build.For more information, see Build Office solutions.

  2. Dans le document, vérifiez que vous voyez le texte suivant.In the document, verify that you see the following text.

    Ce texte a été ajouté à l’aide du concepteur.This text was added by using the designer.

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

  3. Fermez le document.Close the document.

Nettoyer le projetClean up the project

Une fois que vous avez fini de développer un projet, vous devez supprimer les fichiers du dossier de sortie de génération et les paramètres de sécurité créés par le processus de génération.When you finish developing a project, you should remove the files in the build output folder and the security settings created by the build process.

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éé une personnalisation de base au niveau du document pour Word, vous pouvez en apprendre plus sur la manière de développer des personnalisations dans les rubriques suivantes :Now that you have created a basic document-level customization for Word, you can learn more about how to develop customizations 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 personnalisations au niveau du document Program document-level customizations
Vue d’ensemble du modèle d’objet Word Word object model overview
Automatiser Word à l’aide d’objets étendus Automate Word by using extended objects
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