Criar projetos de Suplementos do Office com o Development Kit de Suplementos do Office para Visual Studio Code

O Development Kit de Suplementos do Office ajuda a configurar o seu ambiente, criar Suplementos do Office e depurar o seu código numa experiência simplificada.

Importante

A extensão do Development Kit de Suplementos do Office só suporta a criação de suplementos que utilizem o manifesto apenas de suplementos. Também cria apenas suplementos do Excel, PowerPoint e Word neste momento. O suporte para o Outlook está em desenvolvimento, assim como exemplos adicionais e outras melhorias. Agradecemos qualquer feedback que tenha sobre a ferramenta. Os pedidos de problemas e funcionalidades devem ser submetidos através de problemas do GitHub no repositório da extensão.

Pré-requisitos

• Transfira e instale Visual Studio Code.
• Node.js (a versão mais recente de LTS). Visite o siteNode.js para transferir e instalar a versão certa para o seu sistema operativo. Para verificar se já instalou estas ferramentas, execute os comandos node -v e npm -v no terminal.
• Office ligado a uma subscrição do Microsoft 365. Pode qualificar-se para uma subscrição de programador Microsoft 365 E5 através do Programa para Programadores do Microsoft 365. Consulte FAQ para obter detalhes. Em alternativa, pode inscrever-se numa avaliação gratuita de um mês ou comprar um plano do Microsoft 365.

Instalar o development kit

Pode instalar o Development Kit de Suplementos do Office com extensões no Visual Studio Code ou instalá-lo a partir do Visual Studio Code Marketplace.

Visual Studio Code

1. Inicie Visual Studio Code.
2. Selecione Ver>Extensões ou Ctrl+Shift+X. Também pode abrir extensões ao selecionar o separador Extensões na barra de atividade Visual Studio Code.
3. Introduza Development Kit de Suplementos do Office na caixa de pesquisa.
4. Selecione Development Kit de Suplementos do Office. Na página extensão do Development Kit de Suplementos do Office que aparece no painel main, selecione Instalar. Após a instalação com êxito, o ícone do Development Kit de Suplementos do Office será apresentado na barra de atividade Visual Studio Code.

Marketplace

1. Abra a página Do Kit de Desenvolvimento de Suplementos do Office no Visual Studio Code Marketplace.
2. Selecione Instalar na página Web. Se lhe for pedido que a extensão requer Visual Studio Code, selecione Continuar.
3. O browser poderá pedir-lhe para verificar se o site está a tentar abrir Visual Studio Code. Permitir que Visual Studio Code abra. Visual Studio Code será aberto com o readme da extensão do Development Kit de Suplementos do Office apresentado.
4. Selecione Instalar no Visual Studio Code. Após a instalação com êxito, o ícone do Development Kit de Suplementos do Office será apresentado na barra de atividade Visual Studio Code.

Criar um projeto de suplemento

O Development Kit de Suplementos do Office oferece duas formas de começar a utilizar um novo projeto: modelos e exemplos. Os modelos permitem-lhe escolher a aplicação do Office, a linguagem de programação e a funcionalidade de início. Os exemplos são projetos mais completos que demonstram um cenário realista.

Criar um suplemento a partir de um modelo

Os modelos oferecem um ponto de partida básico para o seu suplemento. Adicionam uma quantidade mínima de funcionalidades para que possa começar sem alterar grande parte do código existente. As instruções seguintes descrevem como criar um novo projeto a partir de um modelo com o development kit.

1. Abra Visual Studio Code e selecione o ícone do Development Kit de Suplementos do Office na Barra de Atividade.
2. Selecione Criar um Novo Suplemento no painel de tarefas da extensão.
3. No menu Escolha Rápida agora ativo, selecione a aplicação do Office para o seu suplemento.
4. Selecione um modelo de suplemento na lista de modelos disponíveis.
5. Selecione "JavaScript" ou "TypeScript" como a linguagem de programação.
6. Na caixa de diálogo da pasta Área de Trabalho que é aberta, selecione a pasta onde pretende criar o projeto.
7. Atribua um nome ao projeto (sem espaços) quando lhe for pedido. O Development Kit de Suplementos do Office irá criar o projeto com ficheiros básicos e andaimes. Em seguida, abre o projeto numa segunda janela Visual Studio Code. Pode fechar livremente a janela de Visual Studio Code original.

Criar um suplemento a partir de um exemplo

Os exemplos mostram um suplemento funcional que resolve um cenário ponto a ponto. Os exemplos são mais úteis como ferramentas de aprendizagem para compreender como as funcionalidades da arquitetura de Suplementos do Office funcionam em conjunto. Também pode expandir um exemplo de acordo com as suas necessidades específicas.

1. Abra Visual Studio Code e selecione o ícone do Development Kit de Suplementos do Office na Barra de Atividade.
2. Selecione Ver Exemplos.
3. Selecione o exemplo que pretende ver.
4. Selecione o botão Criar acima do readme de exemplo agora aberto.
5. Na caixa de diálogo da pasta Área de Trabalho que é aberta, selecione a pasta onde pretende criar o projeto. A extensão copia uma versão do exemplo para essa pasta. Em seguida, abre o projeto numa segunda janela Visual Studio Code. Pode fechar livremente a janela de Visual Studio Code original.

Testar o suplemento

Para compreender como o suplemento irá funcionar numa aplicação do Office, utilize o Development Kit de Suplementos do Office para executar e depurar o seu suplemento do Office no seu ambiente de desenvolvimento local.

Observação

Estes passos são os mesmos que os listados no Visual Studio Code pela extensão quando cria um novo projeto.

1. Abra a extensão ao selecionar o ícone do Development Kit de Suplementos do Office na Barra de Atividade.
2. Selecione Pré-visualizar o Seu Suplemento do Office (F5)
3. No menu Escolha Rápida, selecione a opção {Office Application} Desktop (Edge Chromium), em que "{Office Application}" é a aplicação adequada, como "Excel" ou "Word". Esta ação irá iniciar o suplemento e depurar o código.

O kit de desenvolvimento verifica se os pré-requisitos são cumpridos antes do início da depuração. Verifique o terminal para obter informações detalhadas se existirem problemas com o seu ambiente. Após este processo, a aplicação de ambiente de trabalho do Office é iniciada e efetua sideloads do suplemento. Tenha em atenção que, quando executar um projeto pela primeira vez, poderá demorar alguns minutos a instalar as dependências. Terá de instalar o certificado quando lhe for pedido.

Parar de testar o seu Suplemento do Office

Quando terminar de testar e depurar o suplemento, feche sempre o suplemento ao seguir estes passos. (Fechar a aplicação do Office ou a janela do servidor Web não regista de forma fiável o suplemento.)

1. Abra a extensão ao selecionar o ícone do Development Kit de Suplementos do Office na Barra de Atividade.
2. Selecione Parar a Pré-visualização do Seu Suplemento do Office. Esta ação fecha o servidor Web e remove o suplemento do registo e da cache.
3. Feche a janela da aplicação do Office.

Solução de problemas

Se tiver problemas ao executar o suplemento, siga estes passos.

• Feche todas as instâncias abertas do Office.
• Feche o servidor Web anterior iniciado para o suplemento com a opção Parar de Pré-visualizar a extensão do Development Kit de Suplementos do Office.

O artigo Resolver erros de desenvolvimento com Suplementos do Office contém soluções para problemas comuns. Se os problemas persistirem, crie um problema do GitHub e iremos ajudá-lo.

Para obter informações sobre como executar o suplemento no Office na Web, consulte Sideload Office Add-ins to Office na Web (Sideload Office Add-ins to Office na Web( Transferir Suplementos do Office para Office na Web).

Para obter informações sobre a depuração em versões mais antigas do Office, consulte Depurar suplementos com ferramentas de programador no Versão Prévia do Microsoft Edge.