Compartir a través de

Crear su primer complemento de panel de tareas de OneNote

  • Artículo

Este artículo le guiará a través del proceso de creación de un complemento de panel de tareas de OneNote.

Requisitos previos

  • Node.js (la última versión de LTS). Visite el sitio deNode.js para descargar e instalar la versión correcta para el sistema operativo.

  • La versión más reciente de Yeoman y Generador de Yeoman para complementos de Office. Para instalar estas herramientas globalmente, ejecute el siguiente comando desde el símbolo del sistema.

    npm install -g yo generator-office

    Nota:

    Incluso si ya ha instalado el generador Yeoman, recomendamos que actualice el paquete de la versión más reciente desde npm.

  • Office está conectado a una suscripción Microsoft 365 (incluido Office en la Web).

    Nota:

    Si aún no tiene Office, puede calificar para una suscripción de desarrollador Microsoft 365 E5 a través del Programa para desarrolladores de Microsoft 365; para obtener más información, consulte las preguntas más frecuentes. Como alternativa, puede registrarse para obtener una evaluación gratuita de 1 mes o comprar un plan de Microsoft 365.

Creación del proyecto de complemento

Ejecute el siguiente comando para crear un proyecto de complemento con el generador Yeoman. Se agregará una carpeta que contiene el proyecto al directorio actual.

yo office

Nota:

Cuando ejecute el comando yo office, 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. Use la información adecuada que se proporciona para responder a los mensajes.

Cuando se le pida, proporcione la siguiente información para crear el proyecto de complemento.

  • Elija un tipo de proyecto:Office Add-in Task Pane project
  • Elija un tipo de script:Javascript
  • ¿Cómo desea asignarle el nombre al complemento?My Office Add-in
  • ¿Qué aplicación cliente de Office le gustaría admitir?OneNote

Las preguntas y respuestas del generador Yeoman en una interfaz de línea de comandos.

Después de completar el asistente, el generador creará el proyecto e instalará componentes auxiliares de Node.

Explorar el proyecto

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.

  • El archivo ./manifest.xml en el directorio raíz del proyecto define la configuración y las funciones del complemento.
  • El archivo ./src/taskpane/taskpane.html contiene el marcado HTML para el panel de tareas.
  • El archivo ./src/taskpane/taskpane.css contiene la CSS que se aplica al contenido en el panel de tareas.
  • 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 cliente de Office.

Actualizar el código

En el editor de código, abra el archivo ./src/taskpane/taskpane.js y agregue el siguiente código desde la función run. 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.

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

        // Get the current page.
        const 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.
        const html = "<p><ol><li>Item #1</li><li>Item #2</li></ol></p>";
        page.addOutline(40, 90, html);

        // Run the queued commands.
        await context.sync();
    });
} catch (error) {
    console.log("Error: " + error);
}

Pruébelo

  1. Navegue hasta la carpeta raíz del proyecto.

    cd "My Office Add-in"

  2. Inicie el servidor web local. Ejecute el siguiente comando en el directorio raíz del proyecto.

    npm run dev-server

    Nota:

    • Los complementos de Office deben usar HTTPS, no HTTP, aunque esté desarrollando. Si se le pide que instale un certificado después de ejecutar uno de los siguientes comandos, acepte el mensaje para instalar el certificado que proporciona el generador de Yeoman. Es posible que también deba ejecutar el símbolo del sistema o el terminal como administrador para que se realicen los cambios.

    • Si es la primera vez que desarrolla un complemento de Office en el equipo, es posible que se le pida en la línea de comandos que conceda a Microsoft Edge WebView una exención de bucle invertido ("Allow localhost loopback for Microsoft Edge WebView?"). Cuando se le solicite, escriba Y para permitir la exención. Tenga en cuenta que necesitará privilegios de administrador para permitir la exención. Una vez permitido, no se le pedirá una exención al transferir localmente complementos de Office en el futuro (a menos que quite la exención de la máquina). Para obtener más información, consulte "No se puede abrir este complemento desde localhost" al cargar un complemento de Office o mediante Fiddler.

      Símbolo del sistema de la línea de comandos para permitir a Microsoft Edge WebView una exención de bucle invertido.

  3. En OneNote en la Web, abra un bloc de notas y cree una nueva página.

  4. Elija Insertar>complementos de Office para abrir el cuadro de diálogo Complementos de Office.

    • Si ha iniciado sesión con su cuenta de consumidor, seleccione la pestaña MIS COMPLEMENTOS y después elija Cargar mi complemento.

    • 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.

    La siguiente imagen muestra la pestaña MIS COMPLEMENTOS para blocs de notas de consumidor.

    El cuadro de diálogo Complementos de Office con la pestaña MIS COMPLEMENTOS.

  5. En el diálogo Cargar complemento, busque manifest.xml en la carpeta del proyecto y, a continuación, elija Cargar.

  6. En la pestaña Inicio , elija el botón Mostrar panel de tareas en la cinta de opciones. El panel de tareas del complemento se abre en un iFrame junto a la página de OneNote.

  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.

    El complemento creado en este tutorial, en el que el botón de cinta de opciones Mostrar del panel de tareas se usa para el botón del panel de tareas en OneNote.

  8. Si desea detener el servidor web local y desinstalar el complemento, siga estas instrucciones:

Pasos siguientes

Enhorabuena, ha creado correctamente un complemento de panel de tareas de OneNote. A continuación, obtenga más información sobre los conceptos básicos sobre la creación de complementos de OneNote.

Introducción a la programación de API de JavaScript para OneNote

Solución de problemas

  • Es posible que se produzca un error en el paso automático npm install que realiza Yo Office. Si ve errores al intentar ejecutar npm start, vaya a la carpeta del proyecto recién creada en un símbolo del sistema y ejecute npm installmanualmente . Para obtener más información sobre Yo Office, vea Crear proyectos de complementos de Office mediante el generador de Yeoman.

Vea también