Crie o seu primeiro suplemento do painel de tarefas do ProjectBuild your first Project task pane add-in

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

Pré-requisitosPrerequisites

Observação

Se você não conhece o Node.js ou o npm, deve começar configurando seu ambiente de desenvolvimento.If you aren't familiar with Node.js or npm, you should start by setting up your development environment.

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

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

  • Project 2016 ou posterior no WindowsProject 2016 or later on Windows

Criar o suplementoCreate the add-in

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 dar suporte para qual aplicativo cliente do Office?Which Office client application would you like to support? Project

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.After you complete the wizard, the generator creates the project and installs 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.

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

Atualizar o códigoUpdate the code

No seu editor de código, abra o arquivo ./src/taskpane/taskpane.js e adicione o seguinte código na função run.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 configurar o Name campo e Notes campo da tarefa selecionada.This code uses the Office JavaScript API to set the Name field and Notes field of the selected task.

var taskGuid;

// Get the GUID of the selected task
Office.context.document.getSelectedTaskAsync(
    function (result) {
        if (result.status === Office.AsyncResultStatus.Succeeded) {
            taskGuid = result.value;

            // Set the specified fields for the selected task.
            var targetFields = [Office.ProjectTaskFields.Name, Office.ProjectTaskFields.Notes];
            var fieldValues = ['New task name', 'Notes for the task.'];

            // Set the field value. If the call is successful, set the next field.
            for (var i = 0; i < targetFields.length; i++) {
                Office.context.document.setTaskFieldAsync(
                    taskGuid,
                    targetFields[i],
                    fieldValues[i],
                    function (result) {
                        if (result.status === Office.AsyncResultStatus.Succeeded) {
                            i++;
                        }
                        else {
                            var err = result.error;
                            console.log(err.name + ' ' + err.code + ' ' + err.message);
                        }
                    }
                );
            }
        } else {
            var err = result.error;
            console.log(err.name + ' ' + err.code + ' ' + err.message);
        }
    }
);

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. Inicie o servidor Web local.Start the local web server.

    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.

    Execute o seguinte comando no diretório raiz do seu projeto.Run the following command in the root directory of your project. O servidor Web local é iniciado quando este comando é executado.When you run this command, the local web server will start.

    npm run dev server
    
  3. Em Project, crie um plano de projeto simples.In Project, create a simple project plan.

  4. Carregue seu suplemento no Project seguindo as instruções em Realizar sideload de Suplementos do Office no Windows.Load your add-in in Project by following the instructions in Sideload Office Add-ins on Windows.

  5. Selecione uma única tarefa dentro do projeto.Select a single task within the project.

  6. Na parte inferior do painel de tarefas, escolha o link Executar para renomear a tarefa selecionada e adicionar anotações à tarefa selecionada.At the bottom of the task pane, choose the Run link to rename the selected task and add notes to the selected task.

    Captura de tela do aplicativo Project 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 Project!Congratulations, you've successfully created a Project task pane add-in! Em seguida, saiba mais sobre os recursos de um suplemento do Project e explore os cenários comuns.Next, learn more about the capabilities of a Project add-in and explore common scenarios.

Confira tambémSee also