From ce5675fd9d1107cba622522176a0b5ff29c5a12a Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Sun, 8 Jun 2025 11:01:57 -0700 Subject: [PATCH 1/6] [All Hosts] (installation) Preview control of choice for COM or Office add-in --- docs/manifest/equivalentaddins.md | 38 ++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/manifest/equivalentaddins.md b/docs/manifest/equivalentaddins.md index 633f83afc7..ab71df9ffe 100644 --- a/docs/manifest/equivalentaddins.md +++ b/docs/manifest/equivalentaddins.md @@ -1,7 +1,7 @@ --- title: EquivalentAddins element in the manifest file description: Specifies backwards compatibility with an equivalent COM add-in, XLL, or both. -ms.date: 01/04/2022 +ms.date: 06/12/2025 ms.localizationpriority: medium --- @@ -20,6 +20,9 @@ Specifies backwards compatibility with an equivalent COM add-in, XLL, or both. For more information, see [Version overrides in the add-in only manifest](/office/dev/add-ins/develop/xml-manifest-overview#version-overrides-in-the-manifest). +> [!NOTE] +> Some child elements are not valid in the Mail schemas. See [Can contain](#can-contain). + ## Syntax ```XML @@ -36,6 +39,39 @@ For more information, see [Version overrides in the add-in only manifest](/offic - [EquivalentAddin](equivalentaddin.md) +## Can contain + +The **\** element can contain the following child element. + +|Element|Content|Mail|TaskPane| +|:-----|:-----:|:-----:|:-----:| +|[Effect](#effect)|No|No|Yes| + +### Effect + +Specifies which add-in is disabled when a COM add-in and Office Add-in conflict. There are three possible values. + +- **Enable** (default): The COM add-in is enabled and the Office Add-in is disabled and hidden on the Windows computer. Since this is the default value of **\**, this is also the behavior if the **\** element is not present. +- **DisableWithNotification**: All of the COM add-ins specified in the child **\** 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 COM add-ins specified in the child **\** elements or to disable and hide the Office Add-in. + +The following is an example. The **\** element must be after all the **\** elements. + +```xml + + ... + + + ContosoCOMAddin + COM + + UserOptionToDisable + + +``` +> [!IMPORTANT] +> The **\** element is not available in Outlook. + ## See also - [Make your custom functions compatible with XLL user-defined functions](/office/dev/add-ins/excel/make-custom-functions-compatible-with-xll-udf) From 6f49573f0af53d515129542721f6bb136a8421ab Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Mon, 9 Jun 2025 13:45:12 -0700 Subject: [PATCH 2/6] clarifications --- docs/manifest/equivalentaddins.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/manifest/equivalentaddins.md b/docs/manifest/equivalentaddins.md index ab71df9ffe..f2875698ee 100644 --- a/docs/manifest/equivalentaddins.md +++ b/docs/manifest/equivalentaddins.md @@ -49,12 +49,14 @@ The **\** element can contain the following child element. ### Effect -Specifies which add-in is disabled when a COM add-in and Office Add-in conflict. There are three possible values. +Specifies either that the COM add-in is disabled and hidden (instead of the Office Add-in) when they conflict, or specifies that the user chooses which to disable and hide. There are two possible values. -- **Enable** (default): The COM add-in is enabled and the Office Add-in is disabled and hidden on the Windows computer. Since this is the default value of **\**, this is also the behavior if the **\** element is not present. - **DisableWithNotification**: All of the COM add-ins specified in the child **\** 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 COM add-ins specified in the child **\** elements or to disable and hide the Office Add-in. +> [!NOTE] +> If the **\** element is not present, the COM add-ins are enabled and the Office Add-in is disabled and hidden on the Windows computer. + The following is an example. The **\** element must be after all the **\** elements. ```xml From 165d6ecc6822d624c744e6dcbbcf3ceb756a80d6 Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Thu, 12 Jun 2025 16:00:02 -0700 Subject: [PATCH 3/6] Update docs/manifest/equivalentaddins.md Co-authored-by: Elizabeth Samuel --- docs/manifest/equivalentaddins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest/equivalentaddins.md b/docs/manifest/equivalentaddins.md index f2875698ee..667ec5ae84 100644 --- a/docs/manifest/equivalentaddins.md +++ b/docs/manifest/equivalentaddins.md @@ -49,7 +49,7 @@ The **\** element can contain the following child element. ### Effect -Specifies either that the COM add-in is disabled and hidden (instead of the Office Add-in) when they conflict, or specifies that the user chooses which to disable and hide. There are two possible values. +Specifies either that the COM 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 add-ins specified in the child **\** 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 COM add-ins specified in the child **\** elements or to disable and hide the Office Add-in. From f3c1a321d7b2d7f38836afd72cd26f40e241aa7e Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Thu, 10 Jul 2025 16:34:02 -0700 Subject: [PATCH 4/6] update for VSTO --- docs/manifest/equivalentaddins.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/manifest/equivalentaddins.md b/docs/manifest/equivalentaddins.md index d099ab69d8..23c1331035 100644 --- a/docs/manifest/equivalentaddins.md +++ b/docs/manifest/equivalentaddins.md @@ -49,13 +49,16 @@ The **\** element can contain the following child element. ### Effect -Specifies either that the COM 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. +> [!NOTE] +> This element is not currently supported in Outlook. + +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 add-ins specified in the child **\** 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 COM add-ins specified in the child **\** elements or to disable and hide the Office Add-in. +- **DisableWithNotification**: All of the COM and VSTO add-ins specified in the child **\** 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 **\** elements or to disable and hide the Office Add-in. > [!NOTE] -> If the **\** element is not present, the COM add-ins are enabled and the Office Add-in is disabled and hidden on the Windows computer. +> If the **\** 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 **\** element must be after all the **\** elements. @@ -64,13 +67,14 @@ The following is an example. The **\** element must be after all the ** ... - ContosoCOMAddin + ContosoAddin COM UserOptionToDisable ``` + > [!IMPORTANT] > The **\** element is not available in Outlook. From 90a1d546ceeaeb4d35bfd40e2ccdde3f3a27cbf9 Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Fri, 11 Jul 2025 11:58:48 -0700 Subject: [PATCH 5/6] remove redundant note --- docs/manifest/equivalentaddins.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/manifest/equivalentaddins.md b/docs/manifest/equivalentaddins.md index 23c1331035..326e0bd381 100644 --- a/docs/manifest/equivalentaddins.md +++ b/docs/manifest/equivalentaddins.md @@ -49,9 +49,6 @@ The **\** element can contain the following child element. ### Effect -> [!NOTE] -> This element is not currently supported in Outlook. - 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 **\** elements will be disabled and hidden. A popup dialog notifies the user that this happening. From 813fabae2d85133c2d6b5d116a126a0bfeb6966d Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Fri, 11 Jul 2025 11:59:56 -0700 Subject: [PATCH 6/6] update date --- docs/manifest/equivalentaddins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest/equivalentaddins.md b/docs/manifest/equivalentaddins.md index 326e0bd381..257e1b2cae 100644 --- a/docs/manifest/equivalentaddins.md +++ b/docs/manifest/equivalentaddins.md @@ -1,7 +1,7 @@ --- title: EquivalentAddins element in the manifest file description: Specifies backwards compatibility with one or more equivalent COM or VSTO add-ins or XLLs. -ms.date: 07/12/2025 +ms.date: 07/21/2025 ms.localizationpriority: medium ---