Desenvolver Suplementos do Office Develop Office Add-ins

Dica

Análise a Visão geral da plataforma de Suplementos do Office antes de ler este artigo.Please review Office Add-ins platform overview before reading this article.

Todos os Suplementos do Office criados com base na plataforma de Suplementos do Office.All Office Add-ins are built upon the Office Add-ins platform. Para qualquer suplemento que você criar, você precisará entender conceitos importantes como disponibilidade de aplicativo e plataforma, padrões de programação da API do Office JavaScript, como especificar as configurações e recursos de um suplemento no arquivo de manifesto, como projetar a Interface do Usuário, experiência e muito mais.For any add-in you build, you'll need to understand important concepts like application and platform availability, Office JavaScript API programming patterns, how to specify an add-in's settings and capabilities in the manifest file, how to design the UI and user experience, and more. Conceitos básicos de desenvolvimento como esses são abordados aqui na seção Ciclo de vida de desenvolvimento > Desenvolver da documentação.Core development concepts like these are covered here in the Development lifecycle > Develop section of the documentation. Análise as informações contidas aqui antes de explorar a documentação específica do aplicativo que corresponde ao suplemento que você está criando (por exemplo, Excel).Review the information here before exploring the application-specific documentation that corresponds to the add-in you're building (for example, Excel).

Criar um Suplemento do OfficeCreating an Office 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.

Gerador Yeoman para suplementos do OfficeYeoman generator for Office Add-ins

O Gerador Yeoman para suplementos do Office pode ser usado para criar um projeto de suplemento do Office Node.js que pode ser gerenciado com o Visual Studio Code ou qualquer outro editor.The Yeoman generator for Office Add-ins can be used to create a Node.js Office Add-in project that can be managed with Visual Studio Code or any other editor. O gerador pode criar suplementos do Office para qualquer um dos seguintes aplicativos:The generator can create Office Add-ins for any of the following:

  • ExcelExcel
  • OneNoteOneNote
  • OutlookOutlook
  • PowerPointPowerPoint
  • ProjectProject
  • WordWord
  • Funções personalizadas do ExcelExcel custom functions

Você pode optar por criar o projeto usando HTML, CSS e JavaScript ou usando o Angular ou React.You can choose to create the project using HTML, CSS and JavaScript, or using Angular or React. Para qualquer estrutura escolhida, você pode escolher entre o JavaScript e o Typescript também.For whichever framework you choose, you can choose between JavaScript and Typescript as well. Para saber mais sobre como criar suplementos com o gerador Yeoman, confira Desenvolver Suplementos do Office com o Código do Visual Studio.For more information about creating add-ins with the Yeoman generator, see Develop Office Add-ins with Visual Studio Code.

Visual StudioVisual Studio

O Visual Studio pode ser usado para criar suplementos do Office para o Excel, Outlook, Word e PowerPoint.Visual Studio can be used to create Office Add-ins for Excel, Outlook, Word, and PowerPoint. Um projeto do suplemento do Office é criado como parte de uma solução do Visual Studio e usa HTML, CSS e JavaScript.An Office Add-in project gets created as part of a Visual Studio solution and uses HTML, CSS, and JavaScript. Para saber mais sobre como criar suplementos usando o Visual Studio, confira Desenvolver suplementos do Office com o Visual Studio.For more information about creating add-ins with Visual Studio, see Develop Office Add-ins with Visual Studio.

Observação

Embora seja possível criar Suplementos do Office usando o Visual Studio, usar o gerador Yeoman oferece, em alguns casos de forma memorável, uma experiência melhor para o desenvolvedor.Although it's possible to create Office Add-ins using Visual Studio, using the Yeoman generator provides a better developer experience in some notable ways.

  • O gerador Yeoman fornece uma maior variedade de opções para tipos de projetos, estruturas e idiomas se comparado com o que o Visual Studio oferece para projetos de Suplemento do Office.The Yeoman generator provides a wider range of options for project types, frameworks, and languages than Visual Studio does for Office Add-in projects.

  • Os modelos de projeto no gerador Yeoman são atualizados com mais frequência do que os modelos de projeto no Visual Studio.Project templates in the Yeoman generator are updated more frequently than project templates in Visual Studio.

Compreender as duas partes de um Suplemento do OfficeUnderstanding the two parts of an Office add-in

Um suplemento do Office consiste em duas partes:An Office Add-in consists of two parts:

  • O manifesto do suplemento (um arquivo XML) que defina as configurações e recursos do suplemento.The add-in manifest (an XML file) that defines the settings and capabilities of the add-in.

  • O aplicativo Web que defina a interface do usuário e a funcionalidade de componentes do suplemento, como painéis de tarefas, suplementos de conteúdo e caixas de diálogo.The web application that defines the UI and functionality of add-in components such as task panes, content add-ins, and dialog boxes.

O aplicativo Web usa a API JavaScript para Office para interagir com o conteúdo do documento do Office no qual o suplemento está sendo executado.The web application uses the Office JavaScript API to interact with content in the Office document where the add-in is running. Seu suplemento também pode fazer outras coisas que os aplicativos Web normalmente fazem, como chamar serviços Web externos, facilitar a autenticação do usuário e mais.Your add-in can also do other things that web applications typically do, like call external web services, facilitate user authentication, and more.

Definir as configurações e os recursos do suplementoDefining an add-in's settings and capabilities

Um manifesto do suplemento do Office (um arquivo XML) define as configurações e os recursos do suplemento.An Office Add-in's manifest (an XML file) defines the settings and capabilities of the add-in. Você vai configurar o manifesto para especificar itens como:You'll configure the manifest to specify things such as:

  • Metadados que descrevem o suplemento (por exemplo, ID, versão, descrição, nome de exibição, local padrão).Metadata that describes the add-in (for example, ID, version, description, display name, default locale).
  • Aplicativos do Office onde o suplemento será executado.Office applications where the add-in will run.
  • Permissões necessárias para o suplemento.Permissions that the add-in requires.
  • Como o suplemento se integra ao Office, incluindo qualquer interface do usuário personalizada que o suplemento cria (por exemplo, guias personalizadas, botões da faixa de opções).How the add-in integrates with Office, including any custom UI that the add-in creates (for example, custom tabs, ribbon buttons).
  • Localização de imagens que o suplemento usa para identidade visual e iconografia de comando.Location of images that the add-in uses for branding and command iconography.
  • Dimensões do suplemento (por exemplo, dimensões para suplementos de conteúdo, altura solicitada para suplementos do Outlook).Dimensions of the add-in (for example, dimensions for content add-ins, requested height for Outlook add-ins).
  • As regras que especificam quando o suplemento é ativado no contexto de uma mensagem ou de um compromisso (somente para suplementos do Outlook).Rules that specify when the add-in activates in the context of a message or appointment (for Outlook add-ins only).

Para saber mais sobre o manifesto, confira Manifesto XML de suplementos do Office.For detailed information about the manifest, see Office Add-ins XML manifest.

Interagir com o conteúdo em um documento do OfficeInteracting with content in an Office document

Um suplemento do Office pode usar as APIs JavaScript para Office para interagir com o conteúdo no documento do Office no qual o documento está sendo executado.An Office Add-in can use the Office JavaScript APIs to interact with content in the Office document where the add-in is running.

Acessando a biblioteca da API JavaScript do OfficeAccessing the Office JavaScript API library

A biblioteca da API JavaScript do Office pode ser acessada por meio da CDN (rede de entrega de conteúdo) do Office JS em: https://appsforoffice.microsoft.com/lib/1/hosted/Office.js.The Office JavaScript API library can be accessed via the Office JS content delivery network (CDN) at: https://appsforoffice.microsoft.com/lib/1/hosted/Office.js. Para usar as APIs JavaScript para Office em qualquer uma das páginas da Web do seu suplemento, você deve fazer referência à CDN em uma tag <script> na tag <head> da página.To use Office JavaScript APIs within any of your add-in's web pages, you must reference the CDN in a <script> tag in the <head> tag of the page.

<head>
    ...
    <script src="https://appsforoffice.microsoft.com/lib/1/hosted/Office.js" type="text/javascript"></script>
</head>

Observação

Para usar APIs de visualização, faça referência à versão de visualização da biblioteca da API JavaScript do Office na CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.To use preview APIs, reference the preview version of the Office JavaScript API library on the CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Para obter mais informações sobre como acessar a biblioteca da API JavaScript do Office, incluindo como obter o IntelliSense, consulte Fazendo referência à biblioteca da API JavaScript do Office a partir de sua CDN (rede de distribuição de conteúdo).For more information about accessing the Office JavaScript API library, including how to get IntelliSense, see Referencing the Office JavaScript API library from its content delivery network (CDN).

Modelos de APIAPI models

A API JavaScript do Office inclui dois modelos diferentes:The Office JavaScript API includes two distinct models:

  • As APIs específicas do aplicativo fornecem objetos fortemente tipados que podem ser usados para interagir com objetos que são nativos de um aplicativo específico do Office.Application-specific APIs provide strongly-typed objects that can be used to interact with objects that are native to a specific Office application. Por exemplo, você pode usar as APIs JavaScript do Excel para acessar planilhas, intervalos, tabelas, gráficos e mais.For example, you can use the Excel JavaScript APIs to access worksheets, ranges, tables, charts, and more. Atualmente, as APIs específicas de aplicativo estão disponíveis para os seguintes aplicativos do Office:application-specific APIs are currently available for the following Office applications:

    Esse modelo de API usa promessas e permite que você especifique várias operações em cada solicitação enviada ao aplicativo do Office.This API model uses promises and allows you to specify multiple operations in each request you send to the Office application. Dessa maneira, operações de envio em lote podem melhorar significativamente o desempenho do suplemento em aplicativos do Office na Web.Batching operations in this manner can significantly improve add-in performance in Office applications on the web. As APIs específicas do aplicativo foram introduzidas com o Office 2016 e não podem ser usadas para interagir com o Office 2013.Application-specific APIs were introduced with Office 2016 and cannot be used to interact with Office 2013.

    Observação

    Também há uma API específica do aplicativo para o Visio, mas você só pode usá-la nas páginas do SharePoint Online para interagir com os diagramas do Visio que foram incorporados na página.There is also an application-specific API for Visio, but you can use it only in SharePoint Online pages to interact with Visio diagrams that have been embedded in the page. Os suplementos da Web do Office não são compatíveis com o Visio.Office web add-ins are not supported in Visio.

    Confira usando o modelo de API específico do aplicativo para saber mais sobre esse modelo de API.See Using the application-specific API model to learn more about this API model .

  • As APIs** Comuns** pode ser usada para acessar recursos como interface de usuário, caixas de diálogo e configurações de cliente, que são comuns entre vários tipos de aplicativos do Office.Common APIs can be used to access features such as UI, dialogs, and client settings that are common across multiple types of Office applications. Esse modelo de API usa retornos de chamada, que permitem especificar apenas uma operação em cada solicitação enviada ao aplicativo do Office.This API model uses callbacks, which allow you to specify only one operation in each request sent to the Office application. As APIs comuns foram introduzidas com o Office 2013 e podem ser usadas para interagir com o Office 2013 ou posterior.Common APIs were introduced with Office 2013 and can be used to interact with Office 2013 or later. Para saber mais sobre o modelo de objeto da API Comum, que inclui APIs para interagir com o Outlook, o PowerPoint e o Project, confira Modelo de objeto da API JavaScript comum.For details about the Common API object model, which includes APIs for interacting with Outlook, PowerPoint, and Project, see Common JavaScript API object model.

Observação

Algumas funções personalizadas do Excel são executadas em um tempo de execução exclusivo que prioriza a execução de cálculos e não têm um painel de tarefas.Some Excel custom functions run within a unique runtime that prioritizes execution of calculations and don't have a task pane. Essas funções usam um modelo de programação ligeiramente diferente e são chamadas de funções sem interface do usuário.These functions use a slightly different programming model and are called UI-less functions.

Conjuntos de requisitos da APIAPI requirement sets

Os conjuntos de requisitos são grupos nomeados de membros da API.Requirement sets are named groups of API members. Os conjuntos de requisitos podem ser específicos para os aplicativos do Office, como o conjunto de requisitos ExcelApi 1.7 (um conjunto de APIs que só podem ser usadas no Excel) ou comuns a vários aplicativos, como o conjunto de requisitos DialogApi 1.1 (um conjunto de APIs que podem ser usadas em qualquer aplicativo do Office que forneça suporte à API de Caixa de Diálogo).Requirement sets can be specific to Office applications, such as the ExcelApi 1.7 requirement set (a set of APIs that can only be used in Excel), or common to multiple applications, such as the DialogApi 1.1 requirement set (a set of APIs that can be used in any Office application that supports the Dialog API).

Seu suplemento pode usar conjuntos de requisitos para determinar se o aplicativo do Office oferece suporte aos membros da API necessários.Your add-in can use requirement sets to determine whether the Office application supports the API members that it needs to use. Para saber mais sobre isso, confira Especificar requisitos de API e aplicativos do Office.For more information about this, see Specify Office applications and API requirements.

O suporte a um conjunto de requisitos varia de acordo com o aplicativo do Office, a versão e a plataforma.Requirement set support varies by Office application, version, and platform. Para obter informações detalhadas sobre as plataformas, os conjuntos de requisitos e as APIs comuns compatíveis com cada aplicativo do Office, confira Disponibilidade de aplicativo e plataforma do cliente Office para Suplementos do Office.For detailed information about the platforms, requirement sets, and Common APIs that each Office application supports, see Office client application and platform availability for Office Add-ins.

Explorar APIs com o Script LabExploring APIs with Script Lab

O Script Lab é um suplemento que permite explorar a API JavaScript para Office e executar trechos de código enquanto você trabalha em um programa do Office, como o Excel ou o Word.Script Lab is an add-in that enables you to explore the Office JavaScript API and run code snippets while you're working in an Office program such as Excel or Word. Ele está disponível gratuitamente através do AppSource e é uma ferramenta útil para incluir no seu kit de ferramentas de desenvolvimento ao prototipar e verificar a funcionalidade desejada no suplemento.It's available for free via AppSource and is a useful tool to include in your development toolkit as you prototype and verify the functionality you want in your add-in. No Script Lab, você pode acessar uma biblioteca de exemplos internos para experimentar APIs rapidamente ou até mesmo usar uma amostra como o ponto de partida para o seu próprio código.In Script Lab, you can access a library of built-in samples to quickly try out APIs or even use a sample as the starting point for your own code.

O vídeo de um minuto a seguir mostra o Script Lab em ação.The following one-minute video shows Script Lab in action.

Vídeo curto mostrando o Script Lab em execução no Excel, Word e PowerPoint.Short video that shows Script Lab running in Excel, Word, and PowerPoint

Para saber mais sobre o Script Lab, confira Explorar as APIs JavaScript para Office usando o Script Lab.For more information about Script Lab, see Explore Office JavaScript APIs using Script Lab.

Estendendo a interface do usuário do OfficeExtending the Office UI

Um suplemento do Office pode estender a interface do usuário do Office usando comandos de suplementos e contêineres HTML como painéis de tarefas, suplementos de conteúdo ou caixas de diálogo.An Office Add-in can extend the Office UI by using add-in commands and HTML containers such as task panes, content add-ins, or dialog boxes.

  • Os comandos de suplemento podem ser usados para adicionar guias, botões e menus personalizados à faixa de opções padrão no office ou para estender o menu de contexto padrão que aparece quando os usuários clicam com o botão direito do mouse em um texto em um documento do Office ou em um objeto no Excel.Add-in commands can be used to add custom tabs, buttons, and menus to the default ribbon in Office, or to extend the default context menu that appears when users right-click text in an Office document or an object in Excel. Quando os usuários selecionam um comando de suplemento, eles iniciam a tarefa que o comando de suplemento especifica, como a execução de código JavaScript, a abertura de um painel de tarefas ou a inicialização de uma caixa de diálogo.When users select an add-in command, they initiate the task that the add-in command specifies, such as running JavaScript code, opening a task pane, or launching a dialog box.

  • Os contêineres HTML como painéis de tarefas, suplementos de conteúdo e caixas de diálogo podem ser usadas para exibir a interface do usuário personalizada e expor uma funcionalidade adicional em um aplicativo do Office.HTML containers like task panes, content add-ins, and dialog boxes can be used to display custom UI and expose additional functionality within an Office application. O conteúdo e a funcionalidade de cada painel de tarefas, suplemento de conteúdo ou caixa de diálogo são derivados de uma página da Web que você especifica.The content and functionality of each task pane, content add-in, or dialog box derives from a web page that you specify. Essas páginas da Web podem usar a API JavaScript para Office para interagir com o conteúdo do documento do Office no qual o suplemento está sendo executado, além disso, também pode fazer outras coisas que as páginas da Web geralmente fazem, como chamar serviços Web externos, facilitar a autenticação do usuário e mais.Those web pages can use the Office JavaScript API to interact with content in the Office document where the add-in is running, and can also do other things that web pages typically do, like call external web services, facilitate user authentication, and more.

A imagem a seguir mostra um comando de suplemento na faixa de opções, um painel de tarefas à direita do documento, uma caixa de diálogo ou suplemento de conteúdo sobre o documento.The following image shows an add-in command in the ribbon, a task pane to the right of the document, and a dialog box or content add-in over the document.

Diagrama mostrando comandos de suplemento na faixa de opções, um painel de tarefas e um suplemento de conteúdo/caixa de diálogo em um documento do Office

Para obter mais informações sobre como estender a Interface de Usuário do Office e projetar a Experiência de Usuário do suplemento, confira Elementos da Interface do Usuário do Office para Suplementos do Office.For more information about extending the Office UI and designing the add-in's UX, see Office UI elements for Office Add-ins.

Próximos passosNext steps

Este artigo descreveu as diferentes maneiras de criar suplementos do Office, apresentou as maneiras como um suplemento pode estender a Interface do Usuário do Office, descreveu os conjuntos de API e apresentou o Script Lab como uma ferramenta valiosa para explorar as APIs de JavaScript do Office e os suplementos de prototipagem em funcionalidade.This article has outlined the different ways to create Office Add-ins, introduced the ways that an add-in can extend the Office UI, described the API sets, and introduced Script Lab as a valuable tool for exploring Office JavaScript APIs and prototyping add-in functionality. Agora que você explorou essas informações introdutórias, considere continuar sua jornada de Suplementos do Office pelos seguintes caminhos.Now that you've explored this introductory information, consider continuing your Office Add-ins journey along the following paths.

Criar um Suplemento do OfficeCreate an Office Add-in

Você pode criar rapidamente um suplemento básico para o Excel, o OneNote, o Outlook, o PowerPoint, o Project ou o Word realizando um início rápido de 5 minutos.You can quickly create a basic add-in for Excel, OneNote, Outlook, PowerPoint, Project, or Word by completing a 5-minute quick start. Se você já concluiu um início rápido e deseja criar um suplemento um pouco mais complexo, experiente o tutorial.If you've previously completed a quick start and want to create a slightly more complex add-in, you should try the tutorial.

Saiba maisLearn more

Saiba mais sobre o desenvolvimento, testes e publicação de suplementos do Office explorando essa documentação.Learn more about developing, testing, and publishing Office Add-ins by exploring this documentation.

Dica

Para qualquer suplemento que você construir, você usará informações na seção Ciclo de vida de desenvolvimentodesta documentação, junto com informações na seção específica do aplicativo que corresponde ao tipo de suplemento que você está construindo (por exemplo, Excel).For any add-in that you build, you'll use information in the Development lifecycle section of this documentation, along with information in the application-specific section that corresponds to the type of add-in you're building (for example, Excel).

Confira tambémSee also