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 application supports APIs that an add-in needs. For more information, see Office versions and requirement sets.

Tip

Looking for the application-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 client applications that support that requirement set. All of these API requirement sets are version 1.1, unless otherwise specified.

Tip

Need information about where add-ins and requirement sets are supported by Office application and version? See Office client application and platform availability for Office Add-ins.

ActiveView

Minimum Office application support Methods in set
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Document.getActiveViewAsync

AddInCommands

See Add-in command requirement sets.


BindingEvents

Minimum Office application support Methods in set
- Access Web Apps
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on Mac
- Word on the web
- Word on iPad
- Binding.addHandlerAsync
- Binding.removeHandlerAsync

CompressedFile

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2016
- Excel on the web
- Excel on Mac
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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

Minimum Office application support Methods in set
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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

Minimum Office application support Methods in set
See Dialog API requirement sets. - UI.messageParent
- UI.displayDialogAsync
- UI.closeContainer
- UI.Dialog

DialogOrigin

Minimum Office application support Methods in set
See Dialog Origin requirement sets. Cross-domain support for:
- UI.messageParent
- UI.Dialog.messageChild

DocumentEvents

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- OneNote on the web
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on Mac
- Word on the web
- Word on iPad
- Document.addHandlerAsync
- Document.removeHandlerAsync

File

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on Mac
- Word on the web
- Word on iPad
- Document.getFileAsync
- File.closeAsync
- File.getSliceAsync

HtmlCoercion

Minimum Office application support Methods in set
- OneNote on the web
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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

Minimum Office application support Methods in set
See Identity API requirement sets. - Auth.getAccessToken

ImageCoercion

Minimum Office application support Methods in set
See Image Coercion requirement sets. - Document.setSelectedDataAsync

KeyboardShortcuts

Minimum Office application support Methods in set
See Keyboard Shortcuts requirement sets. - Office.actions.areShortcutsInUse
- Office.actions.getShortcuts
- Office.actions.replaceShortcuts

Mailbox

Minimum Office application support Methods in set
- Outlook on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Outlook on the web
- Outlook on Android
- Outlook on Mac
- Outlook on iOS
See Understanding Outlook API requirement sets.

MatrixBindings

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- 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

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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

Minimum Office application support Methods in set
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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.

OpenBrowserWindowApi

Minimum Office application support Methods in set
See Open Browser Window API requirement sets. - Office.context.ui.openBrowserWindow

PartialTableBindings

Minimum Office application support Methods in set
Access Web Apps

PdfFile

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on Mac
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on Mac
- Word on the web
- Word on iPad
Supports output to PDF format (Office.FileType.Pdf)
when using the Document.getFileAsync method.

RibbonApi

Minimum Office application support Methods in set
See Ribbon API requirement sets. - Office.ribbon.requestUpdate

Selection

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Project on Windows
-- volume-licensed perpetual Office 2013
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on Mac
- Word on the web
- Word on iPad
- Document.getSelectedDataAsync
- Document.setSelectedDataAsync

Settings

Minimum Office application support Methods in set
- Access Web Apps
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- OneNote on the web
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on Mac
- Word on the web
- Word on iPad
- Settings.get
- Settings.remove
- Settings.saveAsync
- Settings.set

SharedRuntime

Minimum Office application support Methods in set
See Shared runtime requirement sets. - Office.addin.getStartupBehavior
- Office.addin.hide
- Office.addin.onVisibilityModeChanged
- Office.addin.setStartupBehavior
- Office.addin.showAsTaskpane

TableBindings

Minimum Office application support Methods in set
- Access Web Apps
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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

Minimum Office application support Methods in set
- Access Web Apps
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on Mac
- Word on the web
- Word on iPad
- Bindings.addFromNamedItemAsync
- Bindings.addFromSelectionAsync
- Bindings.getAllAsync
- Bindings.getByIdAsync
- Bindings.releaseByIdAsync
- Binding.getDataAsync
- Binding.setDataAsync

TextCoercion

Minimum Office application support Methods in set
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- OneNote on the web
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Project on Windows
-- volume-licensed perpetual Office 2013
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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

Minimum Office application support Methods in set
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word 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 Office JavaScript API 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 applications and API requirements.

Method name Minimum Office application support
Bindings.addFromPromptAsync - Access web apps
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
Document.getFilePropertiesAsync - Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on the web
- Word on iPad
- Word on Mac
Document.getProjectFieldAsync - Project Standard 2013
- Project Professional 2013
Document.getResourceFieldAsync - Project Standard 2013
- Project Professional 2013
Document.getSelectedResourceAsync - Project Standard 2013
- Project Professional 2013
Document.getSelectedTaskAsync - Project Standard 2013
- Project Professional 2013
Document.getSelectedViewAsync - Project Standard 2013
- Project Professional 2013
Document.getTaskAsync - Project Standard 2013
- Project Professional 2013
Document.getTaskFieldAsync - Project Standard 2013
- Project Professional 2013
Document.goToByIdAsync - Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- PowerPoint on iPad
- PowerPoint on Mac
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on the web
- Word on iPad
- Word on Mac
Settings.addHandlerAsync - Access web apps
- Excel on the web
Settings.refreshAsync - Access web apps
- Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- PowerPoint on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- PowerPoint on the web
- Word on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Word on the web
Settings.removeHandlerAsync - Access web apps
- Excel on the web
TableBinding.clearFormatsAsync - Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
TableBinding.setFormatsAsync - Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac
TableBinding.setTableOptionsAsync - Excel on Windows
-- Microsoft 365 subscription
-- perpetual Office 2013
- Excel on the web
- Excel on iPad
- Excel on Mac

See also