Solucionar erros de desenvolvimento com Suplementos do Office

  • Artigo

Aqui está uma lista de problemas comuns que você pode encontrar ao desenvolver um Suplemento do Office.

Dica

Limpar o cache do Office geralmente corrige problemas relacionados ao código obsoleto. Isso garante que o manifesto mais recente seja carregado, usando os nomes de arquivo atuais, o texto do menu e outros elementos de comando. Para saber mais, confira Limpar o cache do Office.

Não é possível carregar o suplemento no painel de tarefas ou outros problemas relacionados ao manifesto do suplemento

Confira Validar o manifesto de suplemento do Office e Depurar seu suplemento com o log do tempo de execução para depurar problemas de manifesto de suplemento.

As personalizações de faixa de opções não são renderizadas conforme o esperado

  • Com o suplemento carregado e em execução, cole as URLs para os ícones de faixa de opções do suplemento na barra de navegação de um navegador e veja se os arquivos de ícone abrem.

  • Por padrão, os erros de suplemento conectados à interface do usuário do Office são suprimidos. Você pode ativar essas mensagens de erro com as etapas a seguir.

    1. Com o suplemento removido, abra a guia Arquivo do aplicativo do Office.
    2. Selecione Opções.
    3. Na caixa de diálogo Opções , selecione Avançado.
    4. Na seção Geral (a seção Desenvolvedores do Outlook), habilite Mostrar erros de interface do usuário de suplemento.

    Carregar o suplemento novamente e ver se há erros.

Alterações nos comandos de suplemento, incluindo botões da faixa de opções e itens de menu, não entram em vigor

Limpar o cache ajuda a garantir que a versão mais recente do manifesto do suplemento esteja sendo usada. Para limpar o cache do Office, siga as instruções em Limpar o cache do Office. Se você estiver usando Office na Web, desmarque o cache do navegador por meio da interface do usuário do navegador.

Os comandos de suplemento de suplementos de desenvolvimento antigos permanecem na faixa de opções mesmo depois que o cache for limpo

Às vezes, botões ou menus de um suplemento que você estava desenvolvendo no passado são exibidos na faixa de opções quando você executa um aplicativo do Office mesmo depois de limpar o cache. Experimente estas técnicas:

  • Se você desenvolver suplementos em mais de um computador e suas configurações de usuário forem sincronizadas entre os computadores, tente limpar o cache do Office em todos os computadores. Desligue todos os aplicativos do Office em todos os computadores e desmarque o cache em todos eles antes de abrir qualquer aplicativo do Office em qualquer um deles.
  • Se você publicou o manifesto do suplemento antigo em um compartilhamento de rede, desligue todos os aplicativos do Office, desmarque o cache e, em seguida, certifique-se de que o manifesto do suplemento seja removido da pasta compartilhada.

Alterações em arquivos estáticos, como JavaScript, HTML e CSS, não entram em vigor

O navegador pode estar armazenando esses arquivos em cache. Para evitar isso, desative o cache do lado do cliente ao desenvolver. Os detalhes dependerão do tipo de servidor que você estiver usando. Na maioria dos casos, envolve adicionar determinados cabeçalhos às respostas HTTP. Sugerimos o seguinte conjunto.

  • Controle de cache: "privado, sem cache, sem armazenamento"
  • Pragma: "sem cache"
  • Expira: "-1"

Para um exemplo de como fazer isso em um servidor Node.JS Express, confira este arquivo app.js. Para um exemplo em um projeto ASP.NET, confira este arquivo cshtml.

Se o seu suplemento estiver hospedado no Servidor de Informações da Internet (IIS), você também poderá adicionar o seguinte ao web.config.

<system.webServer>
  <staticContent>
    <clientCache cacheControlMode="UseMaxAge" cacheControlMaxAge="0.00:00:00" cacheControlCustom="must-revalidate" />
  </staticContent>

Se essas etapas não parecerem funcionar a princípio, talvez seja necessário limpar o cache do navegador. Faça isso através da interface do usuário do navegador. Às vezes, o cache do Microsoft Edge não é limpo com êxito quando você tenta limpá-lo na interface do usuário do Edge. Se isso acontecer, execute o seguinte comando em um prompt de comando do Windows.

del /s /f /q %LOCALAPPDATA%\Packages\Microsoft.Win32WebViewHost_cw5n1h2txyewy\AC\#!123\INetCache\

Alterações feitas em valores de propriedade não acontecem e não há mensagem de erro

Verifique a documentação de referência da propriedade para ver se ela é somente leitura. Além disso, as definições TypeScript para Office JS especificam quais propriedades de objeto são somente leitura. Se você tentar definir uma propriedade somente leitura, a operação de gravação falhará silenciosamente, sem erro. O exemplo a seguir tenta erroneamente definir a propriedade somente leitura Chart.id. Consulte também Algumas propriedades não podem ser definidas diretamente.

// This will do nothing, since `id` is a read-only property.
myChart.id = "5";

Erro: "Esse suplemento não está mais disponível"

A seguir estão algumas das causas desse erro. Se você descobrir causas adicionais, informe-nos com a ferramenta de comentários na parte inferior da página.

  • Se você estiver usando o Visual Studio, pode haver um problema com o sideload. Feche todas as instâncias do host do Office e do Visual Studio. Reinicie o Visual Studio e tente pressionar f5 novamente.
  • O manifesto do suplemento foi removido de seu local de implantação, como Implantação Centralizada, catálogo do SharePoint ou compartilhamento de rede.
  • O valor do elemento ID no manifesto foi alterado diretamente na cópia implantada. Se por algum motivo, você quiser alterar essa ID, primeiro remova o suplemento do host do Office e substitua o manifesto original pelo manifesto alterado. Muitos precisam limpar o cache do Office para remover todos os rastreamentos do original. Consulte o artigo Limpar o cache do Office para obter instruções sobre como limpar o cache do sistema operacional.
  • O manifesto do suplemento tem um resid que não é definido em nenhum lugar na seção Recursos do manifesto ou há uma incompatibilidade na ortografia do resid entre onde ele é usado e onde ele é definido na <seção Recursos> .
  • Há um resid atributo em algum lugar no manifesto com mais de 32 caracteres. Um resid atributo e o id atributo do recurso correspondente na <seção Recursos> não podem ter mais de 32 caracteres.
  • O suplemento tem um Comando de Suplemento personalizado, mas você está tentando executá-lo em uma plataforma que não dá suporte a eles. Para obter mais informações, confira Conjuntos de requisitos de comandos de suplemento.

O suplemento não funciona no Edge, mas funciona em outros navegadores

Consulte Solucionar problemas de EdgeHTML e WebView2 (Microsoft Edge).

O suplemento do Excel lança erros, mas não consistentemente

Consulte Solucionar problemas de suplementos do Excel para obter possíveis causas.

Word suplemento lança erros ou exibe comportamento quebrado

Consulte Solucionar problemas Word suplementos para possíveis causas.

Erros de validação de esquema de manifesto em projetos do Visual Studio

Se você estiver usando recursos mais recentes que exigem alterações no arquivo de manifesto, poderá obter erros de validação no Visual Studio. Por exemplo, ao adicionar o <elemento Runtimes> para implementar o runtime compartilhado, você poderá ver o seguinte erro de validação.

O elemento 'Host' no namespace 'http://schemas.microsoft.com/office/taskpaneappversionoverrides' tem elemento filho inválido 'Runtimes' no namespace 'http://schemas.microsoft.com/office/taskpaneappversionoverrides'

Se isso ocorrer, você poderá atualizar os arquivos XSD que o Visual Studio usa para as versões mais recentes. As versões de esquema mais recentes estão em [MS-OWEMXML]: Apêndice A: Esquema XML Completo.

Localizar os arquivos XSD

  1. Abra seu projeto no Visual Studio.
  2. Em Gerenciador de Soluções, abra o arquivo manifest.xml. Normalmente, o manifesto está no primeiro projeto em sua solução.
  3. Selecione Exibir>Janela de Propriedades (F4).
  4. Defina a seleção do cursor no manifest.xml para que a janela Propriedades mostre as propriedades do Documento XML .
  5. Na janela Propriedades , selecione a propriedade Schemas e selecione as reticências (...) para abrir o editor de Esquemas XML . Aqui você pode encontrar o local exato da pasta de todos os arquivos de esquema que seu projeto usa.

janela Propriedades mostrando as propriedades do documento XML.

Atualizar os arquivos XSD

  1. Abra o arquivo XSD que você deseja atualizar em um editor de texto. O nome do esquema do erro de validação se correlacionará com o nome do arquivo XSD. Por exemplo, abra TaskPaneAppVersionOverridesV1_0.xsd.
  2. Localize o esquema atualizado em [MS-OWEMXML]: Apêndice A: Esquema XML Completo. Por exemplo, TaskPaneAppVersionOverridesV1_0 está no esquema taskpaneappversionoverrides.
  3. Copie o texto em seu editor de texto.
  4. Salve o arquivo XSD atualizado.
  5. Reinicie o Visual Studio para obter as novas alterações de arquivo XSD.

Você pode repetir o processo anterior para quaisquer esquemas adicionais desatualizados.

Ao trabalhar offline, nenhuma APIs do Office funciona

Quando você estiver carregando a Biblioteca JavaScript do Office de uma cópia local em vez da CDN, as APIs poderão parar de funcionar se a biblioteca não estiver atualizada. Se você estiver afastado de um projeto por um tempo, reinstale a biblioteca para obter a versão mais recente. O processo varia de acordo com seu IDE. Escolha uma das opções a seguir com base em seu ambiente.

Confira também