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/keyboard-shortcuts.md
+6-9Lines changed: 6 additions & 9 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: Custom keyboard shortcuts in Office Add-ins
3
3
description: Learn how to add custom keyboard shortcuts, also known as key combinations, to your Office Add-in.
4
-
ms.date: 02/12/2025
4
+
ms.date: 03/12/2025
5
5
ms.topic: how-to
6
6
ms.localizationpriority: medium
7
7
---
@@ -21,9 +21,6 @@ There are three steps to add keyboard shortcuts to an add-in.
21
21
Keyboard shortcuts are currently only supported in the following platforms and build of **Excel** and **Word**.
22
22
23
23
- Office on the web
24
-
25
-
> [!NOTE]
26
-
> The keyboard shortcut feature is currently being rolled out to Word on the web. If you test the feature in Word on the web at this time, the shortcuts may not work if they're activated from within the add-in's task pane. We recommend to periodically check [Keyboard Shortcuts requirement sets](/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets) to find out when the feature is fully supported.
27
24
- Office on Windows
28
25
-**Excel**: Version 2102 (Build 13801.20632) and later
29
26
-**Word**: Version 2408 (Build 17928.20114) and later
@@ -49,14 +46,14 @@ The process to define custom keyboard shortcuts for your add-in varies depending
49
46
# [Unified app manifest for Microsoft 365](#tab/jsonmanifest)
50
47
51
48
> [!NOTE]
52
-
> Implementing keyboard shortcuts with the unified app manifest for Microsoft 365 is in public developer preview. This shouldn't be used in production add-ins. We invite you to try it out in test or development environments. For more information, see the [Public developer preview app manifest schema](/microsoftteams/platform/resources/schema/manifest-schema-dev-preview).
49
+
> Implementing keyboard shortcuts with the unified app manifest for Microsoft 365 is in public developer preview. This shouldn't be used in production add-ins. We invite you to try it out in test or development environments. For more information, see the [Microsoft 365 app manifest schema reference](/microsoft-365/extensibility/schema/?view=m365-app-prev&preserve-view=true).
53
50
54
51
If your add-in uses the unified app manifest for Microsoft 365, custom keyboard shortcuts and their actions are defined in the manifest.
55
52
56
53
1. In your add-in project, open the **manifest.json** file.
57
-
1. Add the following object to the "extensions.runtimes" array. Note the following about this markup.
58
-
- The "actions" objects specify the functions your add-in can run. In the following example, an add-in will be able to show and hide a task pane. You'll create these functions in a later section. Currently, custom keyboard shortcuts can only run actions that are of type "executeFunction".
59
-
- While the "actions.displayName" property is optional, it's required if a custom keyboard shortcut will be created for the action. This property is used to describe the action of a keyboard shortcut. The description you provide appears in the dialog that's shown to a user when there's a shortcut conflict between multiple add-ins or with Microsoft 365. Office appends the name of the add-in in parentheses at the end of the description. For more information on how conflicts with keyboard shortcuts are handled, see [Avoid key combinations in use by other add-ins](#avoid-key-combinations-in-use-by-other-add-ins).
54
+
1. Add the following object to the ["extensions.runtimes"](/microsoft-365/extensibility/schema/extension-runtimes-array?view=m365-app-prev&preserve-view=true) array. Note the following about this markup.
55
+
- The ["actions"](/microsoft-365/extensibility/schema/extension-runtimes-actions-item?view=m365-app-prev&preserve-view=true) objects specify the functions your add-in can run. In the following example, an add-in will be able to show and hide a task pane. You'll create these functions in a later section. Currently, custom keyboard shortcuts can only run actions that are of type "executeFunction".
56
+
- While the ["actions.displayName"](/microsoft-365/extensibility/schema/extension-runtimes-actions-item?view=m365-app-prev&preserve-view=true#displayname) property is optional, it's required if a custom keyboard shortcut will be created for the action. This property is used to describe the action of a keyboard shortcut. The description you provide appears in the dialog that's shown to a user when there's a shortcut conflict between multiple add-ins or with Microsoft 365. Office appends the name of the add-in in parentheses at the end of the description. For more information on how conflicts with keyboard shortcuts are handled, see [Avoid key combinations in use by other add-ins](#avoid-key-combinations-in-use-by-other-add-ins).
60
57
61
58
```json
62
59
"runtimes": [
@@ -84,7 +81,7 @@ If your add-in uses the unified app manifest for Microsoft 365, custom keyboard
84
81
```
85
82
86
83
1. Add the following to the "extensions" array. Note the following about the markup.
87
-
- The SharedRuntime 1.1 requirement set is specified in the "requirements.capabilities" object to support custom keyboard shortcuts.
84
+
- The SharedRuntime 1.1 requirement set is specified in the ["requirements.capabilities"](/microsoft-365/extensibility/schema/requirements-extension-element-capabilities?view=m365-app-prev&preserve-view=true) object to support custom keyboard shortcuts.
88
85
- Each "shortcuts" object represents a single action that's invoked by a keyboard shortcut. It specifies the supported key combinations for various platforms, such as Office on the web, on Windows, and on Mac. For guidance on how to create custom key combinations, see [Guidelines for custom key combinations](#guidelines-for-custom-key-combinations).
89
86
- A default key combination must be specified. It's used on all supported platforms if there isn't a specific combination configured for a particular platform.
90
87
- The value of the "actionId" property must match the value specified in the "id" property of the applicable "extensions.runtimes.actions" object.
Copy file name to clipboardExpand all lines: docs/overview/office-add-ins-community-call.md
+3-6Lines changed: 3 additions & 6 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: Microsoft Office Add-ins community call
3
3
description: The monthly Microsoft Office Add-ins community call agenda, schedule, and resources.
4
-
ms.date: 01/13/2025
4
+
ms.date: 03/13/2025
5
5
ms.localizationpriority: medium
6
6
---
7
7
@@ -12,11 +12,8 @@ The Microsoft Office Add-ins community call is a monthly call where you can lear
12
12
> [!IMPORTANT]
13
13
> We have changed the schedule to 7:00 AM Pacific Time. If you still have the old calendar invite that starts at 8:00 AM Pacific Time, please remove it and download the latest one at <https://aka.ms/officeaddinscommunitycall>.
14
14
15
-
## Agenda for Febuary 12th, 2025 call
16
-
The agenda for the February Office Add-ins community call will be:
17
-
- PowerPoint Preview APIs
18
-
- Outlook Mobile Add-ins update
19
-
- WXP Add-ins with the Unified manifest Public Preview
15
+
## Agenda for April 9th, 2025 call
16
+
The agenda for the April Office Add-ins community call will be posted the week before the call
20
17
21
18
> [!NOTE]
22
19
> For us to improve our community call experience and better understand our audience, we invite you to fill out this survey: [Office Add-ins Developer Community Survey](https://forms.office.com/r/YNDtW8wQ6U).
0 commit comments