Skip to content

Commit 8f25be6

Browse files
samantharamonsamantharamon
authored
[Outlook] (manifest) Fix Module extension point documentation (#2211)
1 parent 2d5083e commit 8f25be6

File tree

4 files changed

+115
-8
lines changed

4 files changed

+115
-8
lines changed

‎docs/manifest/commandsurface.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: CommandSurface element in the manifest file
3+
description: Defines the custom tab and ribbon buttons of a module extension add-in in classic Outlook on Windows.
4+
ms.date: 02/27/2025
5+
ms.localizationpriority: medium
6+
---
7+
8+
# CommandSurface element
9+
10+
Defines the custom tab and ribbon buttons of a module extension add-in in classic Outlook on Windows. For more information about module extensions, see [Module extension Outlook add-ins](/office/dev/add-ins/outlook/extension-module-outlook-add-ins).
11+
12+
**Add-in type**: Mail
13+
14+
**Valid only in these VersionOverrides schemas**:
15+
16+
- Mail 1.1
17+
18+
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+
**Associated with these requirement sets**:
21+
22+
- [Mailbox 1.5](../requirement-sets/outlook/requirement-set-1.5/outlook-requirement-set-1.5.md)
23+
24+
## Contained in
25+
26+
- [ExtensionPoint](extensionpoint.md) ([Module](extensionpoint.md#module) mail add-ins)
27+
28+
## Attributes
29+
30+
None.
31+
32+
## Child elements
33+
34+
| Element | Required | Description |
35+
|:-----|:-----:|:-----|
36+
| [CustomTab](customtab.md) | Yes | Defines a custom tab on the ribbon for the module extension add-in. The custom tab hosts buttons that run add-in operations. |
37+
38+
## Example
39+
40+
```xml
41+
<ExtensionPoint xsi:type="Module">
42+
<SourceLocation resid="residExtensionPointUrl"/>
43+
<Label resid="residExtensionPointLabel"/>
44+
<CommandSurface>
45+
<CustomTab id="idTab">
46+
<Group id="idGroup">
47+
<Label resid="residGroupLabel"/>
48+
<Control xsi:type="Button" id="group.changeToAssociate">
49+
<Label resid="residChangeToAssociateLabel"/>
50+
<Supertip>
51+
<Title resid="residChangeToAssociateLabel"/>
52+
<Description resid="residChangeToAssociateDesc"/>
53+
</Supertip>
54+
<Icon>
55+
<bt:Image size="16" resid="residAssociateIcon16"/>
56+
<bt:Image size="32" resid="residAssociateIcon32"/>
57+
<bt:Image size="80" resid="residAssociateIcon80"/>
58+
</Icon>
59+
<Action xsi:type="ExecuteFunction">
60+
<FunctionName>changeToAssociateRate</FunctionName>
61+
</Action>
62+
</Control>
63+
</Group>
64+
<Label resid="residCustomTabLabel"/>
65+
</CustomTab>
66+
</CommandSurface>
67+
</ExtensionPoint>
68+
```

‎docs/manifest/customfunctionssourcelocation.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
22
title: SourceLocation element (version overrides) in the manifest file
33
description: Defines the location of a resource needed by the Script or Page elements used by custom functions in Excel, or needed by the ReportPhishingCustomization element, DetectedEntity extension point, or LaunchEvent extension point in Outlook.
4-
ms.date: 05/20/2024
4+
ms.date: 02/27/2025
55
ms.localizationpriority: medium
66
---
77

88
# SourceLocation element (version overrides)
99

10-
Defines the location of a resource needed by the **\<Script\>** or **\<Page\>** elements used by custom functions in Excel, or needed by the **\<ReportPhishingCustomization\>** element, **\<DetectedEntity\>** extension point, or **\<LaunchEvent\>** extension point in Outlook.
10+
Defines the location of a resource needed by the following elements.
11+
12+
- **\<Script\>** or **\<Page\>** elements used by custom functions in Excel
13+
- **\<ReportPhishingCustomization\>** element, **\<DetectedEntity\>** extension point, **\<LaunchEvent\>** extension point, or **\<Module\>** extension point in Outlook.
1114

1215
> [!IMPORTANT]
1316
> This article only refers to the **\<SourceLocation\>** that is a child of the following:
1417
>
1518
> - **\<Page\>**, **\<Script\>**, or **\<ReportPhishingCustomization\>** elements
16-
> - **\<DetectedEntity\>** or **\<LaunchEvent\>** extension points
19+
> - **\<DetectedEntity\>**, **\<LaunchEvent\>**, or **\<Module\>** extension points
1720
>
1821
> For information about the **\<SourceLocation\>** element of the base manifest, see [SourceLocation](sourcelocation.md).
1922
@@ -29,13 +32,14 @@ For more information, see [Version overrides in the add-in only manifest](/offic
2932
**Associated with these requirement sets**:
3033

3134
- [CustomFunctionsRuntime 1.1](../requirement-sets/excel/custom-functions-requirement-sets.md)
35+
- [Mailbox 1.5](../requirement-sets/outlook/requirement-set-1.5/outlook-requirement-set-1.5.md)
3236
- [Mailbox 1.6](../requirement-sets/outlook/requirement-set-1.6/outlook-requirement-set-1.6.md)
3337
- [Mailbox 1.10](../requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10.md)
3438
- [Mailbox 1.14](../requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14.md)
3539

3640
## Contained in
3741

38-
- [ExtensionPoint](extensionpoint.md) ([Contextual](extensionpoint.md#detectedentity) and [LaunchEvent](extensionpoint.md#launchevent) mail add-ins)
42+
- [ExtensionPoint](extensionpoint.md) ([DetectedEntity](extensionpoint.md#detectedentity), [LaunchEvent](extensionpoint.md#launchevent), and [Module](extensionpoint.md#module) mail add-ins)
3943
- [Page](page.md)
4044
- [ReportPhishingCustomization](reportphishingcustomization.md) (Mail add-ins)
4145
- [Script](script.md)

‎docs/manifest/extensionpoint.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
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: 09/05/2024
4+
ms.date: 02/27/2025
55
ms.localizationpriority: medium
66
---
77

@@ -283,7 +283,7 @@ This extension point puts buttons on the ribbon for the form that's displayed to
283283

284284
### Module
285285

286-
This extension point puts buttons on the ribbon for the module extension.
286+
This extension point adds a module extension add-in to the Outlook navigation bar. It also adds buttons to a custom tab on the ribbon for the module extension. To learn how to create module extensions, see [Module extension Outlook add-ins](/office/dev/add-ins/outlook/extension-module-outlook-add-ins).
287287

288288
> [!IMPORTANT]
289289
> 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.
@@ -292,8 +292,41 @@ This extension point puts buttons on the ribbon for the module extension.
292292

293293
| Element | Description |
294294
|:-----|:-----|
295-
| [OfficeTab](officetab.md) | Adds the command(s) to the default ribbon tab. |
296-
| [CustomTab](customtab.md) | Adds the command(s) to the custom ribbon tab. |
295+
| [SourceLocation](customfunctionssourcelocation.md) | Specifies the location of the HTML file that sets up the main user interface of the add-in. |
296+
| Label | Specifies the label of the module extension. Its **resid** attribute can be no more than 32 characters and must be set to the value of the **id** attribute of a **\<String\>** element in the [ShortStrings](shortstrings.md) element. |
297+
| [CommandSurface](commandsurface.md) | Adds a group of add-in buttons to a custom tab on the ribbon. |
298+
299+
#### Example
300+
301+
```xml
302+
<ExtensionPoint xsi:type="Module">
303+
<SourceLocation resid="residExtensionPointUrl"/>
304+
<Label resid="residExtensionPointLabel"/>
305+
<CommandSurface>
306+
<CustomTab id="idTab">
307+
<Group id="idGroup">
308+
<Label resid="residGroupLabel"/>
309+
<Control xsi:type="Button" id="group.changeToAssociate">
310+
<Label resid="residChangeToAssociateLabel"/>
311+
<Supertip>
312+
<Title resid="residChangeToAssociateLabel"/>
313+
<Description resid="residChangeToAssociateDesc"/>
314+
</Supertip>
315+
<Icon>
316+
<bt:Image size="16" resid="residAssociateIcon16"/>
317+
<bt:Image size="32" resid="residAssociateIcon32"/>
318+
<bt:Image size="80" resid="residAssociateIcon80"/>
319+
</Icon>
320+
<Action xsi:type="ExecuteFunction">
321+
<FunctionName>changeToAssociateRate</FunctionName>
322+
</Action>
323+
</Control>
324+
</Group>
325+
<Label resid="residCustomTabLabel"/>
326+
</CustomTab>
327+
</CommandSurface>
328+
</ExtensionPoint>
329+
```
297330

298331
### MobileMessageReadCommandSurface
299332

‎docs/manifest/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@
118118
href: ../../manifest/action.md
119119
- name: AllFormFactors
120120
href: ../../manifest/allformfactors.md
121+
- name: CommandSurface
122+
href: ../../manifest/commandsurface.md
121123
- name: Control
122124
href: ../../manifest/control.md
123125
- name: Control (Button)

0 commit comments

Comments
 (0)