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
Copy file name to clipboardExpand all lines: docs/design/contextual-tabs.md
-3Lines changed: 0 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,9 +39,6 @@ The user experience for custom contextual tabs follows the pattern of built-in O
39
39
- If more than one add-in has a contextual tab that's visible in a specific context, then they appear in the order in which the add-ins were launched.
40
40
- Custom *contextual* tabs, unlike custom core tabs, aren't added permanently to the Office application's ribbon. They're present only in Office documents on which your add-in is running.
41
41
42
-
> [!WARNING]
43
-
> Currently, the use of custom contextual tabs may prevent the user from undoing their previous Excel actions. This is a known issue (see [this GitHub thread](https://github.com/OfficeDev/office-js/issues/4814)) and under active investigation.
44
-
45
42
## Major steps for including a contextual tab in an add-in
46
43
47
44
The following are the major steps for including a custom contextual tab in an add-in.
Copy file name to clipboardExpand all lines: docs/develop/add-in-manifests.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,16 @@
2
2
title: Office Add-ins manifest
3
3
description: Get an overview of the Office Add-in manifest and its uses.
4
4
ms.topic: overview
5
-
ms.date: 04/12/2024
5
+
ms.date: 02/12/2025
6
6
ms.localizationpriority: high
7
7
---
8
8
9
9
# Office Add-ins manifest
10
10
11
11
Every Office add-in has a manifest. There are two types of manifests:
12
12
13
-
-**Add-in only manifest**: This is the only type of manifest that's currently supported for non-Outlook add-ins. Its format is XML. This type of manifest can't be used for an app that combines an add-in with some other kind of extension of the Microsoft 365 platform.
14
-
-**Unified manifest for Microsoft 365**: This is an expanded version of the JSON-formatted manifest that has been used for years as the manifest for Teams Apps. Add-ins that use this manifest can be combined with other kinds of extensions of the Microsoft 365 platform in a single app that's installable as a unit.
13
+
-**Add-in only manifest**: This type of manifest can be used for production add-ins in Excel, OneNote, Outlook, PowerPoint, Project, and Word. It can't be used for an app that combines an add-in with some other kind of extension of the Microsoft 365 platform. Its format is XML.
14
+
-**Unified manifest for Microsoft 365**: This is an expanded version of the JSON-formatted manifest that has been used for years as the manifest for Teams Apps. Add-ins that use this manifest can be combined with other kinds of extensions of the Microsoft 365 platform in a single app that's installable as a unit. You can use this type of manifest for production Outlook add-ins. It's available for preview in Excel, PowerPoint, and Word add-ins.
When an application-specific API is processed, the undo stack of the application is cleared. This means that you can't undo changes made prior to any action done by an add-in (unless that add-in only uses Common APIs or doesn't interact with the file). The same is true for changes made by the add-in.
293
+
Undo is partially supported by the application-specific Office JavaScript APIs. This means that users may be able to revert changes made by add-ins through the undo command. If a particular API doesn't support undo, the application's undo stack is cleared. This means that you won't be able to undo the effects of that API or anything prior to calling that API.
294
+
295
+
API support for undo is continuing to expand but is currently incomplete. We advise against designing your add-in in such a way that it relies on undo support.
Copy file name to clipboardExpand all lines: docs/develop/debug-office-add-ins-in-visual-studio.md
+18-14Lines changed: 18 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Debug Office Add-ins in Visual Studio
3
3
description: Use Visual Studio to debug Office Add-ins in the Office desktop client on Windows.
4
-
ms.date: 02/12/2025
4
+
ms.date: 02/19/2025
5
5
ms.localizationpriority: medium
6
6
---
7
7
@@ -14,7 +14,7 @@ This article describes how to debug client-side code in Office Add-ins that are
14
14
15
15
## Review the build and debug properties
16
16
17
-
Before you start debugging, review the properties of each project to confirm that Visual Studio will open the desired Office application and that other build and debug properties are set appropriately.
17
+
Before you start debugging, review the properties of each project in the solution to confirm that Visual Studio will open the desired Office application and that other build and debug properties are set appropriately.
18
18
19
19
### Add-in project properties
20
20
@@ -84,6 +84,9 @@ When Visual Studio builds the project, it performs the following tasks:
84
84
> [!NOTE]
85
85
> If Office uses the Edge Legacy webview control (EdgeHTML) to run add-ins on your Windows computer, Visual Studio may prompt you to add a local network loopback exemption. This is required for the webview control to be able to access the website deployed to the local IIS web server. You can also change this setting anytime in Visual Studio under **Tools** > **Options** > **Office Tools (Web)** > **Web Add-In Debugging**. To find out what webview control is used on your Windows computer, see [Browsers and webview controls used by Office Add-ins](../concepts/browsers-used-by-office-web-add-ins.md).
86
86
87
+
> [!TIP]
88
+
> [!INCLUDE[Identify the webview through the add-in UI](../includes/identify-webview-in-ui.md)]
89
+
87
90
Next, Visual Studio does the following:
88
91
89
92
1. Modifies the [SourceLocation](/javascript/api/manifest/sourcelocation) element of the add-in only manifest file (that was copied to the `_ProjectName_\bin\Debug\OfficeAppManifests` directory) by replacing the `~remoteAppUrl` token with the fully qualified address of the start page (for example, `https://localhost:44302/Home.html`).
@@ -99,7 +102,10 @@ Next, Visual Studio does the following:
99
102
100
103
### Debug the add-in
101
104
102
-
The best method for debugging an add-in in Visual Studio 2022 depends on whether the add-in is running in WebView2, which is the webview control that is associated with Microsoft Edge (Chromium), or an older webview control. To determine which webview control is being used, see [Browsers and webview controls used by Office Add-ins](../concepts/browsers-used-by-office-web-add-ins.md). If your computer is using WebView2, see [Use the built-in Visual Studio debugger to debug on the desktop](#use-the-built-in-visual-studio-debugger-to-debug-on-the-desktop). For any other webview control, see [Use the browser developer tools to debug on the desktop](#use-the-browser-developer-tools-to-debug-on-the-desktop).
105
+
The best method for debugging an add-in in Visual Studio 2022 depends on whether the add-in is running in WebView2, which is the webview control that is associated with Microsoft Edge (Chromium), or an older webview control. If your computer is using WebView2, see [Use the built-in Visual Studio debugger to debug on the desktop](#use-the-built-in-visual-studio-debugger-to-debug-on-the-desktop). For any other webview control, see [Use the browser developer tools to debug on the desktop](#use-the-browser-developer-tools-to-debug-on-the-desktop). To determine which webview control is being used, see [Browsers and webview controls used by Office Add-ins](../concepts/browsers-used-by-office-web-add-ins.md).
106
+
107
+
> [!TIP]
108
+
> [!INCLUDE[Identify the webview through the add-in UI](../includes/identify-webview-in-ui.md)]
103
109
104
110
#### Use the built-in Visual Studio debugger to debug on the desktop
105
111
@@ -117,15 +123,7 @@ The best method for debugging an add-in in Visual Studio 2022 depends on whether
117
123
118
124
1. Follow the steps in the earlier section [Start the add-in project](#start-the-add-in-project).
119
125
120
-
1. Launch the add-in in the Office application if it isn't already open. For example, if it's a task pane add-in, it'll have added a button to the **Home** ribbon (for example, a **Show Taskpane** button). Select the button on the ribbon.
121
-
122
-
> [!NOTE]
123
-
> If your add-in isn't sideloaded by Visual Studio, you can sideload it manually. Follow the instructions to [Sideload an Office Add-in for testing](../testing/test-debug-office-add-ins.md#sideload-an-office-add-in-for-testing) for your platform.
124
-
>
125
-
> In the list of available add-ins, find the **Developer Add-ins** section and select the your add-in to register it.
126
-
127
-
> [!TIP]
128
-
> The task pane may appear blank when it first opens. If so, it should render correctly when you launch the debugging tools in a later step.
126
+
1. Launch the add-in in the Office application if it isn't already open. For example, if it's a task pane add-in, it'll have added a button (for example, a **Show Taskpane** button) to the **Home** ribbon or to a custom ribbon tab that's installed with the add-in. Select the button on the ribbon.
129
127
130
128
1. Open the [personality menu](../design/task-pane-add-ins.md#personality-menu) and then choose **Attach a debugger**. This action opens the debugging tools for the webview control that Office is using to run add-ins on your Windows computer. You can set breakpoints and step through code as described in one of the following articles:
131
129
@@ -186,9 +184,15 @@ Next, Visual Studio does the following:
186
184
187
185
1. Opens the Office application host page of your Microsoft 365 tenancy in Microsoft Edge.
188
186
187
+
> [!TIP]
188
+
> If for any reason, Visual Studio doesn't fully sideload the add-in and none of the fixes earlier works, you can manually sideload it. Follow the steps in [Sideload an add-in to Microsoft 365](../testing/sideload-office-add-ins-for-testing.md#sideload-an-add-in-to-microsoft-365). When you're instructed to browse to the manifest, navigate to the XML file in the folder `_ProjectName_\bin\Debug\OfficeAppManifests` directory.
189
+
189
190
### Debug the add-in on the web
190
191
191
-
The best method for debugging an add-in in Visual Studio 2022 depends on whether the add-in is running in WebView2, which is the webview control that is associated with Microsoft Edge (Chromium), or an older webview control. To determine which webview control is being used, see [Browsers and webview controls used by Office Add-ins](../concepts/browsers-used-by-office-web-add-ins.md). If your computer is using WebView2, see [Use the built-in Visual Studio debugger to debug on the web](#use-the-built-in-visual-studio-debugger-to-debug-on-the-web). For any other webview control, see [Use the browser developer tools to debug on the web](#use-the-browser-developer-tools-to-debug-on-the-web).
192
+
The best method for debugging an add-in in Visual Studio 2022 depends on whether the add-in is running in WebView2, which is the webview control that is associated with Microsoft Edge (Chromium), or an older webview control. If your computer is using WebView2, see [Use the built-in Visual Studio debugger to debug on the web](#use-the-built-in-visual-studio-debugger-to-debug-on-the-web). For any other webview control, see [Use the browser developer tools to debug on the web](#use-the-browser-developer-tools-to-debug-on-the-web). To determine which webview control is being used, see [Browsers and webview controls used by Office Add-ins](../concepts/browsers-used-by-office-web-add-ins.md).
193
+
194
+
> [!TIP]
195
+
> [!INCLUDE[Identify the webview through the add-in UI](../includes/identify-webview-in-ui.md)]
192
196
193
197
#### Use the built-in Visual Studio debugger to debug on the web
194
198
@@ -219,7 +223,7 @@ The best method for debugging an add-in in Visual Studio 2022 depends on whether
219
223
> [!TIP]
220
224
> To debug code that runs in the `Office.initialize` function or an `Office.onReady` function that runs when the add-in opens, set your breakpoints, and then close and reopen the add-in. For more information about these functions, see [Initialize your Office Add-in](../develop/initialize-add-in.md).
221
225
222
-
1. To make changes to your code, first stop the debugging session in Visual Studio and close the Outlook pages. Make your changes, and start a new debugging session.
226
+
1. To make changes to your code, first stop the debugging session in Visual Studio and close the Office on the web page. Make your changes, and start a new debugging session.
Copy file name to clipboardExpand all lines: docs/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Add and remove attachments in an Outlook add-in
3
3
description: Use various attachment APIs to manage the files or Outlook items attached to the item the user is composing.
4
-
ms.date: 11/19/2024
4
+
ms.date: 02/13/2025
5
5
ms.topic: how-to
6
6
ms.localizationpriority: medium
7
7
---
@@ -158,6 +158,9 @@ The following APIs to get attachments in compose mode are available from [requir
158
158
159
159
Use the [getAttachmentsAsync](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods) method to get the attachments of the message or appointment being composed.
160
160
161
+
> [!NOTE]
162
+
> In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this type of attachment.
163
+
161
164
To get an attachment's content, use the [getAttachmentContentAsync](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods) method. The supported formats are listed in the [AttachmentContentFormat](/javascript/api/outlook/office.mailboxenums.attachmentcontentformat) enum.
162
165
163
166
You should provide a callback function to check for the status and any error by using the `AsyncResult` output parameter object. You can also pass any additional parameters to the callback function by using the optional `asyncContext` parameter.
Copy file name to clipboardExpand all lines: docs/outlook/onmessagesend-onappointmentsend-events.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Handle OnMessageSend and OnAppointmentSend events in your Outlook add-in with Smart Alerts
3
3
description: Learn about the Smart Alerts implementation and how it handles the OnMessageSend and OnAppointmentSend events in your event-based Outlook add-in.
4
-
ms.date: 02/12/2025
4
+
ms.date: 02/13/2025
5
5
ms.topic: concept-article
6
6
ms.localizationpriority: medium
7
7
---
@@ -222,7 +222,7 @@ Because the `OnMessageSend` and `OnAppointmentSend` events are supported through
222
222
223
223
In addition to these constraints, only one instance each of the `OnMessageSend` and `OnAppointmentSend` event can be declared in the manifest. If you require multiple `OnMessageSend` or `OnAppointmentSend` events, you must declare each one in a separate add-in.
224
224
225
-
While you can change the Smart Alerts dialog message and **Don't Send** button to suit your add-in scenario, the following can't be customized.
225
+
The Smart Alerts dialog message must be 500 characters or less. While you can change the dialog message and **Don't Send** button to suit your add-in scenario, the following can't be customized.
226
226
227
227
- The dialog's title bar. Your add-in's name is always displayed there.
228
228
- The font or color of the dialog message. However, you can use Markdown to format certain elements of your message. For a list of supported elements, see [Limitations to formatting the dialog message using Markdown](#limitations-to-formatting-the-dialog-message-using-markdown).
Copy file name to clipboardExpand all lines: docs/quickstarts/outlook-quickstart-yo.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Build your first Outlook add-in
3
3
description: Learn how to build a simple Outlook task pane add-in by using the Office JS API.
4
-
ms.date: 08/24/2024
4
+
ms.date: 02/18/2025
5
5
ms.service: outlook
6
6
ms.localizationpriority: high
7
7
---
@@ -89,7 +89,7 @@ The Yeoman generator creates a project in a folder with the project name that yo
89
89
90
90
## Next steps
91
91
92
-
Congratulations, you've successfully created your first Outlook task pane add-in! Next, learn more about the capabilities of an Outlook add-in and build a more complex add-in by following along with the [Outlook add-in tutorial](../tutorials/outlook-tutorial.md).
92
+
Congratulations, you've successfully created your first Outlook task pane add-in! Next, explore more capabilities of an Outlook add-in by following along with the [Outlook add-in tutorial](../tutorials/outlook-tutorial.md). In the tutorial, you'll build a more complex add-in that incorporates a task pane, which you've learned about in the quick start. Additionally, you'll create a button that invokes a UI-less function.
93
93
94
94
[!include[The common troubleshooting section for all Yo Office quick starts](../includes/quickstart-troubleshooting-yo.md)]
0 commit comments