Skip to content
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

Article application applicability confusion and conflation of COM and VSTO #4558

Open
brreich opened this issue May 7, 2024 · 3 comments
Open
Assignees
Labels
Area: add-ins Feedback on add-ins content that's relevant to multiple Office hosts. Status: in backlog Issue is being tracked in the backlog but timeline for resolution is unknown Type: doc bug Problem with the documentation (e.g., doc is out of date, unclear, confusing, or broken)

Comments

@brreich
Copy link

brreich commented May 7, 2024

The article here:
https://learn.microsoft.com/en-us/office/dev/add-ins/develop/make-office-add-in-compatible-with-existing-com-add-in
is confusing in a number of ways.

Firstly, it says that the Web Add-In manifest way of defining the Equivalent Add-Ins applies to Word, Excel, PPT, and Outlook. However, immediately following this it has a section detailing how to define these equivalences for Outlook only using GPO. It is unclear whether Outlook can use EITHER method, or whether it can only use the registry policy method. If it is only GPO, then it should be removed from the list of apps for which the Web add-in manifest mechanism applies. If both, this should be explicitly called out, and it should also be clarified what happens if both the GPO and web add-in manifest information is provided for the same web add-in.

Also, this article frequently conflates VSTO and COM add-ins, which are not the same thing. For example, it repeatedly says that the "ProgId" should be used to map the native add-in to the equivalent web add-in. However, VSTO add-ins do not have "ProgID"s, since this is strictly a COM concept. VSTO add-ins have a name in the registry at the same place where COM add-ins have ProgIDs, but the way you tell the difference is whether the VSTO name key has a "Manifest" value under it which holds a path to the managed assembly that defines the entry point to the add-in for the VSTO loader to call. There is no ProgID or COM class look-up or anything like that. It is unclear whether what is really meant is that the "name" of the add-in, as defined for the key under the "AddIns" key of the registry, is what is really intended. If that really is the intent, then that wording should be used to avoid confusion. It is true that for COM add-ins this is ALSO the ProgID, but for VSTO the use of this term is unclear and confusing since it doesn't apply.

It is also unclear whether the W/X/P web add-in manifest approach to this equivalent add-in feature also supports VSTO via the name, since that documentation of the manifest schema element also seems to suggest ONLY COM (and XLL) and ONLY ProgId is supported (see "EquivalentAddIn XML Manifest Element"). But it seems from THIS article that maybe the VSTO add-in name also works? And if so, again, this is confusing and the web add-in manifest schema documentation is then inaccurate and should be updated.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs: triage 🔍 New issue, needs PM on rotation to triage ASAP label May 7, 2024
@AlexJerabek
Copy link
Collaborator

Thanks for reporting this @brreich.

@davidchesnut, could you please investigate?

@AlexJerabek AlexJerabek added Type: doc bug Problem with the documentation (e.g., doc is out of date, unclear, confusing, or broken) Needs: attention 👋 Waiting on Microsoft to provide feedback Area: add-ins Feedback on add-ins content that's relevant to multiple Office hosts. and removed Needs: triage 🔍 New issue, needs PM on rotation to triage ASAP labels May 7, 2024
@davidchesnut
Copy link
Member

Thanks @brreich, I'm checking into VSTO support for this feature. I'll add this to our backlog to get the article updated correctly. Thanks!

@davidchesnut davidchesnut added Status: in backlog Issue is being tracked in the backlog but timeline for resolution is unknown and removed Needs: attention 👋 Waiting on Microsoft to provide feedback labels May 10, 2024
@brreich
Copy link
Author

brreich commented May 12, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: add-ins Feedback on add-ins content that's relevant to multiple Office hosts. Status: in backlog Issue is being tracked in the backlog but timeline for resolution is unknown Type: doc bug Problem with the documentation (e.g., doc is out of date, unclear, confusing, or broken)
Projects
None yet
Development

No branches or pull requests

3 participants