extensionKeyboardShortcut object

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

Properties that reference this object type:

• root.extensions.keyboardShortcuts

Syntax

Syntax

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

Schema

{
  "type": "object",
  "properties": {
    "requirements": {
      "description": "Specifies the Office requirement sets.",
      "$ref": "#/definitions/requirementsExtensionElement"
    },
    "shortcuts": {
      "type": "array",
      "description": "Array of mappings from actions to the key combinations that invoke the actions.",
      "items": {
        "$ref": "#/definitions/extensionShortcut"
      },
      "minItems": 1,
      "maxItems": 20000
    },
    "keyMappingFiles": {
      "description": "Specifies the full URLs for shortcuts mapping and localization resource files that don\u0027t directly support the unified manifest.",
      "$ref": "#/definitions/keyboardShortcutsMappingFiles"
    }
  }
}

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