Skip to content

Commit 9785a50

Browse files
[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]>
1 parent 82ecff4 commit 9785a50

File tree

14 files changed

+72
-69
lines changed

14 files changed

+72
-69
lines changed

docs/includes/runtimes-note.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
> [!IMPORTANT]
2-
> 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).
32
>
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).
75
> - 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).
86
>
97
> Note that the event-based activation and integrated spam reporting features must use the same runtime. Multiple runtimes aren't currently supported in Outlook.

docs/manifest/extensionpoint.md

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: ExtensionPoint element in the manifest file
33
description: Defines where an add-in exposes functionality in the Office UI.
4-
ms.date: 03/11/2025
4+
ms.date: 07/11/2025
55
ms.localizationpriority: medium
66
---
77

88
# ExtensionPoint element
99

1010
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).
1111

12-
**Add-in type:** Task pane, Mail
12+
**Add-in type**: Document, Mail, Presentation, Task pane, Workbook
1313

1414
**Valid only in these VersionOverrides schemas**:
1515

@@ -25,6 +25,37 @@ For more information, see [Version overrides in the add-in only manifest](/offic
2525
|:-----|:-----:|:-----|
2626
| **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.|
2727

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. |
45+
46+
#### Example
47+
48+
```xml
49+
<ExtensionPoint xsi:type="LaunchEvent">
50+
<LaunchEvents>
51+
<LaunchEvent Type="OnNewMessageCompose" FunctionName="onMessageComposeHandler"/>
52+
<LaunchEvent Type="OnNewAppointmentOrganizer" FunctionName="onAppointmentComposeHandler"/>
53+
</LaunchEvents>
54+
<!-- Identifies the runtime to be used (also referenced by the Runtime element). -->
55+
<SourceLocation resid="WebViewRuntime.Url"/>
56+
</ExtensionPoint>
57+
```
58+
2859
## Extension points for Excel, OneNote, PowerPoint, and Word add-in commands
2960

3061
There are three types of extension points available in some or all of these hosts.
@@ -152,7 +183,6 @@ A custom function written in JavaScript or TypeScript for Excel.
152183
- [MobileMessageReadCommandSurface](#mobilemessagereadcommandsurface)
153184
- [MobileOnlineMeetingCommandSurface](#mobileonlinemeetingcommandsurface)
154185
- [MobileLogEventAppointmentAttendee](#mobilelogeventappointmentattendee)
155-
- [LaunchEvent](#launchevent)
156186
- [Events](#events)
157187
- [DetectedEntity](#detectedentity)
158188
- [ReportPhishingCommandSurface](#reportphishingcommandsurface)
@@ -445,33 +475,6 @@ The images specified in the **\<Icon\>** element should be in grayscale using he
445475
</ExtensionPoint>
446476
```
447477

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. |
461-
462-
#### Example
463-
464-
```xml
465-
<ExtensionPoint xsi:type="LaunchEvent">
466-
<LaunchEvents>
467-
<LaunchEvent Type="OnNewMessageCompose" FunctionName="onMessageComposeHandler"/>
468-
<LaunchEvent Type="OnNewAppointmentOrganizer" FunctionName="onAppointmentComposeHandler"/>
469-
</LaunchEvents>
470-
<!-- Identifies the runtime to be used (also referenced by the Runtime element). -->
471-
<SourceLocation resid="WebViewRuntime.Url"/>
472-
</ExtensionPoint>
473-
```
474-
475478
### Events
476479

477480
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).

docs/manifest/launchevent.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
---
22
title: LaunchEvent in the manifest file
33
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
55
ms.localizationpriority: medium
66
---
77

88
# LaunchEvent element
99

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).
1111

12-
**Add-in type:** Mail
12+
**Add-in type:** Document, Mail, Presentation, Workbook
1313

1414
**Valid only in these VersionOverrides schemas**:
1515

1616
- Mail 1.1
17+
- Task pane 1.0
1718

1819
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).
1920

@@ -45,7 +46,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic
4546

4647
| Attribute | Required | Description |
4748
|:-----|:-----:|:-----|
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). |
4950
| **FunctionName** | Yes | Specifies the name of the JavaScript function to handle the event specified in the `Type` attribute. |
5051
| **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). |
5152
| **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
5960
## See also
6061

6162
- [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)
6364
- [Handle OnMessageSend and OnAppointmentSend events in your Outlook add-in with Smart Alerts](/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events)
6465
- [Automatically check for an attachment before a message is sent](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough)
6566
- [Automatically update your signature when switching between Exchange accounts](/office/dev/add-ins/outlook/onmessagefromchanged-onappointmentfromchanged-events)

docs/manifest/launchevents.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
---
22
title: LaunchEvents in the manifest file
33
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
55
ms.localizationpriority: medium
66
---
77

88
# LaunchEvents element
99

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).
1111

12-
**Add-in type:** Mail
12+
**Add-in type:** Document, Mail, Presentation, Workbook
1313

1414
**Valid only in these VersionOverrides schemas**:
1515

1616
- Mail 1.1
17+
- Task pane 1.0
1718

1819
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).
1920

@@ -32,7 +33,7 @@ For more information, see [Version overrides in the add-in only manifest](/offic
3233

3334
## Contained in
3435

35-
- [ExtensionPoint](extensionpoint.md) (**\<LaunchEvent\>** mail add-in)
36+
- [ExtensionPoint](extensionpoint.md) (**\<LaunchEvent\>** add-in)
3637

3738
## Child elements
3839

@@ -43,6 +44,6 @@ For more information, see [Version overrides in the add-in only manifest](/offic
4344
## See also
4445

4546
- [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)
4748
- [Use Smart Alerts and the OnMessageSend event in your Outlook add-in](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough)
4849
- [Automatically update your signature when switching between Exchange accounts](/office/dev/add-ins/outlook/onmessagefromchanged-onappointmentfromchanged-events)

docs/manifest/messageattachment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ None.
5151
## See also
5252

5353
- [LaunchEvent element](launchevent.md)
54-
- [Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch#supported-events)
54+
- [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation#supported-events)

docs/manifest/messageattachments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ None.
5151
## See also
5252

5353
- [LaunchEvent element](launchevent.md)
54-
- [Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch#supported-events)
54+
- [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation#supported-events)

docs/manifest/override.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,17 +198,17 @@ The **\<Override\>** element for `RequirementToken` must contain the following c
198198
## Override element for `Runtime`
199199

200200
> [!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.
202202
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.
204204

205205
```xml
206206
<Runtime resid="WebViewRuntime.Url">
207207
<Override type="javascript" resid="JSRuntime.Url"/>
208208
</Runtime>
209209
```
210210

211-
**Add-in type:** Mail
211+
**Add-in type:** Document, Mail, Presentation, Workbook
212212

213213
### Syntax
214214

@@ -244,4 +244,4 @@ An **\<Override\>** element expresses a conditional and can be read as an "If ..
244244
### See also
245245

246246
- [Runtime](runtime.md)
247-
- [Configure your Outlook add-in for event-based activation](/office/dev/add-ins/outlook/autolaunch)
247+
- [Activate add-ins with events](/office/dev/add-ins/develop/event-based-activation)

0 commit comments

Comments
 (0)