Crie seu primeiro suplemento do painel de tarefas do OneNoteBuild your first OneNote task pane add-in

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

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? OneNote

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.

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

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 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 OneNote para definir o título da página e adicionar um contorno ao corpo da página.This code uses the OneNote JavaScript API to set the page title and add an outline to the body of the page.

try {
    await OneNote.run(async context => {

        // Get the current page.
        var page = context.application.getActivePage();

        // Queue a command to set the page title.
        page.title = "Hello World";

        // Queue a command to add an outline to the page.
        var html = "<p><ol><li>Item #1</li><li>Item #2</li></ol></p>";
        page.addOutline(40, 90, html);

        // Run the queued commands, and return a promise to indicate task completion.
        return context.sync();
    });
} catch (error) {
    console.log("Error: " + error);
}

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 e realize o sideload no seu suplemento.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
    

    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 start:web
    
  3. No OneNote Online, abra um bloco de anotações e crie uma nova página.In OneNote on the web, open a notebook and create a new page.

  4. Escolha Inserir > Suplementos do Office para abrir a caixa de diálogo Suplementos do Office.Choose Insert > Office Add-ins to open the Office Add-ins dialog.

    • Se você estiver conectado à sua conta de consumidor, selecione a guia MEUS SUPLEMENTOS e escolha Carregar Meu Suplemento.If you're signed in with your consumer account, select the MY ADD-INS tab, and then choose Upload My Add-in.

    • Se você estiver conectado à sua conta corporativa ou de estudante, selecione a guia MINHA ORGANIZAÇÃO e escolha Carregar Meu Suplemento.If you're signed in with your work or school account, select the MY ORGANIZATION tab, and then select Upload My Add-in.

    A imagem a seguir mostra a guia MEUS SUPLEMENTOS para blocos de anotações do consumidor.The following image shows the MY ADD-INS tab for consumer notebooks.

    The Office Add-ins dialog showing the MY ADD-INS tab
  5. Na caixa de diálogo Carregar Suplemento, navegue até manifest.xml na pasta do projeto e escolha Carregar.In the Upload Add-in dialog, browse to manifest.xml in your project folder, and then choose Upload.

  6. Na guia Página Inicial, na faixa de opções, escolha o botão Mostrar Painel de Tarefas.From the Home tab, choose the Show Taskpane button in the ribbon. O painel de tarefa do suplemento abre em um iFrame ao lado da página do OneNote.The add-in task pane opens in an iFrame next to the OneNote page.

  7. Na parte inferior do painel de tarefas, escolha o link Executar para definir o título da página e adicionar um contorno ao corpo da página.At the bottom of the task pane, choose the Run link to set the page title and add an outline to the body of the page.

    O suplemento do OneNote criado a partir deste passo a passo

Próximas etapasNext steps

Parabéns, você criou com êxito um suplemento do painel de tarefas do OneNote!Congratulations, you've successfully created a OneNote task pane add-in! Em seguida, saiba mais sobre os principais conceitos de criação de suplementos do OneNote.Next, learn more about the core concepts of building OneNote add-ins.

Confira tambémSee also