You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[all hosts] (Event-based activation) Reconcile Outlook and WXP autorun information (#2307)
* Reconcile Outlook and WXP autorun information
* Remove extra links
* Apply suggestions from code review
Co-authored-by: Sam Ramon <[email protected]>
* Reorganize ExtensionPoint article
* Apply suggestions from code review
Co-authored-by: Sam Ramon <[email protected]>
* PR feedback'
* Remove Outlook notes for events in Runtime manifest article
---------
Co-authored-by: Sam Ramon <[email protected]>
> For the shared JavaScript runtime, this element enables the ribbon, task pane, and other supported components to use the same runtime. However, the SharedRuntime requirement set is only available in some Office applications. For more information, see [Shared runtime requirement sets](/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets).
3
2
>
4
-
> **Outlook**
5
-
>
6
-
> - For event-based activation, this element enables your add-in to run on composing a new item, for example. For supported clients and other information, see [Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch).
3
+
> - For the shared JavaScript runtime, this element enables the ribbon, task pane, and other supported components to use the same runtime. However, the SharedRuntime requirement set is only available in some Office applications. For more information, see [Shared runtime requirement sets](/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets).
4
+
> - For event-based activation, this element enables your add-in to run on composing a new item, for example. For supported clients and other information, see [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation).
7
5
> - For integrated spam reporting (preview), this element enables your add-in to process unsolicited messages. To learn more about how to implement the integrated spam reporting feature in your add-in, see [Implement an integrated spam-reporting add-in (preview)](/office/dev/add-ins/outlook/spam-reporting).
8
6
>
9
7
> Note that the event-based activation and integrated spam reporting features must use the same runtime. Multiple runtimes aren't currently supported in Outlook.
Copy file name to clipboardExpand all lines: docs/manifest/extensionpoint.md
+33-30Lines changed: 33 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
---
2
2
title: ExtensionPoint element in the manifest file
3
3
description: Defines where an add-in exposes functionality in the Office UI.
4
-
ms.date: 03/11/2025
4
+
ms.date: 07/11/2025
5
5
ms.localizationpriority: medium
6
6
---
7
7
8
8
# ExtensionPoint element
9
9
10
10
Defines where an add-in exposes functionality in the Office UI. The **\<ExtensionPoint\>** element is a child element of [AllFormFactors](allformfactors.md), [DesktopFormFactor](desktopformfactor.md) or [MobileFormFactor](mobileformfactor.md).
@@ -25,6 +25,37 @@ For more information, see [Version overrides in the add-in only manifest](/offic
25
25
|:-----|:-----:|:-----|
26
26
|**xsi:type**| Yes | The type of extension point being defined. Possible values depend on the Office host application defined in the grandparent **\<Host\>** element value.|
27
27
28
+
## Extension points for Excel, Outlook, PowerPoint, and Word
29
+
30
+
-[LaunchEvent](#launchevent) - Activates tasks based on application events, such as opening.
31
+
32
+
### LaunchEvent
33
+
34
+
This extension point enables an add-in to activate based on supported events in both the desktop and mobile form factors. To learn more about event-based activation and for the full list of supported events, see [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation).
35
+
36
+
> [!IMPORTANT]
37
+
> Registering [Mailbox](../requirement-sets/outlook/preview-requirement-set/office.context.mailbox.md#events) and [Item](../requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item.md#events) events is not available with this extension point.
38
+
39
+
#### Child elements
40
+
41
+
| Element | Description |
42
+
|:-----|:-----|
43
+
|[LaunchEvents](launchevents.md)| List of [LaunchEvent](launchevent.md) for event-based activation. |
44
+
|[SourceLocation](customfunctionssourcelocation.md)| The location of the source JavaScript file. |
@@ -445,33 +475,6 @@ The images specified in the **\<Icon\>** element should be in grayscale using he
445
475
</ExtensionPoint>
446
476
```
447
477
448
-
### LaunchEvent
449
-
450
-
This extension point enables an add-in to activate based on supported events in both the desktop and mobile form factors. To learn more about event-based activation and for the full list of supported events, see [Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch).
451
-
452
-
> [!IMPORTANT]
453
-
> Registering [Mailbox](../requirement-sets/outlook/preview-requirement-set/office.context.mailbox.md#events) and [Item](../requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item.md#events) events is not available with this extension point.
454
-
455
-
#### Child elements
456
-
457
-
| Element | Description |
458
-
|:-----|:-----|
459
-
|[LaunchEvents](launchevents.md)| List of [LaunchEvent](launchevent.md) for event-based activation. |
460
-
|[SourceLocation](customfunctionssourcelocation.md)| The location of the source JavaScript file. |
<!-- Identifies the runtime to be used (also referenced by the Runtime element). -->
471
-
<SourceLocationresid="WebViewRuntime.Url"/>
472
-
</ExtensionPoint>
473
-
```
474
-
475
478
### Events
476
479
477
480
This extension point adds an event handler for a specified event. For more information about using this extension point, see [On-send feature for Outlook add-ins](/office/dev/add-ins/outlook/outlook-on-send-addins).
Copy file name to clipboardExpand all lines: docs/manifest/launchevent.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,20 @@
1
1
---
2
2
title: LaunchEvent in the manifest file
3
3
description: The LaunchEvent element configures your add-in to activate based on supported events.
4
-
ms.date: 06/11/2024
4
+
ms.date: 07/02/2025
5
5
ms.localizationpriority: medium
6
6
---
7
7
8
8
# LaunchEvent element
9
9
10
-
Configures your add-in to activate based on supported events. Child of the [LaunchEvents](launchevents.md) element. For more information, see [Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch).
10
+
Configures your add-in to activate based on supported events. Child of the [LaunchEvents](launchevents.md) element. For more information, see [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation).
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).
19
20
@@ -45,7 +46,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic
45
46
46
47
| Attribute | Required | Description |
47
48
|:-----|:-----:|:-----|
48
-
|**Type**| Yes | Specifies a supported event type. For the set of supported types, see the "Event canonical name and add-in only manifest name" column of the table of supported events in [Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch#supported-events). |
49
+
|**Type**| Yes | Specifies a supported event type. For the set of supported types, see the "Event canonical name and add-in only manifest name" column of the table of supported events in [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation#supported-events). |
49
50
|**FunctionName**| Yes | Specifies the name of the JavaScript function to handle the event specified in the `Type` attribute. |
50
51
|**SendMode**| No | Used by the `OnMessageSend` and `OnAppointmentSend` events. Specifies the options available to the user if your add-in stops an item from being sent or if the add-in is unavailable. If the **SendMode** property isn't included, the `SoftBlock` option is set by default. For a list of available send mode options, see [Available send mode options](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#available-send-mode-options). |
51
52
|**HeaderName** (preview) | No | Specifies the internet header name used to identify a message on which the `OnMessageReadWithCustomHeader` event occurs. The `Type` attribute must be set to `OnMessageReadWithCustomHeader`. |
@@ -59,7 +60,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic
59
60
## See also
60
61
61
62
-[LaunchEvents](launchevents.md)
62
-
-[Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch#supported-events)
63
+
-[Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation)
63
64
-[Handle OnMessageSend and OnAppointmentSend events in your Outlook add-in with Smart Alerts](/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events)
64
65
-[Automatically check for an attachment before a message is sent](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough)
65
66
-[Automatically update your signature when switching between Exchange accounts](/office/dev/add-ins/outlook/onmessagefromchanged-onappointmentfromchanged-events)
Copy file name to clipboardExpand all lines: docs/manifest/launchevents.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,20 @@
1
1
---
2
2
title: LaunchEvents in the manifest file
3
3
description: The LaunchEvents element configures your add-in to activate based on supported events.
4
-
ms.date: 01/18/2024
4
+
ms.date: 07/02/2025
5
5
ms.localizationpriority: medium
6
6
---
7
7
8
8
# LaunchEvents element
9
9
10
-
Configures your add-in to activate based on supported events. Child of the [ExtensionPoint](extensionpoint.md) element. For more information, see [Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch).
10
+
Configures your add-in to activate based on supported events. Child of the [ExtensionPoint](extensionpoint.md) element. For more information, see [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation).
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).
19
20
@@ -32,7 +33,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic
@@ -43,6 +44,6 @@ For more information, see [Version overrides in the add-in only manifest](/offic
43
44
## See also
44
45
45
46
-[LaunchEvent](launchevent.md)
46
-
-[Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch#supported-events)
47
+
-[Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation)
47
48
-[Use Smart Alerts and the OnMessageSend event in your Outlook add-in](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough)
48
49
-[Automatically update your signature when switching between Exchange accounts](/office/dev/add-ins/outlook/onmessagefromchanged-onappointmentfromchanged-events)
Copy file name to clipboardExpand all lines: docs/manifest/override.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -198,17 +198,17 @@ The **\<Override\>** element for `RequirementToken` must contain the following c
198
198
## Override element for `Runtime`
199
199
200
200
> [!IMPORTANT]
201
-
> Support for this element was introduced in [Mailbox requirement set 1.10](../requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10.md)with the [event-based activation feature](/office/dev/add-ins/outlook/autolaunch). See [clients and platforms](/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets#requirement-sets-supported-by-exchange-servers-and-outlook-clients) that support this requirement set.
201
+
> Support for this element was introduced with the [event-based activation feature](/office/dev/add-ins/develop/event-based-activation). See [the list of supported events](/office/dev/add-ins/develop/event-based-activation#supported-events) to learn when support was enabled for each event in each Office application.
202
202
203
-
An **\<Override\>** element expresses a conditional and can be read as an "If ... then ..." statement. If the **\<Override\>** element is of type **RuntimeOverride**, then the `type` attribute is the condition, and the `resid` attribute is the consequent. For example, the following is read "If the type is 'javascript', then the `resid` is 'JSRuntime.Url'." Outlook on Windows requires this element for [LaunchEvent extension point](/office/dev/add-ins/reference/manifest/extensionpoint#launchevent) and [ReportPhishingCommandSurface extension point (preview)](/javascript/api/manifest/extensionpoint) handlers.
203
+
An **\<Override\>** element expresses a conditional and can be read as an "If ... then ..." statement. If the **\<Override\>** element is of type **RuntimeOverride**, then the `type` attribute is the condition, and the `resid` attribute is the consequent. For example, the following is read "If the type is 'javascript', then the `resid` is 'JSRuntime.Url'." Excel, PowerPoint, and Word on Windows and classic Outlook on Windows require this element for [LaunchEvent extension point](/office/dev/add-ins/reference/manifest/extensionpoint#launchevent) and [ReportPhishingCommandSurface extension point (preview)](/javascript/api/manifest/extensionpoint) handlers.
0 commit comments