Crie seu primeiro suplemento do painel de tarefas do Word

Aplica-se a: Word 2016 ou posterior no Windows, Word para iPad e Mac

Neste artigo, você aprenderá sobre o processo de criação de um suplemento do painel de tarefas do Word.

Criar o suplemento

Você pode criar um suplemento do Office usando o Gerador Yeoman para suplementos do Office ou 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. Selecione a guia do que você deseja usar e, em seguida, siga as instruções para criar o suplemento e testá-lo localmente.

Dica

Para usar o gerador Yeoman para criar um suplemento que use o logon único (SSO), confira as instruções em Início rápido do logon único (SSO).

Pré-requisitos

Observação

Se você não conhece o Node.js ou o npm, deve começar configurando seu ambiente de desenvolvimento.

  • Node.js (a versão mais recente de LTS)

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

    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.

Criar o projeto do suplemento

Execute o comando a seguir para criar um projeto de suplemento usando o gerador Yeoman.

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. Use as informações fornecidas para responder às solicitações como achar melhor.

Quando solicitado, forneça as informações a seguir para criar seu projeto de suplemento.

  • Escolha o tipo de projeto: Office Add-in Task Pane project
  • Escolha o tipo de script: Javascript
  • Qual será o nome do suplemento? My Office Add-in
  • Você gostaria de proporcionar suporte para qual aplicativo cliente do Office? Word

Captura de tela apresentando os avisos e respostas do gerador Yeoman em uma interface de linha de comando.

Depois que você concluir o assistente, o gerador criará o projeto e instalará os componentes Node de suporte.

Dica

Você pode ignorar as orientações da próximas etapas fornecidas pelo gerador Yeoman após a criação do projeto de suplemento. As instruções passo a passo deste artigo fornecem todas as orientações necessárias para concluir este tutorial.

Explore o projeto

O projeto de suplemento que você criou com o gerador Yeoman contém um código de exemplo para um suplemento básico do painel de tarefas. 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. Quando estiver pronto para experimentar o suplemento, prossiga para a próxima seção.

  • O arquivo ./manifest.xml no diretório raiz do projeto define as configurações e os recursos do suplemento. Para saber mais sobre o arquivo manifest.xml arquivo, consulte manifesto XML de suplementos do Office.
  • O arquivo ./src/taskpane/taskpane.html contém a marcação HTML do painel de tarefas.
  • O arquivo ./src/taskpane/taskpane.css contém o CSS que é aplicado ao conteúdo no painel de tarefas.
  • 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 cliente do Office.

Experimente

  1. Navegue até a pasta raiz do projeto.

    cd "My Office Add-in"
    
  2. Conclua as etapas a seguir para iniciar o servidor Web local e fazer o sideload do seu suplemento.

    Observação

    Os Suplementos do Office devem usar HTTPS, e não HTTP, mesmo durante o desenvolvimento. 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.

    Dica

    Se você estiver testando o seu suplemento no Mac, execute o seguinte comando antes de continuar. O servidor Web local é iniciado quando este comando é executado.

    npm run dev-server
    
    • Para testar seu suplemento no Word, execute o seguinte comando no diretório raiz do seu projeto. Isso inicia o servidor Web local (caso ainda não esteja em execução) e abre o Word com o suplemento carregado.

      npm start
      
    • Para testar seu suplemento no Word em um navegador, execute o seguinte comando no diretório raiz do seu projeto. Quando você executar este comando, o servidor Web local será iniciado (se ainda não estiver em execução).

      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.

  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.

    Captura de tela exibindo o 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.

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

Próximas etapas

Parabéns, você criou com êxito um suplemento do painel de tarefas do Word! 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.

Confira também