Création de votre premier complément OutlookBuild your first Outlook add-in

Dans cet article, vous découvrirez comment créer un complément du volet Office Outlook qui affiche au moins une propriété d’un message sélectionné.In this article, you'll walk through the process of building an Outlook task pane add-in that displays at least one property of a selected message.

Créer le complémentCreate the add-in

Vous pouvez créer un complément Office à l’aide du générateur Yeoman pour les compléments Office ou de Visual Studio.You can create an Office Add-in by using the Yeoman generator for Office Add-ins or Visual Studio. Le générateur Yeoman crée un projet Node.js qui peut être géré avec du Visual Studio Code ou n’importe quel autre éditeur, alors que Visual Studio crée une solution Visual Studio.The Yeoman generator creates a Node.js project that can be managed with Visual Studio Code or any other editor, whereas Visual Studio creates a Visual Studio solution. Sélectionnez l’onglet correspondant à votre choix, puis suivez les instructions de création de votre complément et testez-le localement.Select the tab for the one you'd like to use and then follow the instructions to create your add-in and test it locally.

Conditions préalablesPrerequisites

  • Node.js (la dernière version de LTS )Node.js (the latest LTS version)

  • La dernière version deYeoman et de Yeoman Générateur de compléments Office. Pour installer ces outils globalement, exécutez la commande suivante à partir de l’invite de commande :The latest version of Yeoman and the Yeoman generator for Office Add-ins. To install these tools globally, run the following command via the command prompt:

    npm install -g yo generator-office
    

    Notes

    Même si vous avez précédemment installé le générateur Yeoman, nous vous recommandons de mettre à jour votre package vers la dernière version de npm.Even if you've previously installed the Yeoman generator, we recommend you update your package to the latest version from npm.

Création du projet de complémentCreate the add-in project

  1. Exécutez la commande suivante pour créer un projet de complément à l’aide du générateur Yeoman :Run the following command to create an add-in project using the Yeoman generator:

    yo office
    

    Notes

    Lorsque vous exécutez la commande yo office, il est possible que vous receviez des messages d’invite sur les règles de collecte de données de Yeoman et les outils CLI de complément Office.When you run the yo office command, you may receive prompts about the data collection policies of Yeoman and the Office Add-in CLI tools. Utilisez les informations fournies pour répondre aux invites comme vous l’entendez.Use the information that's provided to respond to the prompts as you see fit.

    Lorsque vous y êtes invité, fournissez les informations suivantes pour créer votre projet de complément :When prompted, provide the following information to create your add-in project:

    • Sélectionnez un type de projet - Office Add-in Task Pane projectChoose a project type - Office Add-in Task Pane project

    • Sélectionnez un type de script - JavascriptChoose a script type - Javascript

    • Comment souhaitez-vous nommer votre complément ?What do you want to name your add-in? - My Office Add-in

    • Quelle application client Office voulez-vous prendre en charge ?Which Office client application would you like to support? - Outlook

    Capture d’écran des invites et des réponses relatives au générateur Yeoman

    Après avoir exécuté l’assistant, le générateur crée le projet et installe les composants Node de prise en charge.After you complete the wizard, the generator will create the project and install supporting Node components.

    Conseil

    Vous pouvez ignorer les instructions suivantes fournies par le générateur Yeoman une fois que le complément a été créé.You can ignore the next steps guidance that the Yeoman generator provides after the add-in project's been created. Les instructions détaillées de cet article fournissent tous les conseils nécessaires à l’exécution de ce didacticiel.The step-by-step instructions within this article provide all of the guidance you'll need to complete this tutorial.

  2. Accédez au dossier racine du projet de l’application web.Navigate to the root folder of the web application project.

    cd "My Office Add-in"
    

Explorer le projetExplore the project

Le projet de complément que vous avez créé à l’aide du générateur Yeoman contient un exemple de code pour un complément de volet de tâches très simple.The add-in project that you've created with the Yeoman generator contains sample code for a very basic task pane add-in.

  • Le fichier ./manifest.xml du répertoire racine du projet définit les paramètres et fonctionnalités du complément.The ./manifest.xml file in the root directory of the project defines the settings and capabilities of the add-in.
  • Le fichier ./src/taskpane/taskpane.html contient les balises HTML du volet Office.The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane.
  • Le fichier ./src/taskpane/taskpane.css contient le style CSS appliqué au contenu du volet Office.The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane.
  • Le fichier ./src/taskpane/taskpane.js contient le code d’API JavaScript pour Office qui facilite l’interaction entre le volet Office et Outlook.The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and Outlook.

Mettre à jour le codeUpdate the code

  1. Dans votre éditeur de code, ouvrez le fichier ./src/taskpane/taskpane.html et remplacez l’élément <main> (dans l’élément <body>) par le balisage suivant.In your code editor, open the file ./src/taskpane/taskpane.html and replace the entire <main> element (within the <body> element) with the following markup. Ce nouveau balisage ajoute une étiquette à l’emplacement où le script dans ./src/taskpane/taskpane.js écrira des données.This new markup adds a label where the script in ./src/taskpane/taskpane.js will write data.

    <main id="app-body" class="ms-welcome__main" style="display: none;">
        <h2 class="ms-font-xl"> Discover what Office Add-ins can do for you today! </h2>
        <p><label id="item-subject"></label></p>
        <div role="button" id="run" class="ms-welcome__action ms-Button ms-Button--hero ms-font-xl">
            <span class="ms-Button-label">Run</span>
        </div>
    </main>
    
  2. Dans votre éditeur de code, ouvrez le fichier ./src/taskpane/taskpane.js et ajoutez le code suivant à la fonction run.In your code editor, open the file ./src/taskpane/taskpane.js and add the following code within the run function. Ce code utilise l’API JavaScript pour Office afin d’obtenir une référence au message en cours et écrire sa valeur de propriété subject dans le volet Office.This code uses the Office JavaScript API to get a reference to the current message and write its subject property value to the task pane.

    // Get a reference to the current message
    var item = Office.context.mailbox.item;
    
    // Write message property value to the task pane
    document.getElementById("item-subject").innerHTML = "<b>Subject:</b> <br/>" + item.subject;
    

Essayez !Try it out

Notes

Les compléments Office doivent utiliser le protocole HTTPS, et non HTTP, même lorsque vous développez.Office Add-ins should use HTTPS, not HTTP, even when you are developing. Si vous êtes invité à installer un certificat après avoir exécuté la commande suivante, acceptez d’installer le certificat fourni par le générateur Yeoman.If you are prompted to install a certificate after you run the following command, accept the prompt to install the certificate that the Yeoman generator provides.

  1. Exécutez la commande suivante dans le répertoire racine de votre projet.Run the following command in the root directory of your project. Lorsque vous exécutez cette commande, le serveur web local démarre (s’il n’est pas déjà en cours d’exécution).When you run this command, the local web server will start (if it's not already running).

    npm run dev-server
    
  2. Suivez les instructions indiquées dans l’article Chargement de version test des compléments Outlook pour charger le complément dans Outlook.Follow the instructions in Sideload Outlook add-ins for testing to sideload the add-in in Outlook.

  3. Dans Outlook, sélectionnez ou ouvrez un message.In Outlook, select or open a message.

  4. Sélectionnez l’onglet Accueil (ou l’onglet Message si vous avez ouvert le message dans une nouvelle fenêtre), puis sélectionnez le bouton Afficher le volet Office du ruban pour ouvrir le volet Office du complément.Choose the Home tab (or the Message tab if you opened the message in a new window), and then choose the Show Taskpane button in the ribbon to open the add-in task pane.

    Capture d’écran d’une fenêtre de message dans Outlook avec le bouton du complément mis en surbrillance

  5. Faites défiler vers le bas du volet Office et sélectionnez le lien Exécuter pour écrire l’objet du message dans le volet Office.Scroll to the bottom of the task pane and choose the Run link to write the message subject to the task pane.

    Capture d’écran du volet Office du complément avec le lien d’exécution mis en évidence

    Capture d’écran du volet Office du complément, affichant le sujet du message

Étapes suivantesNext steps

Félicitations, vous avez créé votre premier complément de volet de tâches Outlook !Congratulations, you've successfully created your first Outlook task pane add-in! Ensuite, découvrez les fonctionnalités d’un complément Outlook et créez-en un plus complexe en suivant le didacticiel pour complément Outlook.Next, learn more about the capabilities of an Outlook add-in and build a more complex add-in by following along with the Outlook add-in tutorial.