Crear el primer complemento de OutlookBuild your first Outlook add-in

Este artículo le guiará a través del proceso de creación de un complemento de panel de tareas de Outlook que muestre al menos una propiedad de un mensaje seleccionado.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.

Crear el complementoCreate the add-in

Puede crear un complemento de Office con el generador de Yeoman para complementos de Office o Visual Studio.You can create an Office Add-in by using the Yeoman generator for Office Add-ins or Visual Studio. El generador Yeoman crea un proyecto de Node.js que se puede administrar con Visual Studio Code u otro editor, mientras que Visual Studio crea una solución de 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. Seleccione la pestaña del que le gustaría usar y, después, siga las instrucciones para crear el complemento y probarlo localmente.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.

Requisitos previosPrerequisites

  • Node.js (la última versión de LTS)Node.js (the latest LTS version)

  • 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 ya ha instalado el generador Yeoman, recomendamos que actualice el paquete de la versión más reciente desde 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

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

    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.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 adecuada que se proporciona para responder a los mensajes.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? - Outlook

    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 will create the project and install supporting Node components.

    Sugerencia

    Se pueden pasar por alto las instrucciones de los pasos siguientes que el generador de Yeoman ofrece 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 que necesitará para completar este tutorial.The step-by-step instructions within this article provide all of the guidance you'll need to complete this tutorial.

  2. Navegue hasta la carpeta raíz del proyecto de la aplicación web.Navigate to the root folder of the web application project.

    cd "My Office Add-in"
    

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 Outlook.The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and Outlook.

Actualizar el códigoUpdate the code

  1. En el editor de código, abra el archivo ./src/taskpane/taskpane.html y reemplace todo el elemento <main> (en el elemento <body>) con el marcado siguiente.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. Este nuevo marcado agrega una etiqueta donde la secuencia de comandos ./src/taskpane/taskpane.js escribirá los datos.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. 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 Office para obtener una referencia al mensaje actual y escribir su valor de la propiedad subject en el panel de tareas.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;
    

PruébeloTry it out

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 se le pide que instale un certificado después de ejecutar el siguiente comando, acepte la solicitud para instalar el certificado que proporciona el generador 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. Ejecute el siguiente comando en el directorio raíz 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 dev-server
    
  2. Siga las instrucciones en Transferir localmente complementos de Outlook para realizar pruebas para transferir localmente el complemento en Outlook.Follow the instructions in Sideload Outlook add-ins for testing to sideload the add-in in Outlook.

  3. En Outlook, seleccione o abra un mensaje.In Outlook, select or open a message.

  4. Elija la pestaña Inicio (o Mensaje si abrió el mensaje en una nueva ventana) y seleccione el botón Mostrar panel de tareas en la cinta de opciones para abrir el panel de tareas del complemento.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.

    Captura de pantalla de una ventana de mensaje en Outlook con el botón del complemento resaltado

  5. Desplácese hasta la parte inferior del panel de tareas y seleccione el vínculo Ejecutar para escribir el asunto del mensaje en el panel de tareas.Scroll to the bottom of the task pane and choose the Run link to write the message subject to the task pane.

    Captura de pantalla del panel de tareas del complemento con el vínculo ejecutar resaltado

    Captura de pantalla del panel de tareas del complemento que muestra el asunto del mensaje

Pasos siguientesNext steps

Enhorabuena, ha creado correctamente su primer complemento de Outlook.Congratulations, you've successfully created your first Outlook task pane add-in! Ahora, obtenga más información sobre las funcionalidades de un complemento de Outlook y cree un complemento más complejo siguiendo el tutorial de complementos de 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.