Skip to content

Commit 551b16a

Browse files
author
github-actions
committed
Merge branch 'main' into live
2 parents 7d5e697 + c96589f commit 551b16a

8 files changed

+35
-29
lines changed

.openpublishing.redirection.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@
396396
},
397397
{
398398
"source_path": "docs/design/design-toolkits.md",
399-
"redirect_url": "office/dev/add-ins/design/add-in-design-language"
399+
"redirect_url": "/office/dev/add-ins/design/add-in-design-language"
400400
},
401401
{
402402
"source_path": "docs/tutorials/powerpoint-tutorial-customize-ui.md",

docs/design/contextual-tabs.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@ The user experience for custom contextual tabs follows the pattern of built-in O
3939
- 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.
4040
- 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.
4141

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-
4542
## Major steps for including a contextual tab in an add-in
4643

4744
The following are the major steps for including a custom contextual tab in an add-in.

docs/develop/add-in-manifests.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
title: Office Add-ins manifest
33
description: Get an overview of the Office Add-in manifest and its uses.
44
ms.topic: overview
5-
ms.date: 04/12/2024
5+
ms.date: 02/12/2025
66
ms.localizationpriority: high
77
---
88

99
# Office Add-ins manifest
1010

1111
Every Office add-in has a manifest. There are two types of manifests:
1212

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.
1515

1616
[!INCLUDE [non-unified manifest clients note](../includes/non-unified-manifest-clients.md)]
1717

docs/develop/application-specific-api-model.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Using the application-specific API model
33
description: Learn about the promise-based API model for Excel, OneNote, PowerPoint, Visio, and Word add-ins.
4-
ms.date: 10/20/2023
4+
ms.date: 02/12/2025
55
ms.localizationpriority: medium
66
---
77

@@ -288,9 +288,11 @@ await Excel.run(async (context) => {
288288
});
289289
```
290290

291-
## Application undo stack
291+
## Undo support
292292

293-
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.
294296

295297
## See also
296298

docs/develop/debug-office-add-ins-in-visual-studio.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Debug Office Add-ins in Visual Studio
33
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
55
ms.localizationpriority: medium
66
---
77

@@ -14,7 +14,7 @@ This article describes how to debug client-side code in Office Add-ins that are
1414
1515
## Review the build and debug properties
1616

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.
1818

1919
### Add-in project properties
2020

@@ -84,6 +84,9 @@ When Visual Studio builds the project, it performs the following tasks:
8484
> [!NOTE]
8585
> 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).
8686
87+
> [!TIP]
88+
> [!INCLUDE[Identify the webview through the add-in UI](../includes/identify-webview-in-ui.md)]
89+
8790
Next, Visual Studio does the following:
8891

8992
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:
99102

100103
### Debug the add-in
101104

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)]
103109
104110
#### Use the built-in Visual Studio debugger to debug on the desktop
105111

@@ -117,15 +123,7 @@ The best method for debugging an add-in in Visual Studio 2022 depends on whether
117123

118124
1. Follow the steps in the earlier section [Start the add-in project](#start-the-add-in-project).
119125

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.
129127

130128
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:
131129

@@ -186,9 +184,15 @@ Next, Visual Studio does the following:
186184
187185
1. Opens the Office application host page of your Microsoft 365 tenancy in Microsoft Edge.
188186

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+
189190
### Debug the add-in on the web
190191

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)]
192196
193197
#### Use the built-in Visual Studio debugger to debug on the web
194198

@@ -219,7 +223,7 @@ The best method for debugging an add-in in Visual Studio 2022 depends on whether
219223
> [!TIP]
220224
> 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).
221225
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.
223227

224228
## Use an existing document to debug the add-in
225229

docs/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Add and remove attachments in an Outlook add-in
33
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
55
ms.topic: how-to
66
ms.localizationpriority: medium
77
---
@@ -158,6 +158,9 @@ The following APIs to get attachments in compose mode are available from [requir
158158

159159
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.
160160

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+
161164
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.
162165

163166
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.

docs/outlook/onmessagesend-onappointmentsend-events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Handle OnMessageSend and OnAppointmentSend events in your Outlook add-in with Smart Alerts
33
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
55
ms.topic: concept-article
66
ms.localizationpriority: medium
77
---
@@ -222,7 +222,7 @@ Because the `OnMessageSend` and `OnAppointmentSend` events are supported through
222222

223223
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.
224224

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.
226226

227227
- The dialog's title bar. Your add-in's name is always displayed there.
228228
- 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).

docs/quickstarts/outlook-quickstart-yo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first Outlook add-in
33
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
55
ms.service: outlook
66
ms.localizationpriority: high
77
---
@@ -89,7 +89,7 @@ The Yeoman generator creates a project in a folder with the project name that yo
8989
9090
## Next steps
9191
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.
9393
9494
[!include[The common troubleshooting section for all Yo Office quick starts](../includes/quickstart-troubleshooting-yo.md)]
9595

0 commit comments

Comments
 (0)