Edit

Add-in commands requirement sets

  • Article

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.

Add-in commands are UI elements that extend the Office UI and start actions in your add-in. You can use add-in commands to add a button on the ribbon or an item to a context menu. For more information, see Add-in commands and Create add-in commands.

Note

Outlook add-ins support add-in commands, but the APIs and manifest elements that enable add-in commands in Outlook are in the Mailbox 1.3 requirement set. The AddinCommands requirement sets aren't applicable to Outlook.

The initial release of add-in commands doesn't have a corresponding requirement set (that is, there isn't an AddinCommands 1.0 requirement set). The following table lists the Office client applications that support the initial release version, and the minimum builds or versions for those applications where applicable.

Release Office on the web Office on Windows
  • Microsoft 365 subscription
  • retail perpetual
 Office on Windows
  • volume-licensed perpetual
 Office on Mac Office on iPad
Add-in commands (initial release, no requirement set) Supported Version 1603 (Build 6769.0000) Office 2021: Version 1809 (Build 10827.20150) 15.33 Not supported

The AddinCommands 1.1 requirement set introduces the ability to autoopen a task pane with documents.

The AddinCommands 1.3 requirement set introduces manifest markup that enables an add-in to customize the placement of a custom tab on the Office ribbon and to insert built-in Office ribbon controls into custom control groups. At present, PowerPoint is the only Office client that supports this requirement set.

The following table lists the add-in commands requirement sets, the supported Office client applications, and the minimum builds or versions for those applications where applicable.

Requirement set Office on the web Office on Windows
  • Microsoft 365 subscription
  • retail perpetual
 Office on Windows
  • volume-licensed perpetual
 Office on Mac Office on iPad
AddinCommands 1.3 PowerPoint: Supported PowerPoint: Version 2204 (Build 14827.10000) Not supported PowerPoint: 16.57.105.0 Not supported
AddinCommands 1.1 Supported Version 1705 (Build 8121.1000)† Office 2021: Version 1809 (Build 10827.20150)† 15.34†* Not supported

* The Office.context.requirements.isSetSupported method will erroneously return false for versions 16.9 – 16.14 (inclusive), but the requirement set is supported on these versions.

† OneNote is supported only in Office on the web.

Office versions and build numbers

To find out more about versions and build numbers, see:

Office Common API requirement sets

For information about Common API requirement sets, see Office Common API requirement sets.

See also