[Word, Excel, PowerPoint] Event-based activation walkthrough #5261
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
Learn Build status updates of commit e56eab6: 💡 Validation status: suggestions
docs/develop/WXP-event-based-activation.md
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. |
|
Learn Build status updates of commit eb6d9f6: 💡 Validation status: suggestions
docs/develop/WXP-event-based-activation.md
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. |
|
Learn Build status updates of commit e9887a8: 💡 Validation status: suggestions
docs/develop/WXP-event-based-activation.md
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. |
|
Learn Build status updates of commit 27d1701: 💡 Validation status: suggestions
docs/develop/WXP-event-based-activation.md
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. |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces documentation for the new event-based activation feature for Word, Excel, and PowerPoint add-ins, including a walkthrough on handling the onDocumentOpened event.
- Updated table of contents to include a new section for non-Outlook event-based activation.
- Added a detailed walkthrough document with manifest configuration, event handler code, and testing instructions.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/toc.yml | Added a new TOC entry for implementing event-based activation |
| docs/develop/WXP-event-based-activation.md | New walkthrough document explaining event-based activation for add-ins |
Comments suppressed due to low confidence (1)
docs/toc.yml:122
- The new TOC item is missing an 'href' property which is required for navigation consistency with other entries. Consider adding the appropriate 'href' linking to the walkthrough document.
- name: Implement event-based activation in non-Outlook add-ins
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Learn Build status updates of commit 431d1c4: 💡 Validation status: suggestions
docs/develop/WXP-event-based-activation.md
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. |
…eDev/office-js-docs-pr into WXP-event-based-activation
|
Learn Build status updates of commit 373346c: 💡 Validation status: suggestions
docs/develop/WXP-event-based-activation.md
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. |
| ms.localizationpriority: medium | ||
| --- | ||
|
|
||
| # Implement event-based activation in Excel, PowerPoint, and Word add-ins |
There was a problem hiding this comment.
If this feature is in preview, we should add that to the title.
| # Implement event-based activation in Excel, PowerPoint, and Word add-ins | |
| # Implement event-based activation in Excel, PowerPoint, and Word add-ins (preview) |
If it is not in preview, let's position it as the generic overview for the feature for all Office apps. There's a note directing readers to the special Outlook article.
| # Implement event-based activation in Excel, PowerPoint, and Word add-ins | |
| # Implement event-based activation |
There was a problem hiding this comment.
I planned on integrating this article with the Outlook one in a more thorough way, but the feature is GA and I want to get something out. If you think I should not have this middle state, I'll reconcile it now.
There was a problem hiding this comment.
OK. Let's wait till you think it's the right time.
|
|
||
| 1. Run `npm run build` to rebuild the project. | ||
| 1. Run `npm start` to launch the web server. **Ignore the Word document that is opened**. | ||
| 1. Manually sideload your add-in in Word on the web by following the guidance at [Sideload Office Add-ins to Office on the web](../testing/sideload-office-add-ins-for-testing.md#manually-sideload-an-add-in-to-office-on-the-web). |
There was a problem hiding this comment.
Am I right in thinking that we sideload on the web because sideloading on Windows is not Centrally Deployed, so it wouldn't work? If so, I think we should explain that here. If not, why do we not sideload on Windows as we do in most quickstarts/tutorials?
There was a problem hiding this comment.
The auto-sideload npm start performs doesn't (seem to) work. There doesn't appear to be a way to sideload on Windows without using a network share any more. That process I find to be a ton of work and if someone if just loading the add-in to test, they're better off using the browser, IMO.
I'll add a comment.
There was a problem hiding this comment.
I've sent mail to @wangyun-microsoft about this.
Co-authored-by: Rick Kirkham <Rick-Kirkham@users.noreply.github.com>
…eDev/office-js-docs-pr into WXP-event-based-activation
|
Learn Build status updates of commit 228a1da: 💡 Validation status: suggestions
docs/develop/WXP-event-based-activation.md
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. |
|
Learn Build status updates of commit c350c5f: 💡 Validation status: suggestions
docs/develop/WXP-event-based-activation.md
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. |
|
Learn Build status updates of commit 008aea3: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit 6cebca6: ✅ Validation status: passed
For more details, please refer to the build report. |
Co-authored-by: Elizabeth Samuel <elizs@microsoft.com>
|
Thanks @ElizabethSamuel-MSFT! I've reviewed and applied your suggestions. Good to check in? |
|
Learn Build status updates of commit 9dbd40d: ✅ Validation status: passed
For more details, please refer to the build report. |
This article describes the new event-based activation feature for WXP. It provides a walkthrough on the currently supported
onDocumentOpenedevent in Word.