Skip to content

Commit

Permalink
Merge main into branch to fix conflict
Browse files Browse the repository at this point in the history
  • Loading branch information
alison-mk committed Oct 18, 2024
2 parents fab97ca + a698700 commit 67ad913
Show file tree
Hide file tree
Showing 56 changed files with 644 additions and 684 deletions.
12 changes: 10 additions & 2 deletions .openpublishing.redirection.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,11 @@
},
{
"source_path": "docs/excel/excel-add-ins-get-started-vue.md",
"redirect_url": "/office/dev/add-ins/quickstarts/excel-quickstart-yo"
"redirect_url": "/office/dev/add-ins/quickstarts/excel-quickstart-jquery"
},
{
"source_path": "docs/quickstarts/excel-quickstart-vue.md",
"redirect_url": "/office/dev/add-ins/quickstarts/excel-quickstart-yo"
"redirect_url": "/office/dev/add-ins/quickstarts/excel-quickstart-jquery"
},
{
"source_path": "docs/excel/excel-add-ins-get-started-react.md",
Expand Down Expand Up @@ -1292,6 +1292,14 @@
{
"source_path": "docs/outlook/activation-rules.md",
"redirect_url": "/javascript/api/manifest/rule"
},
{
"source_path": "docs/outlook/get-and-set-item-data-in-a-compose-form.md",
"redirect_url": "/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets"
},
{
"source_path": "docs/outlook/item-data.md",
"redirect_url": "/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets"
}
]
}
4 changes: 3 additions & 1 deletion docs/concepts/add-in-development-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Best practices for developing Office Add-ins
description: Apply the best practices when developing Office Add-ins.
ms.topic: best-practice
ms.date: 07/18/2024
ms.date: 10/10/2024
ms.localizationpriority: medium
---

Expand Down Expand Up @@ -122,6 +122,8 @@ For patterns that you can apply as you develop your first-run experience, see [U

## Publish and market your add-in

- Create a [Partner Center account](/partner-center/marketplace-offers/open-a-developer-account). This could take some time. If you plan to publish your add-in to AppSource, get this process going as soon as possible.

- Create an [effective AppSource listing](/partner-center/marketplace-offers/create-effective-office-store-listings).

- Use succinct and descriptive add-in titles. Include no more than 128 characters.
Expand Down
29 changes: 15 additions & 14 deletions docs/concepts/browsers-used-by-office-web-add-ins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Browsers and webview controls used by Office Add-ins
description: Specifies how the operating system and Office version determine what webview is used by Office Add-ins.
ms.topic: concept-article
ms.date: 04/24/2024
ms.date: 10/17/2024
ms.localizationpriority: medium
---

Expand Down Expand Up @@ -33,7 +33,7 @@ The following sections specify which browser is used for the various platforms a

## Non-Windows platforms

For these platforms, the platform alone determines the browser that is used.
For these platforms, the platform alone determines the browser that's used.

|OS|Office version|Browser|
|:-----|:-----|:-----|
Expand All @@ -55,9 +55,9 @@ An add-in running on Windows might use any of three different webviews:

### Perpetual versions of Office on Windows

For perpetual versions of Office on Windows, the browser that is used is determined by the Office version, whether the license is retail or volume-licensed, and whether the Edge WebView2 (Chromium-based) is installed. The version of Windows doesn't matter, but note that Office Web Add-ins aren't supported on versions earlier than Windows 7 and Office 2021 isn't supported on versions earlier than Windows 10.
For perpetual versions of Office on Windows, the browser that's used is determined by the Office version, whether the license is retail or volume-licensed, and whether the Edge WebView2 (Chromium-based) is installed. The version of Windows doesn't matter, but note that Office Add-ins aren't supported on versions earlier than Windows 7 and Office 2021 and later aren't supported on versions earlier than Windows 10.

To determine whether Office 2016 or Office 2019 is retail or volume-licensed, use the format of the Office version and build number. (For Office 2021, the distinction between volume-licensed and retail doesn't matter.)
To determine whether Office 2016 or Office 2019 is retail or volume-licensed, use the format of the Office version and build number. (For Office 2021 and later, the distinction between volume-licensed and retail doesn't matter.)

- **Retail**: For both Office 2016 and 2019, the format is `YYMM (xxxxx.xxxxxx)`, ending with two blocks of five digits; for example, `2206 (Build 15330.20264)`.
- **Volume-licensed**:
Expand All @@ -66,6 +66,7 @@ To determine whether Office 2016 or Office 2019 is retail or volume-licensed, us

| Office version | Retail vs. Volume-licensed | WebView2 installed? | Browser |
|:-----|:-----|:-----|:-----|
| Office 2024 | Doesn't matter | Yes<sup>1</sup> | WebView2 (Microsoft Edge<sup>2</sup> Chromium-based) |
| Office 2021 | Doesn't matter | Yes<sup>1</sup> | WebView2 (Microsoft Edge<sup>2</sup> Chromium-based) |
| Office 2019 | Retail | Yes<sup>1</sup> | WebView2 (Microsoft Edge<sup>2</sup> Chromium-based) |
| Office 2019 | Retail | No | EdgeHTML (Microsoft Edge Legacy)<sup>2, 3</sup></br>If Edge isn't installed, Trident+ (Internet Explorer 11) is used. |
Expand All @@ -76,28 +77,28 @@ To determine whether Office 2016 or Office 2019 is retail or volume-licensed, us

<sup>1</sup> On Windows versions prior to Windows 11, the WebView2 control must be installed so that Office can embed it. It's installed with perpetual Office 2021 or later; but it isn't automatically installed with Microsoft Edge. If you have an earlier version of perpetual Office, use the instructions for installing the control at [Microsoft Edge WebView2 / Embed web content ... with Microsoft Edge WebView2](https://developer.microsoft.com/microsoft-edge/webview2/).

<sup>2</sup> When you use either EdgeHTML or WebView2, the Windows Narrator (sometimes called a "screen reader") reads the `<title>` tag in the page that opens in the task pane. In Trident+, the Narrator reads the title bar of the task pane, which comes from the add-in name that is specified in the add-in's manifest.
<sup>2</sup> When you use either EdgeHTML or WebView2, the Windows Narrator (sometimes called a "screen reader") reads the `<title>` tag in the page that opens in the task pane. In Trident+, the Narrator reads the title bar of the task pane, which comes from the add-in name that's specified in the add-in's manifest.

<sup>3</sup> If your add-in uses an add-in only manifest and includes the **\<Runtimes\>** element in the manifest or it uses the unified manifest and it includes an "extensions.runtimes.lifetime" property, then it won't use EdgeHTML. If the conditions for using WebView2 are met, then the add-in uses WebView2. Otherwise, it uses Trident+. For more information, see [Runtimes](/javascript/api/manifest/runtimes) and [Configure your Outlook add-in for event-based activation](../outlook/autolaunch.md?tabs=jsonmanifest).

### Microsoft 365 subscription versions of Office on Windows

For subscription Office on Windows, the browser that is used is determined by the operating system, the Office version, and whether the WebView2 control is installed.
For subscription Office on Windows, the browser that's used is determined by the operating system, the Office version, and whether the WebView2 control is installed.

|OS|Office version| WebView2 installed?|Browser|
|:-----|:-----|:-----|:-----|
|Windows 11,<br>Windows 10,<br>Windows 8.1,<br>Windows Server 2022,<br>Windows Server 2019,<br>Windows Server 2016| Microsoft 365 ver.&nbsp;>=&nbsp;16.0.13530.20424<sup>1</sup>| Yes<sup>2</sup>| WebView2 (Microsoft Edge<sup>3</sup> Chromium-based) |
|Window 11,<br>Windows 10 ver.&nbsp;>=&nbsp;1903 | Microsoft 365 ver.&nbsp;>=&nbsp;16.0.13530.20424<sup>1</sup>| No |EdgeHTML (Microsoft Edge Legacy)<sup>3, 4</sup>|
|Windows 11,<br>Windows 10 ver.&nbsp;>=&nbsp;1903 | Microsoft 365 ver.&nbsp;>=&nbsp;16.0.11629&nbsp;*AND*&nbsp;<&nbsp;16.0.13530.20424<sup>1</sup>| Doesn't matter|EdgeHTML (Microsoft Edge Legacy)<sup>3, 4</sup>|
|Windows 11,<br>Windows 10 ver.&nbsp;>=&nbsp;1903 | Microsoft 365 ver.&nbsp;<&nbsp;16.0.11629<sup>1</sup>| Doesn't matter|Trident+ (Internet Explorer 11)|
|Windows 10 ver.&nbsp;<&nbsp;1903,<br>Windows 8.1| Microsoft 365 | No| Trident+ (Internet Explorer 11)|
|Windows 7 | Microsoft 365| Doesn't matter | Trident+ (Internet Explorer 11)|
|<ul><li>Windows 11</li><li>Windows 10</li><li>Windows 8.1</li><li>Windows Server 2022</li><li>Windows Server 2019</li><li>Windows Server 2016</li></ul>| Microsoft 365 ver.&nbsp;>=&nbsp;16.0.13530.20424<sup>1</sup>| Yes<sup>2</sup>| WebView2 (Microsoft Edge<sup>3</sup> Chromium-based) |
|<ul><li>Window 11</li><li>Windows 10 ver.&nbsp;>=&nbsp;1903</li></ul>| Microsoft 365 ver.&nbsp;>=&nbsp;16.0.13530.20424<sup>1</sup>| No |EdgeHTML (Microsoft Edge Legacy)<sup>3, 4</sup>|
|<ul><li>Windows 11</li><li>Windows 10 ver.&nbsp;>=&nbsp;1903</li></ul>| Microsoft 365 ver.&nbsp;>=&nbsp;16.0.11629&nbsp;*AND*&nbsp;<&nbsp;16.0.13530.20424<sup>1</sup>| Doesn't matter|EdgeHTML (Microsoft Edge Legacy)<sup>3, 4</sup>|
|<ul><li>Windows 11</li><li>Windows 10 ver.&nbsp;>=&nbsp;1903</li></ul>| Microsoft 365 ver.&nbsp;<&nbsp;16.0.11629<sup>1</sup>| Doesn't matter|Trident+ (Internet Explorer 11)|
|<ul><li>Windows 10 ver.&nbsp;<&nbsp;1903</li><li>Windows 8.1</li></ul>| Microsoft 365 | No| Trident+ (Internet Explorer 11)|
|<ul><li>Windows 7</li></ul>| Microsoft 365| Doesn't matter | Trident+ (Internet Explorer 11)|

<sup>1</sup> See the [update history page](/officeupdates/update-history-office365-proplus-by-date) and how to [find your Office client version and update channel](https://support.microsoft.com/office/932788b8-a3ce-44bf-bb09-e334518b8b19) for more details.

<sup>2</sup> On Windows versions prior to Windows 11, the WebView2 control must be installed so that Office can embed it. It's installed with Microsoft 365, Version 2101 or later, but it isn't automatically installed with Microsoft Edge. If you have an earlier version of Microsoft 365, use the instructions for installing the control at [Microsoft Edge WebView2 / Embed web content ... with Microsoft Edge WebView2](https://developer.microsoft.com/microsoft-edge/webview2/). On Microsoft 365 builds before 16.0.14326.xxxxx, you must also create the registry key **HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Win32WebView2** and set its value to `dword:00000001`.

<sup>3</sup> When you use either EdgeHTML or WebView2, the Windows Narrator (sometimes called a "screen reader") reads the `<title>` tag in the page that opens in the task pane. In Trident+, the Narrator reads the title bar of the task pane, which comes from the add-in name that is specified in the add-in's manifest.
<sup>3</sup> When you use either EdgeHTML or WebView2, the Windows Narrator (sometimes called a "screen reader") reads the `<title>` tag in the page that opens in the task pane. In Trident+, the Narrator reads the title bar of the task pane, which comes from the add-in name that's specified in the add-in's manifest.

<sup>4</sup> If your add-in uses an add-in only manifest and includes the **\<Runtimes\>** element in the manifest or it uses the unified manifest and it includes an "extensions.runtimes.lifetime" property, then it won't use EdgeHTML. If the conditions for using WebView2 are met, then the add-in uses WebView2. Otherwise, it uses Trident+. For more information, see [Runtimes](/javascript/api/manifest/runtimes) and [Configure your Outlook add-in for event-based activation](../outlook/autolaunch.md?tabs=jsonmanifest).

Expand Down Expand Up @@ -152,7 +153,7 @@ To determine if a document is WIP-protected, follow these steps.
1. Open the file.
1. Select the **File** tab on the ribbon.
1. Select **Info**.
1. In the upper section of the **Info** page, just below the file name, a WIP-enabled document will have a briefcase icon followed by **Managed by Work ()**.
1. In the upper section of the **Info** page, just below the file name, a WIP-enabled document will have a briefcase icon followed by **Managed by Work (...)**.

> [!NOTE]
> Support for WebView2 in WIP-enabled documents was added with build 16.0.16626.20132. If you're on an older build, your runtime defaults to **EdgeHTML (Microsoft Edge Legacy)**, regardless of policy.
Expand Down
13 changes: 10 additions & 3 deletions docs/design/add-in-commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Basic concepts for add-in commands
description: Learn how to add custom ribbon buttons and menu items to Excel, Outlook, PowerPoint, and Word as part of an Office Add-in.
ms.date: 08/10/2024
ms.date: 10/15/2024
ms.topic: overview
ms.localizationpriority: high
---
Expand All @@ -21,8 +21,15 @@ There are two types of add-in commands, based on the kind of action that the com

- **Task pane commands**: The button or menu item opens the add-in's [task pane](task-pane-add-ins.md). You add this kind of add-in command with markup in the manifest. The "code behind" the command is provided by Office.
- **Function commands**: The button or menu item runs any arbitrary JavaScript. The code almost always calls APIs in the Office JavaScript Library, but it doesn't have to. This type of add-in typically displays no UI other than the button or menu item itself. Note the following about function commands:
- The function that is triggered can call the [displayDialogAsync](/javascript/api/office/office.ui?view=common-js&preserve-view=true#office-office-ui-displaydialogasync-member(1)) method to show a dialog, which is a good way to display an error, show progress, or prompt for input from the user. If the add-in is configured to use a [shared runtime](../testing/runtimes.md#shared-runtime), the function can also call the [showAsTaskpane](/javascript/api/office/office.addin#office-office-addin-showastaskpane-member(1)) method.
- The runtime in which the function command runs is a full [browser-based runtime](../testing/runtimes.md#browser-runtime). It can render HTML and call out to the Internet to send or get data.

- The runtime in which the function command runs is a full [browser-based runtime](../testing/runtimes.md#browser-runtime). It can render HTML and call out to the Internet to send or get data.
- The runtime closes when either the function completes or 5 minutes have passed, whichever is earlier.
- The function that is triggered can call the [displayDialogAsync](/javascript/api/office/office.ui?view=common-js&preserve-view=true#office-office-ui-displaydialogasync-member(1)) method to show a dialog. This is a good way to display an error, show progress, or prompt the user for input.

> [!NOTE]
> Because of the 5-minute timeout, the dialog should be designed so that users complete their interaction and close it within 5 minutes. Your add-in should use a task pane for longer interactions.
- If the add-in is configured to use a [shared runtime](../testing/runtimes.md#shared-runtime), the function can also call the [showAsTaskpane](/javascript/api/office/office.addin#office-office-addin-showastaskpane-member(1)) method.

## Location of add-in commands

Expand Down
12 changes: 7 additions & 5 deletions docs/design/contextual-tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@ A contextual tab is a hidden tab control in the Office ribbon that's displayed i
## Prerequisites

Custom contextual tabs are currently only supported on **Excel** and only on the following platforms and builds.
- Excel on the web
- Excel on Windows: Version 2102 (Build 13801.20294) and later.
- Excel on Mac: Version 16.53 (21080600) and later.

- Excel on the web
- Excel on Windows: Version 2102 (Build 13801.20294) and later.
- Excel on Mac: Version 16.53 (21080600) and later.

Additionally, custom contextual tabs only work on platforms that support the following requirement sets. For more about requirement sets and how to work with them, see [Specify Office applications and API requirements](../develop/specify-office-hosts-and-api-requirements.md).
- [RibbonApi 1.2](/javascript/api/requirement-sets/common/ribbon-api-requirement-sets)
- [SharedRuntime 1.1](/javascript/api/requirement-sets/common/shared-runtime-requirement-sets)

- [RibbonApi 1.2](/javascript/api/requirement-sets/common/ribbon-api-requirement-sets)
- [SharedRuntime 1.1](/javascript/api/requirement-sets/common/shared-runtime-requirement-sets)

> [!TIP]
> Use the runtime checks in your code to test whether the user's host and platform combination supports these requirement sets as described in [Runtime checks for method and requirement set support](../develop/specify-office-hosts-and-api-requirements.md#runtime-checks-for-method-and-requirement-set-support). (The technique of specifying the requirement sets in the manifest, which is also described in that article, doesn't currently work for RibbonApi 1.2.) Alternatively, you can [implement an alternate UI experience when custom contextual tabs aren't supported](#implement-an-alternate-ui-experience-when-custom-contextual-tabs-arent-supported).
Expand Down
7 changes: 5 additions & 2 deletions docs/design/disable-add-in-commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Enable and Disable Add-in Commands
description: Learn how to change the enabled or disabled status of custom ribbon buttons and menu items in your Office Web Add-in.
ms.date: 08/05/2024
ms.date: 10/08/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand All @@ -13,7 +13,10 @@ When some functionality in your add-in should only be available in certain conte
You can also specify whether the command is enabled or disabled when the Office client application opens.

> [!NOTE]
> This article assumes that you're familiar with the [basic concepts for Add-in Commands](add-in-commands.md). Please review it if you haven't worked with Add-in Commands (custom menu items and ribbon buttons) recently.
>
> - This article assumes that you're familiar with the [basic concepts for Add-in Commands](add-in-commands.md). Please review it if you haven't worked with Add-in Commands (custom menu items and ribbon buttons) recently.
>
> - Programmatically enabling or disabling [context menus](interface-elements.md#add-in-commands) isn't supported. Only ribbon buttons, menus, and tabs are supported.
## Office application and platform support

Expand Down
2 changes: 1 addition & 1 deletion docs/design/fabric-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If your add-in's UI isn't React-based, you can also make use of a set of non-Rea
1. Add the content delivery network (CDN) reference to the HTML on your page.

```html
<link rel="stylesheet" href="https://static2.sharepointonline.com/files/fabric/office-ui-fabric-core/9.6.1/css/fabric.min.css">
<link rel="stylesheet" href="https://res-1.cdn.office.net/files/fabric-cdn-prod_20230815.002/office-ui-fabric-core/11.0.0/css/fabric.min.css">
```

2. Use Fabric Core icons and fonts.
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/development-kit-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Office Add-ins Development Kit helps set up your environment, create Office

## Prerequisites

- Download and install [Visual Studio Code](https://visualstudio.microsoft.com/downloads/).
- Download and install [Visual Studio Code](https://code.visualstudio.com/).
- Node.js (the latest LTS version). Visit the [Node.js site](https://nodejs.org/) to download and install the right version for your operating system. To verify if you've already installed these tools, run the commands `node -v` and `npm -v` in your terminal.
- Office connected to a Microsoft 365 subscription. You might qualify for a Microsoft 365 E5 developer subscription through the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program), see [FAQ](/office/developer-program/microsoft-365-developer-program-faq#who-qualifies-for-a-microsoft-365-e5-developer-subscription-) for details. Alternatively, you can [sign up for a 1-month free trial](https://www.microsoft.com/microsoft-365/try?rtc=1) or [purchase a Microsoft 365 plan](https://www.microsoft.com/microsoft-365/buy/compare-all-microsoft-365-products).

Expand Down
Loading

0 comments on commit 67ad913

Please sign in to comment.