extensionCommonIcon object

Specifies properties of the image file used to represent the add-in.

Properties that reference this object type:

• root.extensions.alternates.alternateIcons.highResolutionIcon
• root.extensions.alternates.alternateIcons.icon
• root.extensions.contextMenus.menus.controls.icons
• root.extensions.contextMenus.menus.controls.items.icons
• root.extensions.ribbons.fixedControls.icons
• root.extensions.ribbons.tabs.groups.controls.icons
• root.extensions.ribbons.tabs.groups.controls.items.icons
• root.extensions.ribbons.tabs.groups.icons

Properties that reference this object type:

• root.extensions.alternates.alternateIcons.highResolutionIcon
• root.extensions.alternates.alternateIcons.icon
• root.extensions.ribbons.tabs.groups.controls.icons
• root.extensions.ribbons.tabs.groups.controls.items.icons
• root.extensions.ribbons.tabs.groups.icons

Syntax

Syntax

{
  "size": {number},
  "url": "{string}"
}

Schema

{
  "type": "object",
  "properties": {
    "size": {
      "type": "number",
      "description": "Size in pixels of the icon. Three image sizes are required (16, 32, and 80 pixels)",
      "enum": [
        16,
        20,
        24,
        32,
        40,
        48,
        64,
        80
      ]
    },
    "url": {
      "$ref": "#/definitions/httpsUrl",
      "description": "Absolute Url to the icon."
    }
  },
  "additionalProperties": false,
  "required": [
    "size",
    "url"
  ]
}

Properties

size

Specifies the size of the icon in pixels, enumerated as 16,20,24,32,40,48,64,80.

Type
number

Required
✅

Constraints

Supported values
Allowed values: 16, 20, 24, 32, 40, 48, 64, 80.

url

Specifies the full, absolute URL of the image file that is used to represent the add-in.

Type
string

Required
✅

Constraints
Maximum string length: 2048.

Supported values
The string must start with https://.

Remarks

When specifying the highResolutionIcon properties, icon image must be 128 x 128 pixels and use one of the following file formats: GIF, JPG, PNG, EXIF, BMP, TIFF. Otherwise, icon must 64 x 64 pixels and use one of the following file formats: GIF, JPG, PNG, EXIF, BMP, TIFF.

Examples

{
  "icons": [
    {
      "size": 16,
      "url": "test_16.png"
    },
    {
      "size": 32,
      "url": "test_32.png"
    },
    {
      "size": 80,
      "url": "test_80.png"
    }
  ]
}