Crear su primer complemento de panel de tareas de OneNoteBuild your first OneNote task pane add-in

Este artículo le guiará a través del proceso de creación de un complemento de panel de tareas de OneNote.In this article, you'll walk through the process of building a OneNote task pane add-in.

Requisitos previosPrerequisites

  • Node.js (versión 8.0.0 o posterior)Node.js (version 8.0.0 or later)

  • GitGit

  • La versión más reciente de Yeoman y Generador Yeoman para complementos de Office. Para instalar estas herramientas globalmente, ejecute el siguiente comando desde el símbolo del sistema: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
    

    Nota

    Incluso si ha instalado previamente el generador de Yeoman, le recomendamos que actualice el paquete a la versión más reciente de NPM.Even if you've previously installed the Yeoman generator, we recommend you update your package to the latest version from npm.

Creación del proyecto de complementoCreate the add-in project

Ejecute el siguiente comando para crear un proyecto de complemento con el generador de Yeoman:Run the following command to create an add-in project using the Yeoman generator:

yo office

Nota

Al ejecutar el yo office comando, es posible que reciba mensajes sobre las directivas de recopilación de datos de Yeoman y las herramientas de la CLI de complementos de 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. Use la información proporcionada para responder a los mensajes tal y como se ajuste.Use the information that's provided to respond to the prompts as you see fit.

Cuando se le pida, proporcione la siguiente información para crear el proyecto de complemento:When prompted, provide the following information to create your add-in project:

  • Elija un tipo de proyecto: Office Add-in Task Pane projectChoose a project type: Office Add-in Task Pane project
  • Elija un tipo de script: JavascriptChoose a script type: Javascript
  • ¿Qué nombre desea asignar al complemento?What do you want to name your add-in? My Office Add-in
  • ¿Qué aplicación cliente de Office desea admitir?Which Office client application would you like to support? OneNote

Captura de pantalla de las preguntas y respuestas del generador de Yeoman

Después de completar el asistente, el generador creará el proyecto e instalará componentes auxiliares de Node.After you complete the wizard, the generator creates the project and installs supporting Node components.

Sugerencia

Puede omitir las instrucciones de los pasos siguientes que el generador de Yeoman proporciona después de que se haya creado el proyecto de complemento.You can ignore the next steps guidance that the Yeoman generator provides after the add-in project's been created. Las instrucciones paso a paso de este artículo proporcionan todas las instrucciones necesarias para completar este tutorial.The step-by-step instructions within this article provide all of the guidance you'll need to complete this tutorial.

Explorar el proyectoExplore the project

El proyecto de complemento que ha creado con el generador Yeoman contiene código de ejemplo para un complemento de panel de tareas muy básico.The add-in project that you've created with the Yeoman generator contains sample code for a very basic task pane add-in.

  • El archivo ./manifest.xml en el directorio raíz del proyecto define la configuración y las funciones del complemento.The ./manifest.xml file in the root directory of the project defines the settings and capabilities of the add-in.
  • El archivo ./src/taskpane/taskpane.html contiene el marcado HTML para el panel de tareas.The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane.
  • El archivo ./src/taskpane/taskpane.css contiene la CSS que se aplica al contenido en el panel de tareas.The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane.
  • El archivo ./src/taskpane/taskpane.js contiene el código de la API de JavaScript de Office que facilita la interacción entre el panel de tareas y la aplicación host de 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.

Actualizar el códigoUpdate the code

En el editor de código, abra el archivo ./src/taskpane/taskpane.js y agregue el siguiente código desde la función ejecutar.In your code editor, open the file ./src/taskpane/taskpane.js and add the following code within the run function. Este código usa la API de JavaScript de OneNote para establecer el título de la página y agregar un contorno al cuerpo de la página.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);
}

PruébeloTry it out

  1. Navegue hasta la carpeta principal del proyecto.Navigate to the root folder of the project.

    cd "My Office Add-in"
    
  2. Inicie el servidor web local y transfiera localmente el complemento.Start the local web server and sideload your add-in.

    Nota

    Los complementos de Office deben usar HTTPS y no HTTP, incluso cuando está desarrollando.Office Add-ins should use HTTPS, not HTTP, even when you are developing. Si le pedirá que instale un certificado después de ejecutar uno de los siguientes comandos, acepte la solicitud para instalar el certificado que proporciona el generador 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.

    Sugerencia

    Si está probando el complemento en Mac, ejecute el siguiente comando antes de continuar.If you're testing your add-in on Mac, run the following command before proceeding. Al ejecutar este comando, se iniciará el servidor web local.When you run this command, the local web server starts.

    npm run dev-server
    

    Ejecute el siguiente comando en el directorio principal del proyecto.Run the following command in the root directory of your project. Al ejecutar este comando, se iniciará el servidor web local (si todavía no está en ejecución).When you run this command, the local web server will start (if it's not already running).

    npm run start:web
    
  3. En OneNote en la Web, abra un bloc de notas y cree una nueva página.In OneNote on the web, open a notebook and create a new page.

  4. Elija Insertar > Complemento de Office para abrir el diálogo Complementos de Office.Choose Insert > Office Add-ins to open the Office Add-ins dialog.

    • Si ha iniciado sesión con su cuenta de consumidor, seleccione la pestaña MIS COMPLEMENTOS y después elija Cargar mi complemento.If you're signed in with your consumer account, select the MY ADD-INS tab, and then choose Upload My Add-in.

    • Si ha iniciado sesión con su cuenta profesional o educativa, seleccione la pestaña MI ORGANIZACIÓN y después seleccione Cargar mi complemento.If you're signed in with your work or school account, select the MY ORGANIZATION tab, and then select Upload My Add-in.

    La siguiente imagen muestra la pestaña MIS COMPLEMENTOS para blocs de notas de consumidor.The following image shows the MY ADD-INS tab for consumer notebooks.

    The Office Add-ins dialog showing the MY ADD-INS tab
  5. En el diálogo Cargar complemento, busque manifest.xml en la carpeta del proyecto y, a continuación, elija Cargar.In the Upload Add-in dialog, browse to manifest.xml in your project folder, and then choose Upload.

  6. En la pestaña Inicio, elija el botón Mostrar panel de tareas en la cinta de opciones.From the Home tab, choose the Show Taskpane button in the ribbon. El panel de tareas del complemento se abre en un iFrame junto a la página de OneNote.The add-in task pane opens in an iFrame next to the OneNote page.

  7. En la parte inferior del panel de tareas, elija el vínculo Ejecutar para establecer el título de la página y agregar un contorno al cuerpo de la página.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.

    El complemento de OneNote que se crea con este tutorial

Pasos siguientesNext steps

Enhorabuena, ha creado correctamente un complemento de panel de tareas de OneNote.Congratulations, you've successfully created a OneNote task pane add-in! A continuación, obtenga más información sobre los conceptos básicos sobre la creación de complementos de OneNote.Next, learn more about the core concepts of building OneNote add-ins.

Recursos adicionalesSee also