Amostras de código de suplemento do Office

Esses exemplos de código são escritos para ajudá-lo a aprender como usar vários recursos ao desenvolver suplementos do Office.

Introdução

Os exemplos a seguir mostram como construir o Suplemento do Office mais simples com apenas um manifesto, página da web HTML e um logotipo. Esses componentes são as partes fundamentais de um Suplemento do Office. Para obter informações adicionais sobre os primeiros passos, consulte nossos primeiros passos e tutoriais.

Suplementos do painel de tarefas

Suplementos de conteúdo

Tutoriais concluídos

Nome Descrição
Tutorial do Excel Este exemplo é a versão completa do Tutorial: Criar um suplemento de painel de tarefas do Excel que mostra como criar um suplemento do Excel com um painel de tarefas e botões de faixa de opções de comando. O suplemento demonstra como criar e classificar uma tabela, fazer um gráfico, congelar uma linha, proteger uma planilha e exibir uma caixa de diálogo.
Tutorial do Outlook Este exemplo é a versão completa do Tutorial: Criar um suplemento do Outlook para redigir mensagem que mostra como criar um suplemento do Outlook para a superfície de redação de mensagem. O suplemento demonstra como coletar informações do usuário, buscar dados de um serviço externo, implementar um comando de função, implementar um painel de tarefas, inserir conteúdo no corpo de uma mensagem e exibir uma caixa de diálogo.
Tutorial do PowerPoint (escritório) Este exemplo é a versão completa do Tutorial: Criar um suplemento do painel de tarefas do PowerPoint que mostra como criar um suplemento do PowerPoint com um painel de tarefas. O suplemento demonstra como adicionar uma imagem a um slide, adicionar texto a um slide, obter metadados de slides e navegar entre slides.
PowerPoint tutorial (Visual Studio) Este exemplo é a versão completa do Tutorial: Criar um suplemento do painel de tarefas do PowerPoint que mostra como criar um suplemento do PowerPoint com um painel de tarefas. O suplemento demonstra como adicionar a foto do dia do Bing a um slide, adicionar texto a um slide, obter metadados de slides e navegar entre slides.
Tutorial do Word Este exemplo é a versão completa do Tutorial: Criar um suplemento do painel de tarefas do Word que mostra como criar um suplemento do Word com um painel de tarefas. O suplemento demonstra como inserir e substituir intervalos de texto, parágrafos, imagens, HTML, tabelas e controles de conteúdo.
Tutorial da experiência de primeira execução do suplemento do Office Este exemplo é a versão completa do Criar um Suplemento do Office com uma experiência básica de primeira execução que mostra os conceitos básicos da implementação de uma OOBE (FRE). O Excel é usado neste exemplo, mas o padrão pode ser aplicado a outros aplicativos do Office em que há suporte para os Suplementos da Web do Office.

Blazor WebAssembly

Se sua experiência de desenvolvimento for a criação de Suplementos VSTO, os exemplos a seguir mostram como criar Suplementos da Web do Office usando o .NET Blazor WebAssembly. Você pode manter grande parte do seu código em C# e Visual Studio.

Excel

Name Descrição
Criar uma pasta de trabalho do Excel a partir de um site com um painel de tarefas de abertura automática Crie uma pasta de trabalho do Excel a partir de dados do site usando o Node.js e configure-a para que um painel de tarefas personalizado do Suplemento do Office seja aberto automaticamente quando o documento for aberto.
Explorador de tipos de dados Crie e explore os tipos de dados em suas pastas de trabalho. Os tipos de dados permitem que os desenvolvedores de suplementos organizem estruturas de dados complexas como objetos, como valores de números formatados, imagens da Web e valores de entidade.
Abrir no Teams Crie uma nova planilha do Excel no Microsoft Teams contendo os dados que você definir.
Inserir um arquivo Excel externo e preenchê-lo com dados JSON Insira um modelo existente de um arquivo externo do Excel na pasta de trabalho do Excel aberta no momento. Em seguida, preencha o modelo com dados de um serviço Web JSON.
Crie guias contextuais personalizadas na faixa de opções Crie uma guia contextual personalizada na faixa de opções na interface do usuário do Office. O exemplo cria uma tabela e, quando o usuário move o foco dentro da tabela, a guia personalizada é exibida. Quando o usuário sai da tabela, a guia personalizada fica oculta.
Exemplo de função personalizada usando web worker Use web workers em funções personalizadas para evitar o bloqueio da interface do usuário do suplemento do Office.
Use técnicas de armazenamento para acessar dados de um suplemento do Office quando estiver offline Implemente o localStorage para habilitar a funcionalidade limitada do Suplemento do Office quando um usuário perder a conexão.
Padrão de lote de função personalizada Agrupe várias chamadas em uma única chamada para reduzir o número de chamadas de rede para um serviço remoto.
Suplemento de conteúdo do Excel Insira um suplemento de conteúdo na grade do Excel.
Visualização de dados em um suplemento de conteúdo Crie um suplemento de conteúdo do Excel que inclua visualização de dados.
Exemplo de função personalizada síncrona (versão prévia) Use @supportSync para criar uma função personalizada síncrona que lê um valor de célula em conjunto com o processo de cálculo do Excel. Esse recurso se encontra em visualização pública.
Habilidade para Copilot no Excel (versão prévia) Crie uma habilidade personalizada para o Copilot no Excel que use as APIs específicas do Excel na biblioteca JavaScript do Office. Esse recurso se encontra em visualização pública.

Outlook

Nome Descrição
Criptografar e descriptografar mensagens no Outlook Use os Alertas Inteligentes do Outlook e o OnMessageDecrypt evento para criptografar e descriptografar mensagens.
Relatar emails de spam ou phishing no Outlook Crie uma solução integrada de relatórios de spam que seja facilmente detectável na faixa de opções do cliente Outlook. A solução fornece ao usuário uma caixa de diálogo para denunciar um email. Ele também salva uma cópia do email relatado em um arquivo para processamento posterior em seu sistema de back-end.
Criptografar anexos, processar participantes de solicitação de reunião e reagir a alterações de data/hora do compromisso usando a ativação baseada em eventos do Outlook Use a ativação baseada em evento para criptografar anexos quando adicionados pelo usuário. Use também o tratamento de eventos para destinatários alterados em uma solicitação de reunião e alterações na data ou hora de início ou término em uma solicitação de reunião.
Identificar e marcar destinatários externos usando a ativação baseada em eventos do Outlook Use a ativação baseada em eventos para executar um suplemento do Outlook quando o usuário alterar os destinatários ao redigir uma mensagem. O suplemento também usa a API appendOnSendAsync para adicionar um aviso de isenção.
Definir sua assinatura usando a ativação baseada em eventos do Outlook Use a ativação baseada em eventos para executar um suplemento do Outlook quando o usuário criar uma nova mensagem ou compromisso. O suplemento pode responder a eventos, mesmo quando o painel de tarefas não está aberto. Ele também usa a API setSignatureAsync.
Verifique as categorias de cores de uma mensagem ou compromisso antes de enviá-la usando Alertas Inteligentes Use os Alertas Inteligentes do Outlook para verificar se as categorias de cores necessárias são aplicadas a uma nova mensagem ou compromisso antes de enviá-la.
Verificar o rótulo de confidencialidade de uma mensagem Use a API do rótulo de confidencialidade em um suplemento baseado em evento para verificar e aplicar o rótulo de confidencialidade Altamente Confidencial às mensagens de saída aplicáveis.
Invocar um suplemento do Outlook de uma mensagem acionável Use um Cartão Adaptável em uma mensagem acionável para ativar um suplemento e exibir os dados de contexto de inicialização.

Word

Name Descrição
Adicionar rótulos automaticamente com um suplemento quando um documento do Word for aberto Configure um suplemento do Word para ativar quando um documento for aberto.
Obter, editar e definir conteúdo OOXML em um documento do Word com um suplemento do Word Obtenha, edite e defina o conteúdo OOXML em um documento do Word. O complemento de exemplo fornece um bloco de rascunho para obter o Office Open XML para seu próprio conteúdo e testar seus próprios trechos de código editados do Office Open XML.
Importar um modelo de documento do Word com um suplemento do Word Importar modelos em um documento do Word.
Carregar e gravar Open XML no seu suplemento do Word Adicione uma variedade de tipos de conteúdo avançado a um documento do Word usando o método setSelectedDataAsync com o tipo de coerção ooxml. O suplemento também oferece a capacidade de mostrar a marcação do Office Open XML para cada tipo de conteúdo de exemplo na página.
Gerenciar citações com seu suplemento do Word Gerenciar citações em um documento do Word.

Autenticação, autorização e logon único (SSO)

Nome Descrição
Suplemento do Office com SSO usando autenticação de aplicativo aninhado Use MSAL.js autenticação de aplicativo aninhada (NAA) em um Suplemento do Office para acessar APIs do Microsoft Graph para o usuário conectado. O exemplo exibe o nome e o email do usuário conectado. Ele também insere os nomes dos arquivos da conta do Microsoft OneDrive do usuário no documento.
Suplemento do Outlook com SSO usando autenticação de aplicativo aninhado Use MSAL.js autenticação de aplicativo aninhada (NAA) em um suplemento do Outlook para acessar APIs do Microsoft Graph para o usuário conectado. O exemplo exibe o nome e o email do usuário conectado. Ele também insere os nomes dos arquivos da conta Microsoft OneDrive do usuário em um novo corpo de mensagem.
Usar SSO com ativação baseada em eventos em um suplemento do Outlook Use o SSO para acessar dados do Microsoft Graph de um usuário de um evento disparado em um suplemento do Outlook.
Suplemento de amostra do Outlook de logon único (SSO) Use o recurso SSO do Office para fornecer ao suplemento acesso aos dados do Microsoft Graph.
Obtenha dados do OneDrive usando Microsoft Graph e msal.js em um suplemento do Office Crie um Suplemento do Office, como um aplicativo de página única (SPA) sem back-end, que se conecta ao Microsoft Graph para acessar pastas de trabalho armazenadas no OneDrive for Business e atualizar uma planilha.
Autenticação do suplemento do Office para o Microsoft Graph Crie um Suplemento do Microsoft Office que se conecte ao Microsoft Graph para acessar pastas de trabalho armazenadas no OneDrive for Business e atualizar uma planilha.
Autenticação do suplemento do Outlook para o Microsoft Graph Crie um suplemento do Outlook que se conecte ao Microsoft Graph para acessar pastas de trabalho armazenadas no OneDrive for Business e compor uma nova mensagem de email.
Suplemento do Office de Logon único (SSO) com ASP.NET Use a API getAccessToken em Office.js para dar ao suplemento acesso aos dados do Microsoft Graph. Este exemplo é criado no ASP.NET.
Suplemento Office dee Logon único (SSO) com Node.js Use a API getAccessToken em Office.js para dar ao suplemento acesso aos dados do Microsoft Graph. Este exemplo é construído em Node.js.

Office

Nome Descrição
Salvar configurações personalizadas no seu Suplemento do Office Salvar configurações personalizadas dentro de um suplemento do Office. O suplemento armazena dados como pares de chave-valor, usando a API JavaScript para o recipiente de propriedades do Office, cookies do navegador, armazenamento na Web (localStorage e sessionStorage) ou armazenando os dados em um div oculto no documento.
Use os atalhos do teclado para ações do Suplemento do Office Crie atalhos de teclado personalizados para invocar determinadas ações no seu Suplemento do Office.
Definir Dicas de Tecla para os controles da faixa de opções de um Suplemento do Office Defina as Dicas de Tecla para controles de faixa de opções de um Suplemento do Office.
Mostrar ou ocultar controles em uma guia personalizada da faixa de opções Defina a visibilidade inicial de grupos e controles em uma guia personalizada do Suplemento do Office e altere sua visibilidade em tempo de execução.

Tempo de execução compartilhado

Nome Descrição
Compartilhe dados globais com um tempo de execução compartilhado Configure um projeto básico que usa o tempo de execução compartilhado para executar código para botões da faixa de opções, painel de tarefas e funções personalizadas em um único tempo de execução do navegador.
Gerencie a faixa de opções e a interface do usuário do painel de tarefas e execute o código no documento aberto Crie os botões contextuais da faixa de opções que são ativados com base no estado do seu suplemento.

Amostras adicionais

Nome Descrição
Use uma biblioteca compartilhada para migrar seu suplemento do Visual Studio Tools para Office para um suplemento da web do Office Use uma biblioteca compartilhada para reutilizar o código ao migrar de Suplementos VSTO para Suplementos do Office.
Integre uma função do Azure à sua função personalizada do Excel Integre funções do Azure com funções personalizadas para mover para a nuvem ou integrar serviços adicionais.
Amostras de código DPI dinâmico Explore uma coleção de exemplos para lidar com alterações de DPI em COM, VSTO e Suplementos do Office.
Suplemento do painel de tarefas do avaliador de rubrica para o OneNote na Web Explore os conceitos básicos dos suplementos do OneNote com uma ferramenta de exemplo para professores.

Próximas etapas

Participe do Programa de Desenvolvedores do Microsoft 365 para obter recursos e informações para ajudá-lo a criar soluções para a plataforma Microsoft 365, incluindo recomendações adaptadas às suas áreas de interesse.

Você também pode se qualificar para uma assinatura de desenvolvedor gratuita que é renovável por 90 dias e vem configurada com dados de exemplo; para obter detalhes, consulte as Perguntas frequentes.