Skip to content

[Excel] (Undo) Add article about undo support #5175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
May 19, 2025

Conversation

alison-mk
Copy link
Contributor

@alison-mk alison-mk commented May 15, 2025

Adding an article about the new undo support feature—it's currently in Preview and will be announced at Build

Copy link
Contributor

Learn Build status updates of commit 3a8af2a:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ⚠️Warning View Details
docs/testing/application-specific-api-error-handling.md ✅Succeeded View

docs/excel/excel-add-ins-undo-capabilities.md

  • Line 42, Column 1: [Warning: invalid-note-section] Text in the first line of Note/Section/Video is not valid. Will be rendered to <blockquote>

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit ea5298f:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Use the`isSetSupported` method of the [OfficeRuntime.ApiInformation](/javascript/api/office-runtime/officeruntime.apiinformation) interface to check for undo support and provide a fallback experience if undo support isn't available. See the following code sample for more information about how to use `isSetSupported`.

```js
if (Office.context.requirements.isSetSupported("ExcelUndoApiAll", "1.0")) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm surprised this is "1.0" instead of "1.1", which seems to be the standard starting point in our requirement sets (not that starting with the logical "1.0" is bad).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question! I'll check with the PM.

Copy link
Contributor

Learn Build status updates of commit 1d3ece6:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 0293ae4:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit ff21d81:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 3c43fe8:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@alison-mk alison-mk marked this pull request as ready for review May 16, 2025 01:22
Copy link
Contributor

Learn Build status updates of commit 2308ed2:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit bbb3517:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit a2966e7:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@alison-mk alison-mk requested a review from AlexJerabek May 16, 2025 02:31
Copy link
Contributor

Learn Build status updates of commit bc1af3d:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit c79a21f:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ⚠️Warning View Details
docs/testing/application-specific-api-error-handling.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

docs/excel/excel-add-ins-undo-capabilities.md

  • Line 24, Column 113: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#check-for-undo-support' in 'excel/excel-add-ins-undo-capabilities.md'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@alison-mk alison-mk requested a review from Copilot May 19, 2025 17:43
Copy link
Contributor

Learn Build status updates of commit 9adf95b:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces documentation for the new undo support feature in Excel add-ins.

  • Adds a Table of Contents entry for “Undo support”
  • Updates the application-specific API error handling doc with a new UndoNotSupported error
  • Adds a new preview article on undo capabilities in the Excel JavaScript API

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/toc.yml Add new “Undo support” entry under the Excel section
docs/testing/application-specific-api-error-handling.md Bump ms.date and add UndoNotSupported error code
docs/excel/excel-add-ins-undo-capabilities.md Add new preview article on undo capabilities
Comments suppressed due to low confidence (2)

docs/excel/excel-add-ins-undo-capabilities.md:8

  • [nitpick] The heading text ('Undo support') doesn’t match the metadata title ('Undo capabilities'). Consider making them consistent.
# Undo support with the Excel JavaScript API (preview)

docs/toc.yml:593

  • Indentation for the new TOC entry doesn't match its siblings (two spaces less). Align it under the same level to ensure the YAML parses correctly.
    - name: Undo support

Copy link
Contributor

Learn Build status updates of commit d632868:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 32f1d86:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/excel-add-ins-undo-capabilities.md ✅Succeeded View
docs/testing/application-specific-api-error-handling.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@alison-mk alison-mk merged commit 6321522 into main May 19, 2025
2 checks passed
@alison-mk alison-mk deleted the alison-mk-undo-capabilities branch May 19, 2025 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants