Fazendo referência à biblioteca da API JavaScript do Office

A biblioteca de API JavaScript do Office fornece as APIs que seu suplemento pode usar para interagir com o aplicativo do Office. A maneira mais simples de referenciar a biblioteca é usar a CDN (rede de distribuição de conteúdo) adicionando a tag a seguir <script> na <head> seção da sua página HTML.

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

Essa abordagem baixa e armazena em cache os arquivos da API JavaScript do Office na primeira vez que o suplemento é carregado. Isso garante que o suplemento use a implementação mais atualizada do Office.js e seus arquivos associados para a versão especificada.

Importante

Você deve fazer referência à API JavaScript do Office de dentro <head> da seção da página para garantir que a API seja totalmente inicializada antes de qualquer elemento do corpo.

Comportamento da API Web específico do Office.js

Office.js substitui os métodos padrão Window.history de replaceState e pushState por null. Se o suplemento depender desses métodos, substitua a referência da biblioteca Office.js pela solução alternativa a seguir.

<script type="text/javascript">
    // Cache the history method values.
    window._historyCache = {
        replaceState: window.history.replaceState,
        pushState: window.history.pushState
    };
</script>

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

<script type="text/javascript">
    // Restore the history method values after loading Office.js
    window.history.replaceState = window._historyCache.replaceState;
    window.history.pushState = window._historyCache.pushState;
</script>

Agradecemos ao @stepper e à comunidade do Stack Overflow por sugerir e verificar esta solução alternativa.

Controle de versão de API e compatibilidade com versões anteriores

No trecho HTML anterior, o /1/ anterior office.js na URL da CDN especifica a versão incremental mais recente na versão 1 do Office.js. Como a API JavaScript do Office mantém a compatibilidade com versões anteriores, a versão mais recente continua a dar suporte a membros da API que foram introduzidos anteriormente na versão 1.

Se você planeja publicar seu Suplemento do Office no Microsoft Marketplace, deve usar esta referência de CDN. Use referências locais somente para cenários internos, de desenvolvimento e de depuração.

Observação

Para usar APIs de visualização, faça referência à versão de visualização da biblioteca da API JavaScript do Office na CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Habilitando o IntelliSense para um projeto TypeScript

Além de referenciar a API JavaScript do Office, conforme descrito anteriormente, você também pode habilitar o IntelliSense para um projeto de suplemento TypeScript usando as definições de tipo de DefinitelyTyped. Para fazer isso, execute o comando a seguir em um prompt do sistema habilitado para Node (ou janela bash do git) na raiz da pasta do projeto. Você deve ter o Node.js instalado (que inclui o npm).

npm install --save-dev @types/office-js

APIs de Versão Prévia

A Microsoft apresenta pela primeira vez novas APIs JavaScript na "versão prévia". Após testes suficientes e comentários do usuário, as APIs se tornam parte de um conjunto de requisitos numerados específico.

Observação

As APIs de visualização estão sujeitas a alterações e não se destinam ao uso em um ambiente de produção. Recomendamos que você experimente apenas em ambiente de teste e desenvolvimento. Não use APIs de visualização em um ambiente de produção ou em documentos essenciais aos negócios.

Para usar APIs de visualização:

Referências da CDN para outros ambientes do Microsoft 365

A 21Vianet opera e gerencia um serviço do Office 365 com tecnologias licenciadas da Microsoft para fornecer serviços do Office 365 para a China em conformidade com as leis e regulamentos locais. Os suplementos desenvolvidos para uso nesse ambiente de nuvem devem usar a CDN correspondente. Use https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js em vez da referência CDN padrão. Isso garante conformidade contínua e fornece melhor desempenho do suplemento.

Confira também

  • Last updated on