Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/concepts/privacy-and-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,6 @@ To see an example of how to request permissions in the manifest, open the tab fo

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

The following example shows how a task pane add-in specifies the **read document** permission in its manifest. To keep permissions as the focus, other elements in the manifest aren't displayed.

```json
Expand Down
2 changes: 0 additions & 2 deletions docs/design/built-in-button-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ Open the tab for the type of manifest your add-in uses for the details of the ma

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

## Insert a built-in control group into a custom tab

To insert a built-in Office control group into a custom tab, add a group object with a [`"builtInGroupId"`](/microsoft-365/extensibility/schema/extension-ribbons-array-tabs-item#builtintabid) property *instead of an [`"id"`](/microsoft-365/extensibility/schema/extension-ribbons-array-tabs-item#id) property* to the [`"groups"`](/microsoft-365/extensibility/schema/extension-ribbons-array-tabs-item#groups) array of your custom tab object. Set to the ID of the built-in group. See [Find the IDs of controls and control groups](#find-the-ids-of-controls-and-control-groups). *The built-in group object should have no other properties.*
Expand Down
3 changes: 0 additions & 3 deletions docs/design/content-add-ins.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,6 @@ There are minor differences in the manifests between content add-ins and add-ins

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

> [!NOTE]
> The unified manifest is available in Excel, PowerPoint, and Word as a developer preview. For Outlook, it's generally available and can be used in production add-ins.

Configure the manifest with the following steps.

1. Add a [`"contentRuntimes"`](/microsoft-365/extensibility/schema/element-extensions#contentruntimes) child array to the extension object in the [`"extensions"`](/microsoft-365/extensibility/schema/root#extensions) array.
Expand Down
2 changes: 0 additions & 2 deletions docs/design/contextual-tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -630,8 +630,6 @@ The add-in's manifest provides a way to create a fallback experience in an add-i

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

Begin by defining a custom core tab (that is, *noncontextual* custom tab) in the manifest that duplicates the ribbon customizations of the custom contextual tabs in your add-in. Then, mark any control groups, or individual controls, or menu items that shouldn't be visible on platforms that support contextual tabs. You mark a group, control, or menu item object by adding an `"overriddenByRibbonApi"` property to it and setting its value to `true`. The effect of doing so is the following:

- If the add-in runs on an application and platform that support custom contextual tabs, then the marked custom groups, controls, and menu items won't appear on the ribbon. Instead, the custom contextual tab will be created when the add-in calls the `requestCreateControls` method.
Expand Down
2 changes: 0 additions & 2 deletions docs/design/custom-tab-placement.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ By default, a custom tab is added to the end of the ribbon. However, you can spe

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

To position your custom tab, include a [`"position"`](/microsoft-365/extensibility/schema/extension-ribbons-array-tabs-item-position) property in the [`"extensions.ribbons.tabs"`](/microsoft-365/extensibility/schema/extension-ribbons-array#tabs) object. Set the `"position.builtInTabId"` property to the ID of the built-in tab that you want your custom tab to be next to. (See [Find the IDs of built-in Office ribbon tabs](../develop/built-in-ui-ids.md).) Set the `"position.align"` property to either `"before"` (left) or `"after"` (right).

In the following example, the custom tab is configured to appear *just after* the **Review** tab.
Expand Down
2 changes: 0 additions & 2 deletions docs/design/disable-add-in-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,6 @@ By default, a custom button or menu item on the ribbon is available for use when

#### Unified manifest for Microsoft 365

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

Just add an [`"enabled"`](/microsoft-365/extensibility/schema/extension-common-custom-group-controls-item#enabled) property with the value `false` to the control or menu item object. The following shows the basic structure.

```json
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/add-in-manifests.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ms.localizationpriority: high
Every Office add-in has a manifest. There are two types of manifests:

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

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

Expand Down
2 changes: 0 additions & 2 deletions docs/develop/agents-toolkit-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ A primary tool for developing Microsoft 365 apps and agents, including Office Ad

Add-ins created with Agents Toolkit use the [unified manifest for Microsoft 365](unified-manifest-overview.md).

[!INCLUDE [Unified manifest support note for Office applications](../includes/unified-manifest-support-note.md)]

> [!TIP]
> There's another Visual Studio Code extension that creates Office Add-ins that use the add-in only manifest. See [Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code](development-kit-overview.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,6 @@ Configure the manifest to specify the task pane page that should open automatica

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

To specify the task pane to open automatically, find the runtime object in the [`"runtimes"`](/microsoft-365/extensibility/schema/element-extensions#runtimes) array whose [`"code.page"`](/microsoft-365/extensibility/schema/extension-runtime-code#page) property is set to the URL of the page that you want to open automatically. Ensure that the [`"actions"`](/microsoft-365/extensibility/schema/extension-runtimes-actions-item) array in this same runtime object has at least one action whose `"type"` value is `"openPage"`. Add a `"view"` property to this action object and set it to `"Office.AutoShowTaskpaneWithDocument"`. You can only set this value on one action object and it must be an action of type `"openPage"`. If you set this value on multiple actions, the first occurrence of the value will be recognized and the others will be ignored.

The following example shows a `"view"` value set to `"Office.AutoShowTaskpaneWithDocument"`.
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/automatically-open-on-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ The process for specifying the default task pane depends on the type of manifest

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

To specify the default task pane, find the runtime object in the [`"runtimes"`](/microsoft-365/extensibility/schema/element-extensions#runtimes) array whose [`"code.page"`](/microsoft-365/extensibility/schema/extension-runtime-code#page) property is set to the URL of the page that you want to be the default. Ensure that the [`"actions"`](/microsoft-365/extensibility/schema/extension-runtimes-actions-item) array in this same runtime object has at least one action whose `"type"` value is `"openPage"`. Add a `"view"` property to this action object and set it to `"Office.AutoShowTaskpaneWithDocument"`. You can only set this value on one action object and it must be an action of type `"openPage"`. If you set this value on multiple actions, the first occurrence of the value will be recognized as the default and the others will be ignored.

The following example shows a `"view"` value set to `"Office.AutoShowTaskpaneWithDocument"`.
Expand Down
3 changes: 0 additions & 3 deletions docs/develop/configure-your-add-in-to-use-a-shared-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ Follow these steps to configure a new or existing project to use a shared runtim

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

> [!NOTE]
> Implementing a shared runtime with the unified 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).

1. Open your add-in project in Visual Studio Code.
1. Open the **manifest.json** file.
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.
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/convert-xml-to-json-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ ms.localizationpriority: medium

To add Teams capabilities or a Copilot extension to an add-in that uses the add-in only manifest, or to just future proof the add-in, you need to convert it to use the unified manifest for Microsoft 365.

[!INCLUDE [Unified manifest support note for Office applications](../includes/unified-manifest-support-note.md)]

There are three basic tasks to converting an add-in project from the add-in only manifest to the unified manifest.

- Ensure that your manifest is ready to convert.
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/create-addin-commands-unified-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ Add-in commands provide an easy way to customize the default Office user interfa

This article describes how to configure the [Unified manifest for Microsoft 365](unified-manifest-overview.md) to define add-in commands and how to create the code for [function commands](../design/add-in-commands.md#types-of-add-in-commands).

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

> [!TIP]
> Instructions for creating add-in commands with the add-in only manifest are in [Create add-in commands with the add-in only manifest](create-addin-commands.md).

Expand Down
2 changes: 0 additions & 2 deletions docs/develop/dialog-api-in-office-add-ins.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,8 +367,6 @@ dialog.messageChild(messageToDialog, { targetOrigin: "*" });

The add-in's manifest specifies trusted domains. In the unified manifest for Microsoft 365, this is specified in the "validDomains" property. In the add-in only manifest, this is specified in the `<AppDomains>` element.

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

But the runtime that's hosting the dialog can't access the manifest and thereby determine whether the domain *from which the message comes* is trusted, you must use the `DialogParentMessageReceived` handler to determine this. The object that's passed to the handler contains the domain that's currently hosted in the parent as its `origin` property. The following is an example of how to use the property.

```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,6 @@ In a text editor, add the following code to the manifest file. If you're using a

# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

> [!NOTE]
> The unified manifest is generally available for production Outlook add-ins. It's available only for preview in Excel, PowerPoint, and Word add-ins.

```json
{
"$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json#",
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/json-manifest-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ ms.localizationpriority: high

This article is intended to help readers who are familiar with the add-in only manifest understand the unified manifest by comparing the two. Readers should also see [Office Add-ins with the unified manifest for Microsoft 365](unified-manifest-overview.md).

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

## Schemas and general points

There is just one schema for the [unified manifest](https://raw.githubusercontent.com/OfficeDev/microsoft-teams-app-schema/preview/DevPreview/MicrosoftTeams.schema.json), in contrast to the add-in only manifest which has a total of seven [schemas](/openspecs/office_file_formats/ms-owemxml/c6a06390-34b8-4b42-82eb-b28be12494a8).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ These permissions specify the subset of the API that the add-in [runtime](../tes
},
```

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

- **Add-in only manifest**: Use the [Permissions](/javascript/api/manifest/permissions) element of the manifest. The following example requests the **write document** permission, which allows only methods that can write to (but not read) the document.

```XML
Expand Down
5 changes: 1 addition & 4 deletions docs/develop/show-hide-add-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,7 @@ The previous code is a handler that is registered for the [Office.Worksheet.onDe

When you call `Office.addin.showAsTaskpane()`, Office will display in a task pane the file that you specified in the manifest. The configuration depends on what type of manifest you're using.

- **Unified manifest for Microsoft 365**: The URL of the file is assigned as the value of a "runtimes.code.page" property of the runtime object which has an action object of type "openPage".

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

- **Unified manifest for Microsoft 365**: The URL of the file is assigned as the value of a "runtimes.code.page" property of the runtime object which has an action object of type "openPage".
- **Add-in only manifest**: The URL of the file is assigned as the resource ID (`resid`) value of the task pane. This `resid` value can be assigned or changed by opening your manifest file and locating `<SourceLocation>` inside the `<Action xsi:type="ShowTaskpane">` element.

(See [Configure your Office Add-in to use a shared runtime](configure-your-add-in-to-use-a-shared-runtime.md) for additional details.)
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/support-for-task-pane-and-content-add-ins.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,6 @@ Your add-in uses the app manifest to request permission to access the level of f
},
```

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

- **Add-in only manifest**: Use the `Permissions` element in the manifest For example, if your add-in requires read/write access to the document, its manifest must specify `ReadWriteDocument` as the text value in its `Permissions` element. Because permissions exist to protect a user's privacy and security, as a best practice you should request the minimum level of permissions it needs for its features. The following example shows how to request the **read document** permission in a task pane's manifest.

```XML
Expand Down
4 changes: 0 additions & 4 deletions docs/develop/unified-manifest-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ Microsoft is making a number of improvements to the Microsoft 365 developer plat

One important improvement is the ability to create a single unit of distribution for all your Microsoft 365 extensions by using the same manifest format and schema.

We've taken an important first step toward these goals by making it possible for you to create Outlook add-ins with a unified manifest for Microsoft 365.

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

> [!TIP]
> Ready to get started with the unified manifest? Begin with [Build an Outlook add-in with the unified manifest for Microsoft 365](../quickstarts/outlook-quickstart-json-manifest.md).

Expand Down
2 changes: 0 additions & 2 deletions docs/includes/unified-manifest-support-note.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/quickstarts/fluent-react-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ The add-in project that you've created with the Yeoman generator contains sample

- The **./manifest.xml** or **./manifest.json** file in the root directory of the project defines the settings and capabilities of the add-in. To learn more about the **manifest.xml** file, see [Office Add-ins with the add-in only manifest](../develop/xml-manifest-overview.md). To learn more about the **manifest.json** file, see [Office Add-ins with the unified app manifest for Microsoft 365](../develop/unified-manifest-overview.md).

[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)]

- The **./src/taskpane/taskpane.html** file contains the HTML markup for the task pane and loads the Office JavaScript Library. It also tests whether the webview control supports Fluent UI React v9 and displays a special message if it doesn't.
- The **./src/taskpane/index.jsx (tsx)** file is the React root component. It loads React and Fluent UI React, ensures that the Office JavaScript library has been loaded, and applies the Fluent-defined theme.
- The **./src/taskpane/office-document.js (ts)** file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office client application.
Expand Down
8 changes: 1 addition & 7 deletions docs/tutorials/excel-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,6 @@ In this tutorial, you'll create an Excel task pane add-in that:

Next, select the type of manifest that you'd like to use, either the **unified manifest for Microsoft 365** or the **add-in only manifest**. Most of the steps in this tutorial are the same regardless of the manifest type, but the [Protect a worksheet](#protect-a-worksheet) section has separate steps for each manifest type.

> [!NOTE]
> Using the unified manifest for Microsoft 365 with Excel add-ins is in public developer preview. The unified manifest for Microsoft 365 shouldn't be used in production Excel 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).

After you complete the wizard, the generator creates the project and installs supporting Node components. You may need to manually run `npm install` in the root folder of your project if something fails during the initial setup.

## Create a table
Expand Down Expand Up @@ -482,10 +479,7 @@ In this step of the tutorial, you'll add a button to the ribbon that toggles wor

The steps vary depending on the type of manifest.

# [Unified manifest for Microsoft 365 (preview)](#tab/jsonmanifest)

> [!NOTE]
> Using the unified manifest for Microsoft 365 with Excel add-ins is in public developer preview. The unified manifest for Microsoft 365 shouldn't be used in production Excel 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).
# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

#### Configure the runtime for the ribbon button

Expand Down