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 sections list 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, unless otherwise specified.

ActiveView

Office hosts Methods in set
PowerPoint on Windows
PowerPoint on the web
PowerPoint on iPad
PowerPoint on Mac
Document.getActiveViewAsync

AddInCommands

See Add-in command requirement sets.


BindingEvents

Office hosts Methods in set
Access Web Apps
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Binding.addHandlerAsync
Binding.removeHandlerAsync

CompressedFile

Office hosts Methods in set
Excel on Windows
Excel on the web
Excel on Mac
PowerPoint on Windows
PowerPoint on the web
PowerPoint on iPad
PowerPoint on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Supports output to Office Open XML (OOXML) format as a byte array
(Office.FileType.Compressed) when using the Document.getFileAsync method.

CustomXmlParts

Office hosts Methods in set
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
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 hosts Methods in set
See Dialog API requirement sets. UI.messageParent
UI.displayDialogAsync
UI.closeContainer
UI.Dialog

DocumentEvents

Office hosts Methods in set
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
OneNote on the web
PowerPoint on Windows
PowerPoint on the web
PowerPoint on iPad
PowerPoint on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Document.addHandlerAsync
Document.removeHandlerAsync

File

Office hosts Methods in set
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
PowerPoint on Windows
PowerPoint on the web
PowerPoint on iPad
PowerPoint on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Document.getFileAsync
File.closeAsync
File.getSliceAsync

HtmlCoercion

Office hosts Methods in set
OneNote on the web
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on 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

Office hosts Methods in set
See Identity API requirement sets. Auth.getAccessToken

ImageCoercion

Office hosts Methods in set
See Image Coercion requirement sets. Document.setSelectedDataAsync method

Mailbox

Office hosts Methods in set
Outlook on Windows
Outlook on the web
Outlook on Android
Outlook on Mac
Outlook on iOS
See Understanding Outlook API requirement sets.

MatrixBindings

Office hosts Methods in set
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
Word on Windows
Word on the web
Word on iPad
Word on Mac
Bindings.addFromNamedItemAsync
Bindings.addFromSelectionAsync
Bindings.getAllAsync
Bindings.getByIdAsync
Bindings.releaseByIdAsync
Binding.getDataAsync
Binding.setDataAsync

MatrixCoercion

Office hosts Methods in set
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on 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

Office hosts Methods in set
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on 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

Office hosts Methods in set
Access Web Apps

PdfFile

Office hosts Methods in set
Excel on Mac
PowerPoint on Windows
PowerPoint on the web
PowerPoint on iPad
PowerPoint on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Supports output to PDF format (Office.FileType.Pdf)
when using the Document.getFileAsync method.

Selection

Office hosts Methods in set
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
PowerPoint on Windows
PowerPoint on the web
PowerPoint on iPad
PowerPoint on Mac
Project on Windows
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Document.getSelectedDataAsync
Document.setSelectedDataAsync

Settings

Office hosts Methods in set
Access Web Apps
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
OneNote on the web
PowerPoint on Windows
PowerPoint on the web
PowerPoint on iPad
PowerPoint on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Settings.get
Settings.remove
Settings.saveAsync
Settings.set

TableBindings

Office hosts Methods in set
Access Web Apps
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Bindings.addFromNamedItemAsync
Bindings.addFromSelectionAsync
Bindings.getAllAsync
Bindings.getByIdAsync
Bindings.releaseByIdAsync
Binding.addColumnsAsync
Binding.addRowsAsync
Binding.deleteAllDataValuesAsync
Binding.getDataAsync
Binding.setDataAsync

TableCoercion

Office hosts Methods in set
Access Web Apps
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on 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

Office hosts Methods in set
Excel on Windows
Excel on the web
Excel on iPad
Excel on Mac
Word 2013 and later and Windows
Word 2016 and later on Mac
Word on the web
Word on iPad
Bindings.addFromNamedItemAsync
Bindings.addFromSelectionAsync
Bindings.getAllAsync
Bindings.getByIdAsync
Bindings.releaseByIdAsync
Binding.getDataAsync
Binding.setDataAsync

TextCoercion

Office hosts Methods in set
Excel on Windows
Excel on the web
Excel on iPad
OneNote on the web
PowerPoint on Windows
PowerPoint on the web
PowerPoint on iPad
PowerPoint on Mac
Project on Windows
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on 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

Office hosts Methods in set
Word 2013 and later on Windows
Word 2016 and later on Mac
Word on the web
Word on 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 on Windows, Excel on the web, Excel on iPad, and Excel on Mac
Document.getFilePropertiesAsync Excel on Windows, Excel on the web, Excel on iPad, Excel on Mac, PowerPoint on Windows, PowerPoint on the web, PowerPoint on iPad, PowerPoint on Mac, Word on Windows, Word on the web, Word on iPad, and Word on 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 on Windows, Excel on the web, Excel on iPad, Excel on Mac, PowerPoint on Windows, PowerPoint on the web, PowerPoint on iPad, PowerPoint on Mac, Word on Windows, Word on the web, Word on iPad, and Word on Mac
Settings.addHandlerAsync Access web apps and Excel on the web
Settings.refreshAsync Access web apps, Excel on Windows, Excel on the web, PowerPoint on Windows, PowerPoint on the web, Word, and Word on the web
Settings.removeHandlerAsync Access web apps and Excel on the web
TableBinding.clearFormatsAsync Excel on Windows, Excel on the web, Excel on iPad, and Excel on Mac
TableBinding.setFormatsAsync Excel on Windows, Excel on the web, Excel on iPad, and Excel on Mac
TableBinding.setTableOptionsAsync Excel on Windows, Excel on the web, Excel on iPad, and Excel on Mac

See also