extensionCommonCustomControlMenuItem object

Configures the items for a menu control.

Properties that reference this object type:

• root.extensions.contextMenus.menus.controls.items
• root.extensions.ribbons.tabs.groups.controls.items

Properties that reference this object type:

• root.extensions.ribbons.tabs.groups.controls.items

Syntax

Syntax

{
  "id": "{string}",
  "type": "menuItem",
  "label": "{string}",
  "icons": [
    {
      "size": {number},
      "url": "{string}"
    }
  ],
  "supertip": {
    "title": "{string}",
    "description": "{string}"
  },
  "actionId": "{string}",
  "enabled": {boolean},
  "overriddenByRibbonApi": {boolean}
}

Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique identifier for this control within the app. Maximum length is 64 characters. ",
      "maxLength": 64
    },
    "type": {
      "type": "string",
      "description": "Supported values: menuItem.",
      "enum": [
        "menuItem"
      ]
    },
    "label": {
      "type": "string",
      "description": "Displayed text for the control. Maximum length is 64 characters.",
      "maxLength": 64
    },
    "icons": {
      "type": "array",
      "minItems": 1,
      "maxItems": 3,
      "items": {
        "$ref": "#/definitions/extensionCommonIcon"
      }
    },
    "supertip": {
      "$ref": "#/definitions/extensionCommonSuperToolTip"
    },
    "actionId": {
      "type": "string",
      "description": "The ID of an action defined in runtimes. Maximum length is 64 characters.",
      "maxLength": 64
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the control is initially enabled.",
      "default": true
    },
    "overriddenByRibbonApi": {
      "type": "boolean",
      "default": "false"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "type",
    "label",
    "supertip",
    "actionId"
  ]
}

Properties

id

Specifies the ID for a menu item.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

type

Defines the menu item's control type.

Type
string

Required
✅

Constraints

Supported values
Allowed values: menuItem.

label

Specifies the text displayed for the menu item.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

icons

Configures the icons for the menu item.

Type
Array of extensionCommonIcon

Required
—

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

Supported values

supertip

Configures a supertip for the menu item. A supertip is a UI feature that displays a brief box of help information about a control when the cursor hovers over it. The box may contain multiple lines of text.

Type
extensionCommonSuperToolTip

Required
✅

Constraints

Supported values

actionId

Specifies the ID of the action that is taken when a user selects the control or menu item. The actionId must match with some runtimes.actions.id property value.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

enabled

Indicates whether the menu item is initially enabled.

Type
boolean

Required
—

Constraints

Supported values
Default value: True.

overriddenByRibbonApi

Specifies whether the menu item is hidden on application and platform combinations which support the API (Office.ribbon.requestCreateControls). This API installs custom contextual tabs on the ribbon.

Type
boolean

Required
—

Constraints

Supported values
Default value: false.

Examples

{
  "items": [
    {
      "id": "menuItem1",
      "type": "menuItem",
      "label": "Action 2",
      "supertip": {
        "title": "Action 2 Title",
        "description": "Action 2 Description"
      },
      "actionId": "action2"
    },
  ]
}