Visão geral dos suplementos do ExcelExcel add-ins overview

Um suplemento do Excel permite que você estenda a funcionalidade do aplicativo Excel em várias plataformas, como Windows, Mac, iPad e em um navegador. Use os suplementos do Excel em uma pasta de trabalho para:An Excel add-in allows you to extend Excel application functionality across multiple platforms including Office on Windows, Office Online, Office for Mac, and Office for iPad. Use Excel add-ins within a workbook to:

  • Interagir com objetos do Excel, ler e gravar dados do Excel.Interact with Excel objects, read and write Excel data.
  • Estender a funcionalidade usando o painel de tarefas ou o painel conteúdo baseado na WebExtend functionality using web based task pane or content pane
  • Adicionar botões personalizados da faixa de opções ou itens de menu contextuaisAdd custom ribbon buttons or contextual menu items
  • Adicionar funções personalizadasAdd custom functions
  • Fornecer interação mais rica usando janela de caixa de diálogoProvide richer interaction using dialog window

A plataforma Suplementos do Office fornece a estrutura e as APIs JavaScript Office.js que permitem criar e executar suplementos do Excel. Usando a plataforma Suplementos do Office para criar o suplemento do Excel, você receberá os seguintes benefícios:The Office Add-ins platform provides the framework and Office.js JavaScript APIs that enable you to create and run Excel add-ins. By using the Office Add-ins platform to create your Excel add-in, you'll get the following benefits:

  • Suporte a multiplataformas: os suplementos do Excel são executados no Office na Web, no Windows, no Mac e no iPad.Cross-platform support: Excel add-ins run in Office on Windows, Mac, iOS, and Office Online.
  • Implantação centralizada: os administradores podem implantar rápida e facilmente suplementos do Excel para usuários em toda uma organização.Centralized deployment: Admins can quickly and easily deploy Excel add-ins to users throughout an organization.
  • Uso da tecnologia da Web padrão: Crie um suplemento do Excel usando tecnologias da Web conhecidas, como HTML, CSS e JavaScript.Use of standard web technology: Create your Excel add-in using familiar web technologies such as HTML, CSS, and JavaScript.
  • Distribuição pelo AppSource: Compartilhe o suplemento do Excel com uma ampla audiência publicando-o na AppSource.Distribution via AppSource: Share your Excel add-in with a broad audience by publishing it to AppSource.

Observação

Os suplementos do Excel são diferentes dos suplementos de COM e VSTO, que são anteriores às soluções de integração do Office que são executadas apenas no Office no Windows.Excel add-ins are different from COM and VSTO add-ins, which are earlier Office integration solutions that run only in Office on Windows. Diferentemente dos suplementos de COM, os suplementos do Excel não exigem a instalação de código no dispositivo de um usuário, nem no Excel.Unlike COM add-ins, Excel add-ins do not require you to install any code on a user's device, or within Excel.

Componentes de um suplemento do ExcelComponents of an Excel add-in

Um suplemento do Excel inclui dois componentes básicos: um aplicativo Web e um arquivo de configuração, chamado de arquivo de manifesto.An Excel add-in includes two basic components: a web application and a configuration file, called a manifest file.

O aplicativo Web usa a API JavaScript para Office para interagir com objetos no Excel e também pode facilitar a interação com recursos online.The web application uses the JavaScript API for Office to interact with objects in Excel, and can also facilitate interaction with online resources. Por exemplo, um suplemento pode executar alguma das seguintes tarefas:For example, an add-in can perform any of the following tasks:

  • Criar, ler, atualizar e excluir dados na pasta de trabalho (planilhas, intervalos, tabelas, gráficos, itens nomeados e muito mais).Create, read, update, and delete data in the workbook (worksheets, ranges, tables, charts, named items, and more).
  • Executar autorização de usuário em um serviço online usando o fluxo padrão OAuth 2.0.Perform user authorization with an online service by using the standard OAuth 2.0 flow.
  • Emitir solicitações de API ao Microsoft Graph ou qualquer outra API.Issue API requests to Microsoft Graph or any other API.

O aplicativo Web pode ser hospedado em qualquer servidor Web, além de poder ser criado usando estruturas do lado do cliente (como Angular, React, jQuery) ou tecnologias do lado do servidor (como ASP.NET, Node.js, PHP).The web application can be hosted on any web server, and can be built using client-side frameworks (such as Angular, React, jQuery) or server-side technologies (such as ASP.NET, Node.js, PHP).

O manifesto é um arquivo de configuração XML que define como o suplemento integra-se aos clientes do Office, especificando configurações e recursos, como:The manifest is an XML configuration file that defines how the add-in integrates with Office clients by specifying settings and capabilities such as:

  • A URL do aplicativo Web do suplemento.The URL of the add-in's web application.
  • O nome de exibição, a descrição, a ID, a versão e a localidade padrão do suplemento.The add-in's display name, description, ID, version, and default locale.
  • Como o suplemento integra-se ao Excel, incluindo qualquer interface de usuário personalizada que o suplemento cria (botões da faixa de opções, menus de contexto, etc.).How the add-in integrates with Excel, including any custom UI that the add-in creates (ribbon buttons, context menus, and so on).
  • Permissões exigidas pelo suplemento, como leitura e gravação no documento.Permissions that the add-in requires, such as reading and writing to the document.

Para permitir que os usuários finais instalem e usem um suplemento do Excel, você deve publicar o respectivo manifesto no AppSource ou em um catálogo de suplementos.To enable end users to install and use an Excel add-in, you must publish its manifest either to AppSource or to an add-ins catalog.

Recursos de um suplemento do ExcelCapabilities of an Excel add-in

Além de interagir com o conteúdo da pasta de trabalho, os suplementos do Excel podem adicionar botões personalizados da faixa de opções ou comandos de menu, inserir painéis de tarefas, adicionar funções personalizadas, abrir caixas de diálogo e, até mesmo, inserir objetos sofisticados baseados na web, como gráficos ou visualizações interativas, em uma planilha.In addition to interacting with the content in the workbook, Excel add-ins can add custom ribbon buttons or menu commands, insert task panes, open dialog boxes, and even embed rich, web-based objects such as charts or interactive visualizations within a worksheet.

Comandos de suplementoAdd-in commands

Comandos de suplemento são elementos de interface do usuário que estendem a interface do usuário do Excel e iniciam ações no suplemento. É possível adicionar um botão à faixa de opções ou um item a um menu de contexto do Excel. Ao selecionar um comando de suplemento, os usuários iniciam ações como executar código JavaScript ou exibir uma página do suplemento em um painel de tarefas. Add-in commands are UI elements that extend the Excel UI and start actions in your add-in. You can use add-in commands to add a button on the ribbon or an item to a context menu in Excel. When users select an add-in command, they initiate actions such as running JavaScript code, or showing a page of the add-in in a task pane.

Comandos de suplementoAdd-in commands

Comandos de suplemento no Excel

Para saber mais sobre recursos de comando, plataformas suportadas e práticas recomendadas para o desenvolvimento de comandos de suplemento, confira Comandos de suplemento para Excel, Word e PowerPoint.For more information about command capabilities, supported platforms, and best practices for developing add-in commands, see Add-in commands for Excel, Word, and PowerPoint.

Painéis de tarefasTask panes

Os painéis de tarefas são superfícies de interface que normalmente são exibidas no lado direito da janela no Excel. Os painéis de tarefas dão aos usuários acesso a controles de interface que executam códigos para modificar o documento do Excel ou exibir dados de uma fonte de dados.Task panes are interface surfaces that typically appear on the right side of the window within Excel. Task panes give users access to interface controls that run code to modify the Excel document or display data from a data source.

Painel de tarefasTask pane

Suplemento do painel de tarefas no Excel

Para saber mais sobre os painéis de tarefas, confira Painéis de tarefas nos Suplementos do Office. Para ver uma amostra que implementa um painel de tarefas no Excel, confira Suplemento do Excel JS WoodGrove Expense Trends.For more information about task panes, see Task panes in Office Add-ins. For a sample that implements a task pane in Excel, see Excel Add-in JS WoodGrove Expense Trends.

Funções personalizadasCustom functions

Funções personalizadas permitem que desenvolvedores adicionem novas funções do Excel definindo essas funções em JavaScript como parte de um suplemento.Custom functions enable developers to add new functions to Excel by defining those functions in JavaScript as part of an add-in. Os usuários do Excel podem acessar funções personalizadas da mesma forma que fariam com qualquer função nativa no Excel, como SUM().Users within Excel can access custom functions just as they would any native function in Excel, such as SUM().

Função personalizadaCustom function.

animated image showing an end user inserting the MYFUNCTION.SPHEREVOLUME custom function into a cell of an Excel worksheet

Para obter mais informações sobre funções personalizadas, consulteCriar funções personalizadas no Excel.For information about how to create custom functions in Excel using the Excel JavaScript API, see Create custom functions in Excel.

Caixas de diálogoDialog boxes

As caixas de diálogo são superfícies que flutuam acima da janela do aplicativo do Excel ativo.Dialog boxes are surfaces that float above the active Excel application window. Você pode usar caixas de diálogo para tarefas como exibir páginas de entrada que não podem ser abertas diretamente em um painel de tarefas, solicitar que o usuário confirme uma ação ou hospedar vídeos que possam ser muito pequenos se confinados a um painel de tarefas.You can use dialog boxes for tasks such as displaying sign-in pages that can't be opened directly in a task pane, requesting that the user confirm an action, or hosting videos that might be too small if confined to a task pane. Para abrir caixas de diálogo no suplemento do Excel, use a API da Caixa de Diálogo.To open dialog boxes in your Excel add-in, use the Dialog API.

Caixa de diálogoDialog box

Caixa de diálogo do suplemento no Excel

Para saber mais sobre caixas de diálogo e a API da Caixa de Diálogo, confira Caixas de diálogo nos Suplementos do Office e Usar a API da Caixa de Diálogo em Suplementos do Office.For more information about dialog boxes and the Dialog API, see Dialog boxes in Office Add-ins and Use the Dialog API in your Office Add-ins.

Suplementos de conteúdoContent add-ins

Os suplementos de conteúdo são superfícies que podem ser inseridas diretamente em documentos do Excel.Content add-ins are surfaces that you can embed directly into Excel documents. É possível usar suplementos de conteúdo para inserir objetos sofisticados baseados na Web, como gráficos, visualizações de dados ou mídia em uma planilha ou para conceder aos usuários acesso aos controles de interface que executam código para modificar o documento do Excel ou exibir dados de uma fonte de dados.You can use content add-ins to embed rich, web-based objects such as charts, data visualizations, or media into a worksheet or to give users access to interface controls that run code to modify the Excel document or display data from a data source. Use suplementos de conteúdo quando quiser inserir a funcionalidade diretamente no documento.Use content add-ins when you want to embed functionality directly into the document.

Suplemento de conteúdoContent add-in

Suplemento de conteúdo no Excel

Para saber mais sobre suplementos conteúdos, confira Suplementos do Office de conteúdo. Para ver um exemplo que implementa um suplemento de conteúdo no Excel, confira Suplemento de conteúdo do Excel Humongous Insurance no GitHub.For more information about content add-ins, see Content Office Add-ins. For a sample that implements a content add-in in Excel, see Excel Content Add-in Humongous Insurance in GitHub.

APIs JavaScript para interagir com o conteúdo da pasta de trabalhoJavaScript APIs to interact with workbook content

Um suplemento do Excel interage com objetos no Excel usando a API JavaScript para Office, que inclui dois modelos de objeto JavaScript:An Excel add-in interacts with objects in Excel by using the JavaScript API for Office, which includes two JavaScript object models:

  • API JavaScript do Excel: Introduzida com o Office 2016, a API JavaScript do Excel fornece objetos do Excel fortemente tipados que você pode usar para acessar planilhas, intervalos, tabelas, gráficos e muito mais.Excel JavaScript API: Introduced with Office 2016, the Excel JavaScript API provides strongly-typed Excel objects that you can use to access worksheets, ranges, tables, charts, and more.

  • APIs Comuns: Introduzida com o Office 2013, a API Comum permite que você acesse 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 API: Introduced with Office 2013, the Common API enables you to access features such as UI, dialogs, and client settings that are common across multiple types of host applications such as Word, Excel, and PowerPoint. Como a API compartilhada fornece funcionalidade limitada para interação do Excel, você poderá usá-la se seu suplemento precisa ser executado no Excel 2013.Because the Common API does provide limited functionality for Excel interaction, you can use it if your add-in needs to run on Excel 2013.

Próximas etapasNext steps

Introdução à criação de seu primeiro suplemento do Excel.Get started by creating your first Excel add-in. Em seguida, saiba mais sobre os principais conceitos da criação de suplementos do Excel.Then, learn about the core concepts of building Excel add-ins.

Confira tambémSee also