Fazendo referência à biblioteca da API JavaScript do Office

  • Artigo

A biblioteca da API javaScript do Office fornece as APIs que o seu suplemento pode utilizar para interagir com a aplicação do Office. A forma mais simples de referenciar a biblioteca é utilizar a rede de entrega de conteúdos (CDN) ao adicionar a seguinte <script> etiqueta na <head> secção da sua página HTML.

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

Esta ação irá transferir e colocar em cache os ficheiros da API JavaScript do Office da primeira vez que o suplemento for carregado para garantir que está a utilizar a implementação mais atualizada do Office.js e os respetivos ficheiros associados para a versão especificada.

Importante

Tem de referenciar a API JavaScript do Office a <head> partir da secção da página para garantir que a API é totalmente inicializada antes de quaisquer elementos do corpo.

Controlo de versões e retrocompatibilidade da API

No fragmento HTML anterior, o /1.1/ à frente do NO URL da office.js CDN especifica a versão incremental mais recente na versão 1 do Office.js. Uma vez que a API javaScript do Office mantém a retrocompatibilidade, a versão mais recente continuará a suportar membros da API que foram introduzidos anteriormente na versão 1.

Se planeia publicar o seu Suplemento do Office a partir do AppSource, tem de utilizar esta referência da CDN. As referências locais são adequadas somente para cenários internos, de depuração e de desenvolvimento.

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.

Ativar o IntelliSense para um projeto TypeScript

Para além de referenciar a API JavaScript do Office, conforme descrito anteriormente, também pode ativar o intelliSense para o projeto de suplemento TypeScript ao utilizar as definições de tipo de DefinitivamenteTyped. Para tal, execute o seguinte comando numa linha de comandos do sistema ativada pelo Nó (ou janela git bash) a partir da 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 Pré-visualização

As novas APIs de JavaScript são introduzidas pela primeira vez em "pré-visualização" e, mais tarde, tornam-se parte de um conjunto de requisitos numerados específico após o teste suficiente e o feedback do utilizador é adquirido.

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 gere um serviço de Office 365 com tecnologias licenciadas da Microsoft para fornecer serviços Office 365 para a China em conformidade com as leis e regulamentos locais. Os suplementos desenvolvidos para utilização neste ambiente de cloud devem utilizar a CDN correspondente. Utilize https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js em vez da referência padrão da CDN. Isto garante a conformidade contínua e proporciona um melhor desempenho do suplemento.

Confira também