参考 Office JavaScript API 库

  • 项目

Office JavaScript API 库提供外接程序可用于与 Office 应用程序交互的 API。 引用库的最简单方法是使用内容分发网络 (CDN) ，方法是在 HTML 页面的 部分中添加以下 <script> 标记 <head> 。

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

这将在外接程序首次加载时下载并缓存 Office JavaScript API 文件，以确保它使用最新实现的 Office.js 及其针对指定版本的关联文件。

重要

必须从页面的 部分内 <head> 引用 Office JavaScript API，以确保 API 在任何正文元素之前已完全初始化。

API 版本控制与后向兼容性

在上一个 HTML 代码片段中， /1/ CDN URL 中前面的 office.js 指定Office.js版本 1 内的最新增量版本。 由于 Office JavaScript API 保持向后兼容性，因此最新版本将继续支持版本 1 之前引入的 API 成员。 如果需要升级现有项目，请参阅 更新 Office JavaScript API 的版本和清单架构文件。

如果计划从 AppSource 发布 Office 加载项，则必须使用此 CDN 参考。 本地引用仅适用于内部、开发和调试应用场景。

注意

要使用预览版 API，请参考 CDN 上的 Office JavaScript API 库预览版：https://appsforoffice.microsoft.com/lib/beta/hosted/office.js。

为 TypeScript 项目启用 IntelliSense

除了如前所述引用 Office JavaScript API 外，还可以使用 DefinitelyTyped 中的类型定义为 TypeScript 外接程序项目启用 IntelliSense。 为此，请在启用 Node 的系统提示符中运行以下命令， (或 git bash 窗口) 项目文件夹的根目录。 必须安装 Node.js（包括 npm）。

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

预览 API

新的 JavaScript API 首先在“预览版”中引入，然后在进行足够的测试并获取用户反馈后成为特定编号要求集的一部分。

注意

预览 API 可能会发生变更，不适合在生产环境中使用。 我们建议你仅在测试和开发环境中试用它们。 不要在生产环境或业务关键型文档中使用预览 API。

若要使用预览 API：

适用于其他 Microsoft 365 环境的 CDN 参考

世纪互联运营和管理由许可 Microsoft 技术提供支持的Office 365服务，为中国提供符合当地法律法规的Office 365服务。 为在此云环境中使用而开发的外接程序应使用相应的 CDN。 使用 https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js 而不是 标准 CDN 引用。 这可确保持续符合性，并提供更好的外接程序性能。

另请参阅