Office common API requirement sets

Requirement sets are named groups of API members. Office Add-ins use requirement sets specified in the manifest or use a runtime check to determine whether an Office host supports APIs that an add-in needs. For more information, see Office versions and requirement sets.

Need information about where add-ins are supported by Office host? See Office Add-in host and platform availability.

Looking for the host-specific API requirement sets? See the following API requirement sets:

Important

We no longer recommend that you create and use Access web apps and databases in SharePoint. As an alternative, we recommend that you use Microsoft PowerApps to build no-code business solutions for web and mobile devices.

Common API requirement sets

The following table lists the common API requirement sets, the methods in each set, and the Office host applications that support that requirement set. All of these API requirement sets are version 1.1.

Requirement set Office host Methods in set
ActiveView PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Document.getActiveViewAsync
AddInCommands See Add-in command requirement sets.
BindingEvents Access Web Apps
Excel
Excel Online
Excel for iPad
Excel for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Binding.addHanderAsync
Binding.removeHanderAsync
CompressedFile Excel
Excel Online
Excel for iPad
Excel for Mac
PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports output to Office Open XML (OOXML) format as a byte array
(Office.FileType.Compressed) when using the Document.getFileAsync method.
CustomXmlParts Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
CustomXmlNode.getNodesAsync
CustomXmlNode.getNodeValueAsync
CustomXmlNode.getXmlAsync
CustomXmlNode.setNodeValueAsync
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 See Dialog API requirement sets. UI.messageParent
UI.displayDialogAsync
UI.closeContainer
UI.Dialog
DocumentEvents Excel
Excel Online
Excel for iPad
Excel for Mac
OneNote Online
PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Document.addHandlerAsync
Document.removeHandlerAsync
File Excel
Excel Online
Excel for iPad
Excel for Mac
PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Document.getFileAsync
File.closeAsync
File.getSliceAsync
HtmlCoercion OneNote Online
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports coercion to HTML (Office.CoercionType.Html) when reading and writing data using the Document.getSelectedDataAsync,
Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods.
IdentityAPI See Identity API requirement sets. Auth.getAccessTokenAsync
ImageCoercion Excel
Excel for iPad
Excel for Mac
OneNote Online
PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports conversion to an image (Office.CoercionType.Image) when writing data using the Document.setSelectedDataAsync method.
Mailbox Outlook for Windows
Outlook for web
Outlook for Android
Outlook for Mac
Outlook Web App
See Understanding Outlook API requirement sets.
MatrixBindings Excel
Excel Online
Excel for iPad
Excel for Mac
Word
Word Online
Word for iPad
Word for Mac
Bindings.addFromNamedItemAsync
Bindings.addFromSelectionAsync
Bindings.getAllAsync
Bindings.getByIdAsync
Bindings.releaseByIdAsyncMatrix
Binding.getDataAsyncMatrix
Binding.setDataAsync
MatrixCoercion Excel
Excel Online
Excel for iPad
Excel for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports coercion to the "matrix" (array of arrays) data structure (Office.CoercionType.Matrix) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods.
OoxmlCoercion Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports coercion to Open Office XML (OOXML) format (Office.CoercionType.Ooxml) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods.
PartialTableBindings Access Web Apps
PdfFile Excel for Mac
PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports output to PDF format (Office.FileType.Pdf)
when using the Document.getFileAsync method.
Selection Excel
Excel Online
Excel for iPad
Excel for Mac
PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Project
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Document.getSelectedDataAsync
Document.setSelectedDataAsync
Settings Access Web Apps
Excel
Excel Online
Excel for iPad
Excel for Mac
OneNote Online
PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Settings.get
Settings.remove
Settings.saveAsync
Settings.set
TableBindings Access Web Apps
Excel
Excel Online
Excel for iPad
Excel for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Bindings.addFromNamedItemAsync
Bindings.addFromSelectionAsync
Bindings.getAllAsync
Bindings.getByIdAsync
Bindings.releaseByIdAsyncTable
Binding.addColumnsAsyncTable
Binding.addRowsAsyncTable
Binding.deleteAllDataValuesAsyncTable
Binding.getDataAsyncTable
Binding.setDataAsync
TableCoercion Access Web Apps
Excel
Excel Online
Excel for iPad
Excel for Mac
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports coercion to the "table" data structure (Office.CoercionType.Table) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods.
TextBindings Excel
Excel Online
Excel for iPad
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Bindings.addFromNamedItemAsync
Bindings.addFromSelectionAsync
Bindings.getAllAsync
Bindings.getByIdAsync
Bindings.releaseByIdAsyncText
Binding.getDataAsyncText
Binding.setDataAsync
TextCoercion Excel
Excel Online
Excel for iPad
OneNote Online
PowerPoint
PowerPoint Online
PowerPoint for iPad
PowerPoint for Mac
Project
Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports coercion to text format (Office.CoercionType.Text) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods.
TextFile Word 2013 and later
Word 2016 for Mac and later
Word Online
Word for iPad
Supports output to text format (Office.FileType.Text) when using the Document.getFileAsync method.

Methods that aren't part of a requirement set

The following methods in the JavaScript API for Office aren't part of a requirement set. If your add-in requires any of these methods, use the Methods and Method elements in the add-in's manifest to declare that they are required, or perform the runtime check using an if statement. For more information, see Specify Office hosts and API requirements.

Method name Office host support
Bindings.addFromPromptAsync Access web apps, Excel, Excel Online, and Excel for iPad
Document.getFilePropertiesAsync Excel, Excel Online, Excel for iPad, Excel for Mac, PowerPoint, PowerPoint Online, PowerPoint for iPad, PowerPoint for Mac, Word, Word Online, Word for iPad, and Word for Mac
Document.getProjectFieldAsync Project Standard 2013 and Project Professional 2013
Document.getResourceFieldAsync Project Standard 2013 and Project Professional 2013
Document.getSelectedResourceAsync Project Standard 2013 and Project Professional 2013
Document.getSelectedTaskAsync Project Standard 2013 and Project Professional 2013
Document.getSelectedViewAsync Project Standard 2013 and Project Professional 2013
Document.getTaskAsync Project Standard 2013 and Project Professional 2013
Document.getTaskFieldAsync Project Standard 2013 and Project Professional 2013
Document.goToByIdAsync Excel, Excel Online, Excel for iPad, Excel for Mac, PowerPoint, PowerPoint Online, PowerPoint for iPad, PowerPoint for Mac, Word, Word Online, Word for iPad, and Word for Mac
Settings.addHandlerAsync Access web apps, Excel, Excel Online, PowerPoint, PowerPoint Online, Word, and Word Online
Settings.refreshAsync Access web apps, Excel, Excel Online, PowerPoint, PowerPoint Online, Word, and Word Online
Settings.removeHandlerAsync Access web apps, Excel, Excel Online, PowerPoint, PowerPoint Online, Word, and Word Online
TableBinding.clearFormatsAsync Excel, Excel Online, and Excel for Mac
TableBinding.setFormatsAsync Excel, Excel Online, Excel for iPad, and Excel for Mac
TableBinding.setTableOptionsAsync Excel, Excel Online, Excel for iPad, and Excel for Mac

See also