Skip to content

Commit 3adb6e1

Browse files
[All hosts] (event-based activation) Note limitation of initialization methods on Windows clients (#5310)
* Note initialization method limitation for classic Outlook on Windows * Update client support * Update note
1 parent 3337c9f commit 3adb6e1

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

docs/develop/event-based-activation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ When developing an event-based add-in to run on a Windows client, be mindful of
120120
- **Unified manifest for Microsoft 365**: `"script"` property of the `"code"` object
121121

122122
Note that a large JavaScript bundle may cause issues with the performance of your add-in. We recommend preprocessing heavy operations, so that they're not included in your event-handling code.
123-
- When the JavaScript function specified in the manifest to handle an event runs, code in `Office.onReady()` and `Office.initialize` isn't run. We recommend adding any startup logic needed by event handlers, such as checking the user's Outlook version, to the event handlers instead.
123+
- When the JavaScript function specified in the manifest to handle an event runs, code in `Office.onReady()` and `Office.initialize` isn't run. We recommend adding any startup logic needed by event handlers, such as checking the user's client version, to the event handlers instead.
124124

125125
### Event-based add-in limitations in Excel, PowerPoint, and Word
126126

docs/testing/troubleshoot-event-based-and-spam-reporting-add-ins.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Troubleshoot event-based and spam-reporting add-ins
33
description: Learn how to troubleshoot development errors in Office Add-ins that implement event-based activation or integrated spam reporting.
4-
ms.date: 07/15/2025
4+
ms.date: 08/05/2025
55
ms.topic: troubleshooting
66
ms.localizationpriority: medium
77
---
@@ -28,6 +28,9 @@ As you develop your [event-based](../develop/event-based-activation.md) or [spam
2828
- Verify that the `<Runtimes>` element (add-in only manifest) or `"extensions.runtimes.code"` property (unified manifest) correctly references the HTML or JavaScript file containing the event handlers. Classic Outlook on Windows and other Windows-based Office applications use the JavaScript file during runtime, while Office on the web, the new Outlook Mac UI, and [new Outlook on Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) use the HTML file. For an example of how this is configured in the manifest, see the "Configure the manifest" section of [Automatically set the subject of a new message or appointment](../outlook/on-new-compose-events-walkthrough.md#configure-the-manifest).
2929

3030
For Windows clients (except for new Outlook on Windows), you must bundle all your event-handling JavaScript code into this JavaScript file referenced in the manifest. Note that a large JavaScript bundle may cause issues with the performance of your add-in. We recommend preprocessing heavy operations, so that they're not included in your event-handling code.
31+
32+
- For Windows clients (except for new Outlook on Windows), when the JavaScript function specified in the manifest to handle an event runs, code in `Office.onReady()` and `Office.initialize` isn't run. We recommend adding any startup logic needed by event handlers, such as checking the user's client version, to the event handlers instead.
33+
3134
- Verify that your event-handling JavaScript file calls `Office.actions.associate`. This ensures that the event handler name specified in the manifest is mapped to its JavaScript counterpart. The following code is an example.
3235

3336
```js

0 commit comments

Comments
 (0)