Share via

Procédure pas à pas : Créer votre première personnalisation au niveau du document pour Word

  • Article

Cette procédure pas à pas d'introduction vous indique comment créer une personnalisation au niveau du document pour 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. 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.

S’applique à : les informations de cette rubrique s’appliquent aux projets au niveau du document 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 document Word.

  • Ajout de texte au document hébergé dans le concepteur Visual Studio.

  • Écriture de code qui utilise le modèle objet de Word pour ajouter du texte au document personnalisé lorsqu'il est ouvert.

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

  • Nettoyage du projet pour supprimer les fichiers de build inutiles et les paramètres de sécurité de 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 document Word dans Visual Studio

  1. Démarrez Visual Studio.

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

  3. Dans la boîte de dialogue Créer un projet , sélectionnez le projet de document VSTO Word.

    Remarque

    Vous pouvez également rechercher des modèles en tapant le nom du produit Bureau dans la zone de texte Rechercher en haut de la boîte de dialogue Créer un projet. Par exemple, la saisie d’Excel affiche tous les modèles de projet pour Excel. Vous pouvez également filtrer la liste des modèles pour afficher uniquement les modèles pour Bureau en sélectionnant Bureau dans la zone de liste déroulante Type de projet. Pour plus d’informations, consultez Créer un projet dans Visual Studio.

  4. Sélectionnez Suivant.

  5. Tapez FirstWorkbookCustomization dans la zone Nom dans la boîte de dialogue Configurer votre nouveau projet , puis cliquez sur Créer.

  6. Sélectionnez Créer un document dans l’Assistant Projet Visual Studio Tools pour Office, puis cliquez sur OK.

    • Visual Studio crée le projet FirstDocumentCustomization et ajoute le document FirstDocumentCustomization et le fichier de code ThisDocument au projet. Le document FirstDocumentCustomization est ouvert automatiquement dans le concepteur.

Fermez et rouvrez le document dans le concepteur

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.

Pour fermer et rouvrir le document dans le concepteur

  1. Fermez le document en cliquant sur le bouton Fermer (X) pour la fenêtre du concepteur.

  2. Dans Explorateur de solutions, cliquez avec le bouton droit sur le fichier de code ThisDocument, puis cliquez sur Concepteur de vues.

    - ou -

    Dans Explorateur de solutions, double-cliquez sur le fichier de code ThisDocument.

Ajouter du texte au document dans le concepteur

Vous pouvez concevoir l'interface utilisateur de votre personnalisation en modifiant le document qui est ouvert dans le concepteur. Par exemple, vous pouvez ajouter du texte, des tableaux ou des contrôles Word. Pour plus d’informations sur l’utilisation du concepteur, consultez Bureau projets dans l’environnement Visual Studio.

Pour ajouter du texte à votre document à l'aide du concepteur

  1. Dans le document ouvert dans le concepteur, tapez le texte suivant.

    Ce texte a été ajouté à l’aide du concepteur.

Ajouter du texte au document par programmation

L'étape suivante consiste à ajouter du code dans le fichier ThisDocument. Le nouveau code utilise le modèle objet de Word pour ajouter un deuxième paragraphe de texte au document. Par défaut, le fichier de code ThisDocument contient le code généré suivant :

  • 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. Pour plus d’informations, consultez l’élément hôte de document et la vue d’ensemble du modèle objet Word. Le reste de la classe ThisDocument est défini dans un fichier de code masqué que vous ne devez pas modifier.

  • Les gestionnaires d'événements ThisDocument_Startup et ThisDocument_Shutdown . Ces gestionnaires d'événements sont appelés à l'ouverture et à la fermeture du document. 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. Pour plus d’informations, consultez Événements dans Bureau projets.

Pour ajouter un deuxième paragraphe de texte au document à l'aide de code

  1. Dans Explorateur de solutions, cliquez avec le bouton droit sur ThisDocument, puis cliquez sur Afficher le code.

    Le fichier de code s'ouvre dans Visual Studio.

  2. Remplacez le gestionnaire d'événements ThisDocument_Startup par le code suivant. Lorsque le document s'ouvre, ce code ajoute un deuxième paragraphe de texte au document.

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

    Remarque

    Ce code utilise la valeur d'index 1 pour accéder au premier paragraphe de la propriété 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.

Tester le projet

Pour tester votre document

  1. 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 associé au 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. Pour plus d’informations, consultez Générer des solutions Bureau.

  2. Dans le document, vérifiez que vous voyez le texte suivant.

    Ce texte a été ajouté à l’aide du concepteur.

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

  3. Fermez le document.

Nettoyer le projet

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.

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éé 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 :

  • Tâches de programmation générales que vous pouvez effectuer dans les personnalisations au niveau du document : Personnalisations au niveau du document du programme.

  • Tâches de programmation spécifiques aux personnalisations au niveau du document pour les solutions Word : 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 Actions : Bureau Personnalisation de l’interface utilisateur.

  • Utilisation d’objets Word étendus fournis par Bureau solutions dans Visual Studio pour effectuer des tâches qui ne sont pas possibles à l’aide du modèle objet Word (par exemple, l’hébergement de contrôles managés sur les documents et la liaison de contrôles Word aux données à l’aide du modèle de liaison de données Windows Forms) : automatisez Word à l’aide d’objets étendus.

  • Création et débogage de personnalisations au niveau du document pour Word : Créer des solutions Bureau.

  • Déploiement de personnalisations au niveau du document pour Word : Déployer une solution Bureau.

Contenu connexe