Créer votre premier complément du volet Office de OneNoteBuild your first OneNote task pane add-in

Cet article décrit comment créer un complément du volet Office de OneNote.In this article, you'll walk through the process of building a OneNote task pane add-in.

Conditions préalablesPrerequisites

  • Node. js (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 déjà installé le générateur Yeoman, nous vous recommandons de mettre à jour votre package vers la dernière version à partir 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

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 yo office commande, vous pouvez recevoir des messages d’invite sur les stratégies de collecte de données de Yeoman et sur les outils CLI des compléments 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 le souhaitez.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? OneNote

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 creates the project and installs supporting Node components.

Conseil

Vous pouvez ignorer les instructions des étapes suivantes fournies par le générateur Yeoman après la création du projet de complément.You can ignore the next steps guidance that the Yeoman generator provides after the add-in project's been created. Les instructions pas à pas de cet article fournissent toutes les instructions nécessaires pour effectuer ce didacticiel.The step-by-step instructions within this article provide all of the guidance you'll need to complete this tutorial.

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 de l’API JavaScript pour Office qui facilite l’interaction entre le volet Office et l’application hôte Office.The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office host application.

Mettre à jour le codeUpdate the code

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 OneNote pour définir le titre de la page et ajouter un plan au corps de celle-ci.This code uses the OneNote JavaScript API to set the page title and add an outline to the body of the page.

try {
    await OneNote.run(async context => {

        // Get the current page.
        var page = context.application.getActivePage();

        // Queue a command to set the page title.
        page.title = "Hello World";

        // Queue a command to add an outline to the page.
        var html = "<p><ol><li>Item #1</li><li>Item #2</li></ol></p>";
        page.addOutline(40, 90, html);

        // Run the queued commands, and return a promise to indicate task completion.
        return context.sync();
    });
} catch (error) {
    console.log("Error: " + error);
}

EssayezTry it out

  1. Accédez au dossier racine du projet.Navigate to the root folder of the project.

    cd "My Office Add-in"
    
  2. Démarrez le serveur web local et chargez indépendamment votre complément.Start the local web server and sideload your add-in.

    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é une des commandes suivantes, acceptez d’installer le certificat fourni par le générateur Yeoman.If you are prompted to install a certificate after you run one of the following commands, accept the prompt to install the certificate that the Yeoman generator provides.

    Conseil

    Si vous testez votre complément sur Mac, exécutez la commande suivante avant de continuer.If you're testing your add-in on Mac, run the following command before proceeding. Lorsque vous exécutez cette commande, le serveur web local démarre.When you run this command, the local web server starts.

    npm run dev-server
    

    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 start:web
    
  3. Dans OneNote sur le web, ouvrez un bloc-notes, puis créez une page.In OneNote on the web, open a notebook and create a new page.

  4. Choisissez Insertion > Compléments Office pour ouvrir la boîte de dialogue Compléments Office.Choose Insert > Office Add-ins to open the Office Add-ins dialog.

    • Si vous êtes connecté avec votre compte de consommateur, sélectionnez l’onglet MES COMPLÉMENTS, puis choisissez Télécharger mon complément.If you're signed in with your consumer account, select the MY ADD-INS tab, and then choose Upload My Add-in.

    • Si vous êtes connecté avec votre compte professionnel ou scolaire, sélectionnez l’onglet MON ORGANISATION, puis choisissez Télécharger mon complément.If you're signed in with your work or school account, select the MY ORGANIZATION tab, and then select Upload My Add-in.

    L’image suivante montre l’onglet MES COMPLÉMENTS pour les blocs-notes de consommateurs.The following image shows the MY ADD-INS tab for consumer notebooks.

    The Office Add-ins dialog showing the MY ADD-INS tab
  5. Dans la boîte de dialogue Télécharger le complément, accédez à manifest.xml dans le dossier de projet, puis choisissez Télécharger.In the Upload Add-in dialog, browse to manifest.xml in your project folder, and then choose Upload.

  6. Dans l’onglet Accueil, choisissez le bouton Afficher le volet de tâches du ruban.From the Home tab, choose the Show Taskpane button in the ribbon. Le volet Office du complément s’ouvre dans un iFrame à côté de la page OneNote.The add-in task pane opens in an iFrame next to the OneNote page.

  7. Au bas du volet Office, sélectionnez le lien Exécuter pour définir le titre de la page et ajouter un plan au corps de celle-ci.At the bottom of the task pane, choose the Run link to set the page title and add an outline to the body of the page.

    Complément OneNote généré à partir de cette procédure pas à pas

Étapes suivantesNext steps

Félicitations ! Vous avez créé un complément du volet Office de OneNote !Congratulations, you've successfully created a OneNote task pane add-in! Ensuite, vous allez étudier en détail les concepts fondamentaux de la création de compléments Excel.Next, learn more about the core concepts of building OneNote add-ins.

Voir aussiSee also