Edit

Share via

EquivalentAddins element

Specifies compatibility with one or more equivalent COM add-ins, VSTO add-ins, or XLLs.

Important

The equivalent add-in feature is supported by the following platform and applications. COM and VSTO add-ins can't be installed on any other platform, so on those platforms the manifest element that's discussed later in this article is ignored.

  • Excel, Word, and PowerPoint on Windows (Version 1904 or later)
  • Outlook on Windows (Version 2102 or later) against a supported Exchange server version
    • Exchange Online
    • Exchange 2019 Cumulative Update 10 or later (KB5003612)
    • Exchange 2016 Cumulative Update 21 or later (KB5003611)

Add-in type: Task pane, Mail, Custom function

Valid only in these VersionOverrides schemas:

  • Task pane 1.0
  • Mail 1.1

For more information, see Version overrides in the add-in only manifest.

Note

Some child elements are not valid in the Mail schemas. See Can contain.

Syntax

<EquivalentAddins>
...  
</EquivalentAddins>

Contained in

Must contain

Can contain

The <EquivalentAddins> element can contain the following child element.

Element Content Mail TaskPane
Effect No No Yes

Effect

Specifies either that the COM or VSTO add-in is disabled and hidden (instead of the Office Web Add-in) when they conflict, or specifies that the user chooses which to disable and hide. There are two possible values.

  • DisableWithNotification: All of the COM and VSTO add-ins specified in the child <EquivalentAddin> elements will be disabled and hidden. A popup dialog notifies the user that this happening.
  • UserOptionToDisable: The user is prompted to choose whether to disable and hide the COM and VSTO add-ins specified in the child <EquivalentAddin> elements or to disable and hide the Office Add-in.

Note

If the <Effect> element is not present, the COM and VSTO add-ins are enabled and the Office Add-in is disabled and hidden on the Windows computer.

The following is an example. The <Effect> element must be after all the <EquivalentAddin> elements.

<VersionOverrides>
  ...
  <EquivalentAddins>
    <EquivalentAddin>
      <ProgId>ContosoAddin</ProgId>
      <Type>COM</Type>
    </EquivalentAddin>
    <Effect>UserOptionToDisable</Effect>
  </EquivalentAddins>
</VersionOverrides>

Important

The <Effect> element is not available in Outlook.

See also