Crie seu primeiro suplemento do painel de tarefas do WordBuild your first Word task pane add-in

Aplica-se a: Word 2016 ou posterior no Windows, Word para iPad e MacApplies to: Word 2016 or later on Windows, and Word on iPad and Mac

Neste artigo, você aprenderá sobre o processo de criação de um suplemento do painel de tarefas do Word.In this article, you'll walk through the process of building a Word task pane add-in.

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)

  • GitGit

  • 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 que você já tenha instalado 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

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 yo office comando, você pode receber prompts sobre as políticas de coleta de dados do Yeoman e as ferramentas 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 aos prompts conforme você vir ajustar.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? Word

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

Dica

Você pode ignorar as próximas etapas orientações que o gerador Yeoman fornece 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.

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. Se você quiser examinar os componentes do seu projeto de suplemento, abra o projeto no seu editor de código e revise os arquivos listados abaixo.If you'd like to explore the components of your add-in project, open the project in your code editor and review the files listed below. Quando estiver pronto para experimentar o suplemento, prossiga para a próxima seção.When you're ready to try out your add-in, proceed to the next section.

  • 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 aplicativo host do 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.

ExperimenteTry it out

  1. Navegue até a pasta raiz do projeto.Navigate to the root folder of the project.

    cd "My Office Add-in"
    
  2. Conclua as etapas a seguir para iniciar o servidor Web local e fazer o sideload do seu suplemento.Complete the following steps to start the local web server and sideload your add-in.

    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 você for solicitado a instalar 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 one of the following commands, accept the prompt to install the certificate that the Yeoman generator provides.

    Dica

    Se você estiver testando o seu suplemento no Mac, execute o seguinte comando antes de continuar.If you're testing your add-in on Mac, run the following command before proceeding. O servidor Web local é iniciado quando este comando é executado.When you run this command, the local web server starts.

    npm run dev-server
    
    • Para testar seu suplemento no Word, execute o seguinte comando no diretório raiz do seu projeto.To test your add-in in Word, run the following command in the root directory of your project. Isso inicia o servidor Web local (caso ainda não esteja em execução) e abre o Word com o suplemento carregado.This starts the local web server (if it's not already running) and opens Word with your add-in loaded.

      npm start
      
    • Para testar seu suplemento no Word em um navegador, execute o seguinte comando no diretório raiz do seu projeto.To test your add-in in Word on a browser, run the following command in the root directory of your project. Quando você executar este comando, o servidor 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 start:web
      

      Para usar o seu suplemento, abra um novo documento no Word na Web e em seguida realize o sideload no suplemento de acordo com as instruções em Realizar Sideload nos Suplementos do Office no Office na Web.To use your add-in, open a new document in Word on the web and then sideload your add-in by following the instructions in Sideload Office Add-ins in Office on the web.

  3. No Word, abra um novo documento, escolha a guia Página Inicial e o botão Mostrar Painel de Tarefas na faixa de opções para abrir o painel de tarefas do suplemento.In Word, open a new document, choose the Home tab, and then choose the Show Taskpane button in the ribbon to open the add-in task pane.

    Uma captura de tela do aplicativo Word com o botão Mostrar Painel de Tarefas realçado

  4. Na parte inferior do painel de tarefas, escolha o link Executar para inserir o texto «Olá, Mundo» no documento com a fonte azul.At the bottom of the task pane, choose the Run link to add the text "Hello World" to the document in blue font.

    Captura de tela do aplicativo Word com o suplemento do painel de tarefas carregado

Próximas etapasNext steps

Parabéns, você criou com êxito um suplemento do painel de tarefas do Word!Congratulations, you've successfully created a Word task pane add-in! Em seguida, saiba mais sobre os recursos de um suplemento do Word e crie um suplemento mais complexo seguindo as etapas deste tutorial de suplemento do Word.Next, learn more about the capabilities of a Word add-in and build a more complex add-in by following along with the Word add-in tutorial.

Confira tambémSee also