Share via

extensionKeyboardShortcut object

Keyboard shortcuts, also known as key combinations, enable your add-in's users to work more efficiently. Keyboard shortcuts also improve the add-in's accessibility for users with disabilities by providing an alternative to the mouse.

Properties that reference this object type:

Syntax

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "shortcuts": [
    {
      "key": {
        extensionKeyCombination object
      },
      "actionId": "{string}"
    }
  ],
  "keyMappingFiles": {
    "shortcutsUrl": "{string}",
    "localizationResourceUrl": "{string}"
  }
}

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "shortcuts": [
    {
      "key": {
        extensionKeyCombination object
      },
      "actionId": "{string}"
    }
  ]
}

Properties

requirements

Specifies the Office requirement sets.

Type
requirementsExtensionElement

Required
—

Constraints

Supported values

shortcuts

Array of mappings from actions to the key combinations that invoke the actions.

Type
Array of extensionShortcut

Required
✅

Constraints
Minimum array items: 1. Maximum array items: 20000.

Supported values

keyMappingFiles

Specifies the full URLs for shortcuts mapping and localization resource files that don't directly support the unified manifest.

Type
keyboardShortcutsMappingFiles

Required
—

Constraints

Supported values