了解 Office JavaScript API

Office 加载项可使用 Office JavaScript API 来与其中在运行加载项的 Office 文档中的内容进行交互。

访问 Office JavaScript API 库

可通过 Office JS 内容交付网络 (CDN) 访问 Office JavaScript API 库:https://appsforoffice.microsoft.com/lib/1/hosted/office.js 要在任何加载项的网页中使用 Office JavaScript API,必须在页面的 <head> 标记中的 <script> 标记内引用 CDN。

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

备注

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

要详细了解如何访问 Office JavaScript API 库(包括如何获取 IntelliSense),请参阅通过 Office JavaScript API 的内容交付网络 (CDN) 引用该库

API 模型

Office JavaScript API 包含两种不同的模型:

  • 应用程序特定的 API 提供了强类型对象,它可用于与特定 Office 应用程序的本机对象进行交互。 例如,可使用 Excel JavaScript API 来访问工作表、区域、表格和图表等。 应用程序特定的 API 当前可用于以下 Office 应用程序。

    此 API 模型使用的是承诺,你可用它在你发送给 Office 应用程序的每个请求中指定多个操作。 通过以这种方式进行批处理操作,可大幅提升网页版 Office 应用程序中的加载项的性能。 应用程序特定的 API 是随 Office 2016 引入的,不可用于与 Office 2013 进行交互。

    备注

    还有一个应用程序特定的 Visio API,但它只能在 SharePoint Online 页面中用于与已嵌入到页面中的 Visio 图表进行交互。 Visio 不支持 Office Web 加载项。

    请参阅 使用特定于应用程序的 API 模型,以了解有关此 API 模型的详细信息。

  • 通用 API 可用于访问在多种类型的 Office 应用程序中都很常见的 UI、对话框和客户端设置等功能。 此 API 模型使用的是回调,这样,你在发送给 Office 应用程序的每个请求中只能指定一个操作。 通用 API 是随 Office 2013 引入的,可用于与 Office 2013 或更高版本进行交互。 要详细了解通用 API 对象模型(其中包括用于与 Outlook、PowerPoint 和 Project 交互的 API),请参阅常见 JavaScript API 对象模型

备注

某些 Excel 自定义函数在排列了计算执行优先级的唯一运行时中运行,并且没有任务窗格。 这些函数将使用略有不同的编程模型,且被称为无用户界面的函数。

API 要求集

要求集 是已命名的 API 成员组。要求集可特定于 Office 应用程序,例如 ExcelApi 1.7 要求集(一组仅可在 Excel 中使用的 API),也可通用于多个应用程序,例如 DialogApi 1.1 要求集(一组可在支持对话框 API 的任何 Office 应用程序中使用的 API)。

加载项可使用要求集来确定 Office 应用程序是否支持需要使用的 API 成员。 有关详细信息,请参阅指定 Office 应用程序和 API 要求

要求集支持因 Office 应用程序、版本和平台而异。有关每个 Office 应用程序支持的平台、要求集和通用 API 的详细信息,请参阅 适用于 Office 加载项的 Office 客户端应用程序和平台可用性

备注

如果计划将加载项 发布 到 AppSource 并使其在 Office 体验中可用,请务必确保遵循 商业市场认证策略。例如,要通过验证,加载项必须适用于支持已定义方法的所有平台(有关详细信息,请参阅 第 1120.3 部分 以及 Office 加载项应用程序和可用性页面)。

另请参阅