Office 通用 API 要求集

要求集是指各组已命名的 API 成员。 Office 加载项使用清单中指定的要求集或执行运行时检查,以确定 Office 应用程序是否支持加载项所需的 API。 有关详细信息,请参阅 Office 版本和要求集

提示

是否要查找 特定于应用程序的 API 要求集? 请参阅以下 API 要求集。

重要

我们不建议在 SharePoint 中创建和使用 Access Web 应用和数据库。 作为一种替代方法,我们建议你使用 Microsoft PowerApps 生成适用于 Web 和移动设备的无代码业务解决方案。

通用 API 要求集

以下部分列出了通用 API 要求集、每个集中的方法,以及支持该要求集的 Office 客户端应用程序。 除非另行指定,否则这些 API 要求集都是第 1.1 版。

提示

需要有关 Office 应用程序和版本支持哪些加载项和要求集的信息? 请参阅 Office 外接程序的 Office 客户端应用程序和平台可用性

ActiveView

最低 Office 应用程序支持 集内的方法
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Document.getActiveViewAsync

AddInCommands

请参阅加载项命令要求集


BindingEvents

最低 Office 应用程序支持 集内的方法
- 访问Web 应用
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
- Binding.addHandlerAsync
- Binding.removeHandlerAsync

CompressedFile

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2016
- Excel web 版
- Mac 上的 Excel
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
支持使用 Document.getFileAsync 方法时输出作为字节数组 (Office.FileType.Compressed) 的 Office Open XML (OOXML) 格式

CustomXmlParts

最低 Office 应用程序支持 集内的方法
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
- CustomXmlNode.getNodesAsync
- CustomXmlNode.getNodeValueAsync
- CustomXmlNode.getTextAsync
- CustomXmlNode.getXmlAsync
- CustomXmlNode.setNodeValueAsync
- CustomXmlNode.setTextAsync
- CustomXmlNode.setXmlAsync
- CustomXmlPart.addHandlerAsync
- CustomXmlPart.deleteAsync
- CustomXmlPart.getNodesAsync
- CustomXmlPart.getXmlAsync
- CustomXmlPart.removeHandlerAsync
- CustomXmlParts.addAsync
- CustomXmlParts.getByIdAsync
- CustomXmlParts.getByNamespaceAsync
- CustomXmlPrefixMappings.addNamespaceAsync
- CustomXmlPrefixMappings.getNamespaceAsync
- CustomXmlPrefixMappings.getPrefixAsync

DialogApi

最低 Office 应用程序支持 集内的方法
请参阅 Dialog API 要求集 - UI.messageParent
- UI.displayDialogAsync
- UI.closeContainer
-Ui。对话 框

DialogOrigin

最低 Office 应用程序支持 集内的方法
请参阅 对话框源要求集 跨域支持:
- UI.messageParent
-Ui。Dialog.messageChild

DocumentEvents

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- OneNote web 版
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
- Document.addHandlerAsync
- Document.removeHandlerAsync

文件

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
- Document.getFileAsync
- File.closeAsync
- File.getSliceAsync

HtmlCoercion

最低 Office 应用程序支持 集内的方法
- OneNote web 版
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为 HTML (Office.CoercionType.Html)。

IdentityAPI

最低 Office 应用程序支持 集内的方法
请参阅 Identity API 要求集 - Auth.getAccessToken

ImageCoercion

最低 Office 应用程序支持 集内的方法
请参阅图像强制要求集 - Document.setSelectedDataAsync

KeyboardShortcuts

最低 Office 应用程序支持 集内的方法
请参阅 键盘快捷方式要求集 - Office.actions.areShortcutsInUse
- Office.actions.getShortcuts
- Office.actions.replaceShortcuts

邮箱

最低 Office 应用程序支持 集内的方法
- Windows 上的 Outlook
-- Microsoft 365 订阅
-- 永久 Office 2013
- Outlook 网页版
- Android 版 Outlook
- Outlook on Mac
- iOS 版 Outlook
请参阅了解 Outlook API 要求集

MatrixBindings

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Word 网页版
- iPad 上的 Word
- Mac 上的 Word
- Bindings.addFromNamedItemAsync
- Bindings.addFromSelectionAsync
- Bindings.getAllAsync
- Bindings.getByIdAsync
- Bindings.releaseByIdAsync
- Binding.getDataAsync
- Binding.setDataAsync

MatrixCoercion

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为“矩阵”(数组的数组)数据结构 (Office.CoercionType.Matrix)。

OoxmlCoercion

最低 Office 应用程序支持 集内的方法
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为 Open Office XML (OOXML) 格式 (Office.CoercionType.Ooxml)。

OpenBrowserWindowApi

最低 Office 应用程序支持 集内的方法
请参阅 打开浏览器窗口 API 要求集 - Office.context.ui.openBrowserWindow

PartialTableBindings

最低 Office 应用程序支持 集内的方法
Access Web 应用

PdfFile

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- Mac 上的 Excel
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
支持使用 Document.getFileAsync 方法时输出 PDF 格式 (Office.FileType.Pdf)

RibbonApi

最低 Office 应用程序支持 集内的方法
请参阅 功能区 API 要求集 - Office.ribbon.requestUpdate

选择

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的项目
-- 批量许可永久 Office 2013
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
- Document.getSelectedDataAsync
- Document.setSelectedDataAsync

设置

最低 Office 应用程序支持 集内的方法
- 访问Web 应用
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- OneNote web 版
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
- Settings.get
- Settings.remove
- Settings.saveAsync
- Settings.set

SharedRuntime

最低 Office 应用程序支持 集内的方法
请参阅 共享运行时要求集 - Office.addin.getStartupBehavior
- Office.addin.hide
- Office.addin.onVisibilityModeChanged
- Office.addin.setStartupBehavior
- Office.addin.showAsTaskpane
- Office.BeforeDocumentCloseNotification.disable
- Office.BeforeDocumentCloseNotification.enable
- Office.BeforeDocumentCloseNotification.onCloseActionCancelled

TableBindings

最低 Office 应用程序支持 集内的方法
- 访问Web 应用
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
- Bindings.addFromNamedItemAsync
- Bindings.addFromSelectionAsync
- Bindings.getAllAsync
- Bindings.getByIdAsync
- Bindings.releaseByIdAsync
- Binding.addColumnsAsync
- Binding.addRowsAsync
- Binding.deleteAllDataValuesAsync
- Binding.getDataAsync
- Binding.setDataAsync

TableCoercion

最低 Office 应用程序支持 集内的方法
- 访问Web 应用
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为“表格”数据结构 (Office.CoercionType.Table)。

TextBindings

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
- Bindings.addFromNamedItemAsync
- Bindings.addFromSelectionAsync
- Bindings.getAllAsync
- Bindings.getByIdAsync
- Bindings.releaseByIdAsync
- Binding.getDataAsync
- Binding.setDataAsync

TextCoercion

最低 Office 应用程序支持 集内的方法
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- OneNote web 版
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的项目
-- 批量许可永久 Office 2013
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
支持在使用 Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync 或 Binding.setDataAsync 方法读取和写入数据时强制转换为文本格式 (Office.CoercionType.Text)。

TextFile

最低 Office 应用程序支持 集内的方法
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Mac 上的 Word
- Word 网页版
- iPad 上的 Word
支持在使用 Document.getFileAsync 方法时输出文本格式 (Office.FileType.Text)。

不作为要求集一部分的方法

Office JavaScript API 中的以下方法不属于要求集。 如果外接程序需要这些方法中的任何一if种,请使用<外接程序清单中的 Methods><Method> 元素声明它们是必需的,或使用 语句执行运行时检查。 有关详细信息,请参阅 指定 Office 应用程序和 API 要求

方法名称 最低 Office 应用程序支持
Bindings.addFromPromptAsync - 访问 Web 应用
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
Document.getFilePropertiesAsync - Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Word 网页版
- iPad 上的 Word
- Mac 上的 Word
Document.getProjectFieldAsync - 2013 Project Standard
- 2013 Project Professional
Document.getResourceFieldAsync - 2013 Project Standard
- 2013 Project Professional
Document.getSelectedResourceAsync - 2013 Project Standard
- 2013 Project Professional
Document.getSelectedTaskAsync - 2013 Project Standard
- 2013 Project Professional
Document.getSelectedViewAsync - 2013 Project Standard
- 2013 Project Professional
Document.getTaskAsync - 2013 Project Standard
- 2013 Project Professional
Document.getTaskFieldAsync - 2013 Project Standard
- 2013 Project Professional
Document.goToByIdAsync - Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- iPad 上的 PowerPoint
- Mac 上的 PowerPoint
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Word 网页版
- iPad 上的 Word
- Mac 上的 Word
Settings.addHandlerAsync - 访问 Web 应用
- Excel web 版
Settings.refreshAsync - 访问 Web 应用
- Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- Windows 上的 PowerPoint
-- Microsoft 365 订阅
-- 永久 Office 2013
- PowerPoint web 版
- Windows 上的 Word
-- Microsoft 365 订阅
-- 永久 Office 2013
- Word 网页版
Settings.removeHandlerAsync - 访问 Web 应用
- Excel web 版
TableBinding.clearFormatsAsync - Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
TableBinding.setFormatsAsync - Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel
TableBinding.setTableOptionsAsync - Windows 上的 Excel
-- Microsoft 365 订阅
-- 永久 Office 2013
- Excel web 版
- iPad 上的 Excel
- Mac 上的 Excel

另请参阅