Share via

extensionAlternateVersionsArray.alternateIcons object

  • Article

Specifies the main icons that are used to represent the add-in on older versions of Office. This property is required if the Office add-in is to be installable in Office on Mac, perpetual Office licenses, and Microsoft 365 subscription versions of Office on Windows earlier than 2304 (Build 16320.00000).

Properties that reference this object type:

Syntax

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

Properties

icon

Specifies properties of the image file used to represent the add-in in the add-in acquisition UI in an Office application for certain old versions of Office.

The file must be 64 x 64 pixels if mail is in the extensions.requirements.scopes array (or there is no extensions.requirements.scopes property in the manifest), otherwise it must be 32 x 32 pixels. The file must have one of the following file formats: GIF, JPG, PNG, EXIF, BMP, TIFF.

Important

The descendant icon.size property is ignored, but it must be present and have a valid size value. When the manifest is validated, the file specified at icon.url is opened and measured.

For more information, see Create a consistent visual identity.

Type
extensionCommonIcon

Required
✅

Constraints

Supported values

highResolutionIcon

Specifies properties of the image file used to represent the add-in on high DPI screens devices in the add-in acquisition UI in an Office application for certain old versions of Office.

The file must be 128 x 128 pixels if mail is in the extensions.requirements.scopes array (or there is no extensions.requirements.scopes property in the manifest), otherwise it must be 64 x 64 pixels. The file must have one of the following file formats: GIF, JPG, PNG, EXIF, BMP, TIFF.

Important

The descendant highResolutionIcon.size property is ignored, but it must be present and have a valid size value. When the manifest is validated, the file specified at highResolutionIcon.url is opened and measured.

For more information, see Create a consistent visual identity.

Type
extensionCommonIcon

Required
✅

Constraints

Supported values

Examples

Note

The size properties are ignored, but they must be present and have valid values. When the manifest is validated, the files are opened and measured.

{
    "alternateIcons": {
      "icon": {
        "size": 64,
        "url": "https://contoso.com/assets/icon64x64.jpg"
      },
      "highResolutionIcon": {
        "size": 64,
        "url": "https://contoso.com/assets/icon128x128.jpg"
      }
    }
}