Atualizar para a biblioteca de API JavaScript mais recente e o esquema de manifesto de suplemento versão 1.1

  • Artigo

Este artigo descreve como atualizar os arquivos do JavaScript (Office.js e arquivos .js específicos do aplicativo) e o arquivo de validação do manifesto do suplemento no projeto do suplemento do Office para a versão 1.1.

Observação

Projetos criados no Visual Studio 2019 ou posterior já usarão a versão 1.1. No entanto, há atualizações secundárias ocasionais para a versão 1.1 que você pode aplicar usando as técnicas neste artigo.

Usar os arquivos de projeto mais atualizados

Se você usar o Visual Studio para desenvolver seu suplemento, para usar os membros mais recentes da API do Office JavaScript e os recursos v1.1 do manifesto XML de suplemento (que é validado em offappmanifest-1.1.xsd), você precisará baixar a versão mais recente do Visual Studio. Para baixar o Visual Studio, consulte a página IDE do Visual Studio. Durante a instalação, você precisará selecionar a carga de trabalho de desenvolvimento do Office/SharePoint.

Se você usar um editor de texto ou IDE diferente do Visual Studio para desenvolver seu suplemento, precisará atualizar as referências à CDN (rede de entrega de conteúdo) para Office.js e a versão do esquema referenciada no manifesto do suplemento.

Atualização de um projeto de suplemento do Office criado com o Visual Studio

Para projetos criados antes do lançamento do v1.1 da API JavaScript do Office e do esquema de manifesto de suplemento, você pode atualizar os arquivos de um projeto usando o Gerenciador de Pacotes NuGet e atualizar as páginas HTML do suplemento para referenciá-los.

Observe que o processo de atualização é aplicado por projeto – você precisará repetir o processo de atualização para cada projeto de suplemento no qual você deseja usar v1.1 de Office.js e esquema de manifesto de suplemento.

Atualizar os arquivos da biblioteca de API JavaScript do Office em seu projeto para a versão mais recente

As etapas a seguir atualizarão seus arquivos de biblioteca Office.js para a versão mais recente. As etapas usam o Visual Studio 2019, mas são semelhantes para versões anteriores do Visual Studio.

  1. No Visual Studio 2019, abra ou crie um novo projeto de suplemento do Office .
  2. Escolha FerramentasGerenciador de Pacotes>> NuGetGerenciar Pacotes Nuget para solução.
  3. Escolha a guia Atualizações.
  4. Selecione Microsoft.Office.js. Verifique se a origem do pacote é de nuget.org.
  5. No painel esquerdo, escolha Instalar e concluir o processo de atualização do pacote.

Você precisará realizar algumas etapas adicionais para concluir a atualização. Na marca principal das páginas HTML do suplemento, comente ou exclua quaisquer referências de script de office.js existentes e referencie a biblioteca de API JavaScript do Office atualizada da seguinte maneira:

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

Observação

O /1/ em office.js na URL de CDN especifica o uso da versão incremental mais recente na versão 1 do Office.js.

Atualizar o arquivo de manifesto no projeto para usar a versão 1.1 do esquema

No arquivo de manifesto do suplemento, atualize o atributo xmlns do <elemento OfficeApp> alterando o valor da versão para 1.1 (deixando atributos diferentes do atributo xmlns inalterados).

<?xml version="1.0" encoding="utf-8"?>
<OfficeApp xsi:type="ContentApp"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://schemas.microsoft.com/office/appforoffice/1.1">
  
  <!-- manifest contents -->

</OfficeApp>

Observação

Depois de atualizar a versão do esquema de manifesto de suplemento para 1.1, você precisará remover os elementos Capabilities e Capability e substituí-los pelos elementos Hosts e Host ou pelos elementos Requisitos e Requisitos.

Atualização de um projeto de suplemento do Office criado com um editor de texto ou outro IDE

Para projetos criados antes do lançamento do v1.1 da API JavaScript do Office e do esquema de manifesto de suplemento, você precisa atualizar as páginas HTML do suplemento para fazer referência à CDN da biblioteca v1.1 e atualizar o arquivo de manifesto do suplemento para usar o esquema v1.1.

O processo de atualização é aplicado por projeto – você precisará repetir o processo de atualização para cada projeto de suplemento no qual você deseja usar v1.1 de Office.js e esquema de manifesto de suplemento.

Você não precisa de cópias locais dos arquivos de API JavaScript do Office (Office.js e arquivos .js específicos do aplicativo) para desenvolver um Suplementooffice (fazendo referência à CDN para Office.js baixar os arquivos necessários em runtime), mas se você quiser uma cópia local dos arquivos da biblioteca, poderá usar o Utilitário Command-Line NuGet e o Install-Package Microsoft.Office.js comando para baixá-los.

Observação

Para obter uma cópia do XSD (Definição de Esquema XML) para o manifesto de suplemento v1.1, consulte a listagem em Referência de esquema para manifestos de suplementos do Office.

Atualizar os arquivos da biblioteca de API JavaScript do Office em seu projeto para usar a versão mais recente

  1. Abra as páginas HTML do suplemento no editor de texto ou IDE.

  2. Na marca principal das páginas HTML do suplemento, comente ou exclua quaisquer referências de script de office.js existentes e referencie a biblioteca de API JavaScript do Office atualizada da seguinte maneira:

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

    Observação

    O /1/ na frente de office.js na URL de CDN especifica o uso da versão incremental mais recente na versão 1 do Office.js.

Atualizar o arquivo de manifesto no projeto para usar a versão 1.1 do esquema

No arquivo de manifesto do suplemento, atualize o atributo xmlns do <elemento OfficeApp> alterando o valor da versão para 1.1 (deixando atributos diferentes do atributo xmlns inalterados).

<?xml version="1.0" encoding="utf-8"?>
<OfficeApp xsi:type="ContentApp"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns="http://schemas.microsoft.com/office/appforoffice/1.1">
  
  <!-- manifest contents -->

</OfficeApp>

Observação

Depois de atualizar a versão do esquema de manifesto de suplemento para 1.1, você precisará remover os elementos Capabilities e Capability e substituí-los pelos elementos Hosts e Host ou pelos elementos Requisitos e Requisitos.

Confira também