Skip to content

Commit 37c2dc1

Browse files
authored
[Excel, Word, PowerPoint] (Application-specific APIs) Document partial undo support (#5042)
* Document partial undo support * Grammar fix
1 parent 4cc1b08 commit 37c2dc1

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

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/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

0 commit comments

Comments
 (0)