Criar seu primeiro suplemento do OutlookBuild your first Outlook add-in

Neste artigo, você acompanhará o processo de criação de um suplemento do painel de tarefas do Outlook que exibe pelo menos uma propriedade da mensagem selecionada.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.

Criar o suplementoCreate the add-in

Você pode criar um suplemento do Office usando o Gerador Yeoman para suplementos do Office ou Visual Studio.You can create an Office Add-in by using the Yeoman generator for Office Add-ins or Visual Studio. O gerador Yeoman cria um projeto Node.js que pode ser gerenciado com o Visual Studio Code ou com qualquer outro editor, enquanto o Visual Studio cria uma solução do 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. Selecione a guia do que você deseja usar e, em seguida, siga as instruções para criar o suplemento e testá-lo 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.

Pré-requisitosPrerequisites

  • Node (versão 8.0.0 ou posterior)Node.js (version 8.0.0 or later)

  • A versão mais recente do Yeoman e do Yeoman gerador de suplementos do Office. Para instalar essas ferramentas globalmente, execute o seguinte comando por meio do prompt de comando: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
    

    Observação

    Mesmo se você já instalou o gerador Yeoman, recomendamos atualizar seu pacote para a versão mais recente do npm.Even if you've previously installed the Yeoman generator, we recommend you update your package to the latest version from npm.

Criar o projeto do suplementoCreate the add-in project

  1. Execute o seguinte comando para criar um projeto de suplemento usando o gerador Yeoman:Run the following command to create an add-in project using the Yeoman generator:

    yo office
    

    Observação

    Ao executar o comando yo office, você receberá informações sobre as políticas de coleta de dados de Yeoman e as ferramentas da CLI do suplemento do 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 as informações fornecidas para responder às solicitações como achar melhor.Use the information that's provided to respond to the prompts as you see fit.

    Quando solicitado, forneça as seguintes informações para criar seu projeto de suplemento:When prompted, provide the following information to create your add-in project:

    • Escolha o tipo de projeto - Office Add-in Task Pane projectChoose a project type - Office Add-in Task Pane project

    • Escolha o tipo de script - JavascriptChoose a script type - Javascript

    • Qual será o nome do suplemento?What do you want to name your add-in? - My Office Add-in

    • Você gostaria de proporcionar suporte para qual aplicativo cliente do Office?Which Office client application would you like to support? - Outlook

    Uma captura de tela dos prompts e respostas do gerador Yeoman

    Depois que você concluir o assistente, o gerador criará o projeto e instalará os componentes Node de suporte.After you complete the wizard, the generator will create the project and install supporting Node components.

    Dica

    Você pode ignorar as orientações da próximas etapas fornecidas pelo gerador Yeoman após a criação do projeto de suplemento.You can ignore the next steps guidance that the Yeoman generator provides after the add-in project's been created. As instruções passo a passo deste artigo fornecem todas as orientações necessárias para concluir este tutorial.The step-by-step instructions within this article provide all of the guidance you'll need to complete this tutorial.

  2. Navegue até a pasta raiz do projeto do aplicativo Web.Navigate to the root folder of the web application project.

    cd "My Office Add-in"
    

Explore o projetoExplore the project

O projeto de suplemento que você criou com o gerador do Yeoman contém um exemplo de código para um suplemento de painel de tarefas bem 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.

  • O arquivo ./manifest.xml no diretório raiz do projeto define as configurações e os recursos do suplemento.The ./manifest.xml file in the root directory of the project defines the settings and capabilities of the add-in.
  • O arquivo ./src/taskpane/taskpane.html contém a marcação HTML do painel de tarefas.The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane.
  • O arquivo ./src/taskpane/taskpane.css contém o CSS que é aplicado ao conteúdo no painel de tarefas.The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane.
  • O arquivo ./src/taskpane/taskpane.js contém o código da API JavaScript do Office que facilita a interação entre o painel de tarefas e o Outlook.The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and Outlook.

Atualizar o códigoUpdate the code

  1. No seu editor de código, abra o arquivo ./src/taskpane/taskpane.html e substitua o elemento <main> inteiro (dentro do elemento <body>) com a seguinte marcação.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. A próxima marcação adiciona uma etiqueta onde o script no ./src/taskpane/taskpane.js gravará os dados.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. No seu editor de código, abra o arquivo ./src/taskpane/taskpane.js e adicione o seguinte código dentro da função executar.In your code editor, open the file ./src/taskpane/taskpane.js and add the following code within the run function. Este código usa a API JavaScript do Office para obter uma referência da mensagem atual e gravar o seu valor de propriedade subject no painel de tarefas.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;
    

ExperimenteTry it out

Observação

Os Suplementos do Office devem usar HTTPS, e não HTTP, mesmo durante o desenvolvimento.Office Add-ins should use HTTPS, not HTTP, even when you are developing. Se for solicitado a instalação de um certificado após executar um dos seguintes comandos, aceite a solicitação para instalar o certificado que o gerador do Yeoman fornecer.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. Execute o seguinte comando no diretório raiz do seu projeto.Run the following command in the root directory of your project. Quando você executar este comando, o servidor da Web local será iniciado (se ainda não estiver em execução).When you run this command, the local web server will start (if it's not already running).

    npm run dev-server
    
  2. Siga as instruções Realizar sideload dos suplementos do Outlook para testepara realizar o sideload do suplemento do Outlook.Follow the instructions in Sideload Outlook add-ins for testing to sideload the add-in in Outlook.

  3. No Outlook, escolha ou abra uma mensagem.In Outlook, select or open a message.

  4. Escolha a guia Página Inicial (ou a guia Mensagem, se você abriu a mensagem em uma nova janela), e em seguida o botão Mostrar Painel de Tarefas na faixa de opções para abrir o painel de tarefas do suplemento.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 tela de uma janela de mensagem do Outlook com o botão do suplemento realçado

  5. Role para parte inferior do painel de tarefas e escolha o link Executar para escrever o assunto da mensagem no painel de tarefas.Scroll to the bottom of the task pane and choose the Run link to write the message subject to the task pane.

    Uma captura de tela do painel de tarefas do suplemento com o link Executar realçado

    Uma captura de tela do painel de tarefas do suplemento exibindo o assunto da mensagem

Próximas etapasNext steps

Parabéns, você criou o seu primeiro suplemento do painel de tarefas do Outlook!Congratulations, you've successfully created your first Outlook task pane add-in! Em seguida, saiba mais sobre os recursos de um suplemento do Outlook e crie um suplemento mais complexo seguindo as etapas deste tutorial de suplemento do Word.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.