Skip to content

[All Hosts] (installation) Preview control of choice for COM or Office add-in #5217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

Rick-Kirkham
Copy link
Contributor

@Rick-Kirkham Rick-Kirkham commented Jun 7, 2025

No description provided.

@Rick-Kirkham Rick-Kirkham changed the title [All Hosts] (installation) Preview control of choice for COM or Offic… [All Hosts] (installation) Preview control of choice for COM or Office add-in Jun 7, 2025
Copy link
Contributor

Learn Build status updates of commit 1371159:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/images/COM-preference-disable-failure.png ✅Succeeded View
docs/images/COM-preference-disable-success.png ✅Succeeded View
docs/images/COM-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit 117528f:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/images/COM-preference-disable-failure.png ✅Succeeded View
docs/images/COM-preference-disable-success.png ✅Succeeded View
docs/images/COM-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit a49906b:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error: CannotMergeCommit] Cannot merge commit a49906bde9d496f3ea0d4435a17c26f1e970a417 in branch COM-preference of repository https://github.com/OfficeDev/office-js-docs-pr into branch main (commit a7d29438d3db4934aabafe44e6ef1b0fb13b0ed4). Please follow this documentation: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ to use git.exe to resolve you content conflicts locally and then push to remote.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Contributor

Learn Build status updates of commit c9b1e96:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/COM-preference-disable-failure.png ✅Succeeded View
docs/images/COM-preference-disable-success.png ✅Succeeded View
docs/images/COM-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit 7915390:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/COM-preference-disable-failure.png ✅Succeeded View
docs/images/COM-preference-disable-success.png ✅Succeeded View
docs/images/COM-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit 122d831:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/COM-preference-disable-failure.png ✅Succeeded View
docs/images/COM-preference-disable-success.png ✅Succeeded View
docs/images/COM-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit 83e562e:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/COM-preference-disable-failure.png ✅Succeeded View
docs/images/COM-preference-disable-success.png ✅Succeeded View
docs/images/COM-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit d71a635:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/COM-preference-disable-failure.png ✅Succeeded View
docs/images/COM-preference-disable-success.png ✅Succeeded View
docs/images/COM-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit 74b40b0:

💡 Validation status: suggestions

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md 💡Suggestion View Details
docs/images/COM-preference-disable-failure.png 💡Suggestion View Details
docs/images/COM-preference-disable-success.png 💡Suggestion View Details
docs/images/COM-preference-prompt.png 💡Suggestion View Details
docs/develop/manifest-element-ordering.md ✅Succeeded View

docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md

  • Line 174, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-prompt.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.
  • Line 178, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-disable-success.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.
  • Line 182, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-disable-failure.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.

docs/images/COM-preference-disable-failure.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

docs/images/COM-preference-disable-success.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

docs/images/COM-preference-prompt.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Contributor

Learn Build status updates of commit 610bcff:

💡 Validation status: suggestions

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md 💡Suggestion View Details
docs/images/COM-preference-disable-failure.png 💡Suggestion View Details
docs/images/COM-preference-disable-success.png 💡Suggestion View Details
docs/images/COM-preference-prompt.png 💡Suggestion View Details
docs/develop/manifest-element-ordering.md ✅Succeeded View

docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md

  • Line 174, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-prompt.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.
  • Line 178, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-disable-success.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.
  • Line 182, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-disable-failure.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.

docs/images/COM-preference-disable-failure.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

docs/images/COM-preference-disable-success.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

docs/images/COM-preference-prompt.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Contributor

Learn Build status updates of commit 3d1014b:

💡 Validation status: suggestions

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md 💡Suggestion View Details
docs/images/COM-preference-disable-failure.png 💡Suggestion View Details
docs/images/COM-preference-disable-success.png 💡Suggestion View Details
docs/images/COM-preference-prompt.png 💡Suggestion View Details
docs/develop/manifest-element-ordering.md ✅Succeeded View

docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md

  • Line 174, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-prompt.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.
  • Line 178, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-disable-success.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.
  • Line 182, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/COM-preference-disable-failure.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.

docs/images/COM-preference-disable-failure.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

docs/images/COM-preference-disable-success.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

docs/images/COM-preference-prompt.png

  • Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in image names.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Contributor

Learn Build status updates of commit e0a66b6:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ⚠️Warning View Details
docs/develop/manifest-element-ordering.md ✅Succeeded View

docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md

  • Line 174, Column 1: [Warning: file-not-found - See documentation] Invalid file link: '../images/com-preference-prompt.png'.
  • Line 178, Column 1: [Warning: file-not-found - See documentation] Invalid file link: '../images/com-preference-disable-success.png'.
  • Line 182, Column 1: [Warning: file-not-found - See documentation] Invalid file link: '../images/com-preference-disable-failure.png'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Contributor

Learn Build status updates of commit 6af2bd3:

💡 Validation status: suggestions

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md 💡Suggestion View Details
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/com-preference-disable-failure.png ✅Succeeded View
docs/images/com-preference-disable-success.png ✅Succeeded View
docs/images/com-preference-prompt.png ✅Succeeded View

docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md

  • Line 174, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/com-preference-prompt.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.
  • Line 178, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/com-preference-disable-success.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.
  • Line 182, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/com-preference-disable-failure.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.


To configure which add-in is used (or give the user the choice) there is an optional **\<Effect\>** child of the **\<EquivalentAddins\>** element that has one of the following effects when the Office Add-in is installed, depending on which of two possible values it is set to.

- **DisableWithNotification**: All of the COM add-ins specified in the child **\<EquivalentAddin\>** elements will be disabled and hidden. A popup dialog notifies the user that this happening.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned in the other PR, we should update our representation of XML elements to include backticks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned in the other PR, we should update our representation of XML elements to include backticks

I created a backlog item for this.

Co-authored-by: Elizabeth Samuel <[email protected]>
Copy link
Contributor

Learn Build status updates of commit f3a3cf0:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/com-preference-disable-failure.png ✅Succeeded View
docs/images/com-preference-disable-success.png ✅Succeeded View
docs/images/com-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit 634517a:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/com-preference-disable-failure.png ✅Succeeded View
docs/images/com-preference-disable-success.png ✅Succeeded View
docs/images/com-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

> - It's supported only for Excel, PowerPoint, and Word.
> - The minimum Office version that supports the feature depends on the type of manifest that add-in has.
>
> - **Unified manifest for Microsoft 365**: ??????
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will we have the support details soon?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will we have the support details soon?

Yes. We won't merge until we have them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, understood.

Copy link
Contributor

Learn Build status updates of commit 3abc3f0:

✅ Validation status: passed

File Status Preview URL Details
docs/develop/make-office-add-in-compatible-with-existing-com-add-in.md ✅Succeeded View
docs/develop/manifest-element-ordering.md ✅Succeeded View
docs/images/com-preference-disable-failure.png ✅Succeeded View
docs/images/com-preference-disable-success.png ✅Succeeded View
docs/images/com-preference-prompt.png ✅Succeeded View

For more details, please refer to the build report.

> - It's supported only for Excel, PowerPoint, and Word.
> - The minimum Office version that supports the feature depends on the type of manifest that add-in has.
>
> - **Unified manifest for Microsoft 365**: ??????
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, understood.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants