Office 通用 API 要求集
要求集是指各组已命名的 API 成员。 Office 加载项使用清单中指定的要求集或执行运行时检查,以确定 Office 应用程序是否支持加载项所需的 API。 有关详细信息,请参阅 Office 版本和要求集。
提示
是否要查找 特定于应用程序的 API 要求集? 请参阅以下 API 要求集。
- Excel JavaScript API 要求集 (ExcelApi)
- Word JavaScript API 要求集 (WordApi)
- OneNote JavaScript API 要求集 (OneNoteApi)
- PowerPoint JavaScript API 要求集 (PowerPointApi)
- 了解 Outlook API 要求集 (MailBox)
通用 API 要求集
以下部分列出了通用 API 要求集、每个集中的方法,以及支持该要求集的 Office 客户端应用程序。 除非另行指定,否则这些 API 要求集都是第 1.1 版。
提示
需要有关 Office 应用程序和版本支持哪些加载项和要求集的信息? 请参阅 Office 外接程序的 Office 客户端应用程序和平台可用性。
ActiveView
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
AddInCommands
请参阅加载项命令要求集。
BindingEvents
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
CompressedFile
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
支持使用 Document.getFileAsync 方法时输出作为字节数组 (Office.FileType.Compressed) 的 Office Open XML (OOXML) 格式 。 |
CustomXmlParts
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
DevicePermissionService
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅 设备权限服务要求集。 |
|
DialogApi
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅 Dialog API 要求集。 |
|
DialogOrigin
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅 对话框源要求集。 | 跨域支持:
|
DocumentEvents
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
文件
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
HtmlCoercion
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为 HTML (Office.CoercionType.Html)。 |
IdentityAPI
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅 Identity API 要求集。 |
|
ImageCoercion
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅图像强制要求集。 |
|
KeyboardShortcuts
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅 键盘快捷方式要求集。 |
|
邮箱
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
请参阅了解 Outlook API 要求集。 |
MatrixBindings
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
MatrixCoercion
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为“矩阵”(数组的数组)数据结构 (Office.CoercionType.Matrix)。 |
OoxmlCoercion
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为 Open Office XML (OOXML) 格式 (Office.CoercionType.Ooxml)。 |
OpenBrowserWindowApi
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅 打开浏览器窗口 API 要求集。 |
|
PdfFile
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
支持在使用 Document.getFileAsync 方法时输出 PDF 格式 (Office.FileType.Pdf)。 |
RibbonApi
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅 功能区 API 要求集。 |
|
选择
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
Settings
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
SharedRuntime
最低 Office 应用程序支持 | 集内的方法 |
---|---|
请参阅 共享运行时要求集。 |
|
TableBindings
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
TableCoercion
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为“表格”数据结构 (Office.CoercionType.Table)。 |
TextBindings
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
|
TextCoercion
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为文本格式 (Office.CoercionType.Text)。 |
TextFile
最低 Office 应用程序支持 | 集内的方法 |
---|---|
|
支持在使用 Document.getFileAsync 方法时输出文本格式 (Office.FileType.Text)。 |
不作为要求集一部分的方法
Office JavaScript API 中的以下方法不是要求集的一部分。 如果外接程序需要这些方法中的任何一if
种,请使用<外接程序清单中的 Methods> 和 <Method> 元素声明它们是必需的,或使用 语句执行运行时检查。 有关详细信息,请参阅 指定 Office 应用程序和 API 要求。
方法名称 | 最低 Office 应用程序支持 |
---|---|
Bindings.addFromPromptAsync |
|
Document.getFilePropertiesAsync |
|
Document.getProjectFieldAsync |
|
Document.getResourceFieldAsync |
|
Document.getSelectedResourceAsync |
|
Document.getSelectedTaskAsync |
|
Document.getSelectedViewAsync |
|
Document.getTaskAsync |
|
Document.getTaskFieldAsync |
|
Document.goToByIdAsync |
|
Settings.addHandlerAsync |
|
Settings.refreshAsync |
|
Settings.removeHandlerAsync |
|
TableBinding.clearFormatsAsync |
|
TableBinding.setFormatsAsync |
|
TableBinding.setTableOptionsAsync |
|