diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts
index 32719bafe9..b224b54b08 100644
--- a/types/office-js-preview/index.d.ts
+++ b/types/office-js-preview/index.d.ts
@@ -335,25 +335,6 @@ declare namespace Office {
* @remarks
*
* Returned by the `status` property of the {@link Office.AsyncResult | AsyncResult} object.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | Y | | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | | Y | | |
- *
*/
enum AsyncResultStatus {
/**
@@ -367,24 +348,6 @@ declare namespace Office {
}
/**
* Specifies whether the add-in was just inserted or was already contained in the document.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Excel | Y | Y | Y |
- * | Project | Y | | |
- * | Word | Y | | Y |
- *
*/
enum InitializationReason {
/**
@@ -398,28 +361,6 @@ declare namespace Office {
}
/**
* Specifies the host Office application in which the add-in is running.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | Y | | | | |
- * | Excel | Y | Y | Y | | |
- * | OneNote | | Y | | Y | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | Y | Y | | |
- *
*/
enum HostType {
/**
@@ -453,28 +394,6 @@ declare namespace Office {
}
/**
* Specifies the OS or other platform on which the Office host application is running.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | Y | | | | |
- * | Excel | Y | Y | Y | | |
- * | OneNote | | Y | | Y | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | Y | Y | | |
- *
*/
enum PlatformType {
/**
@@ -506,9 +425,6 @@ declare namespace Office {
/**
* An object which encapsulates the result of an asynchronous request, including status and error information if the request failed.
*
- * @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
- *
* When the function you pass to the `callback` parameter of an "Async" method executes, it receives an AsyncResult object that you can access
* from the `callback` function's only parameter.
*/
@@ -517,27 +433,6 @@ declare namespace Office {
* Gets the user-defined item passed to the optional `asyncContext` parameter of the invoked method in the same state as it was passed in.
* This returns the user-defined item (which can be of any JavaScript type: String, Number, Boolean, Object, Array, Null, or Undefined) passed
* to the optional `asyncContext` parameter of the invoked method. Returns Undefined, if you didn't pass anything to the asyncContext parameter.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | Y | | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | | | | | |
- * | Word | Y | Y | Y | | |
- *
*/
asyncContext: any;
/**
@@ -545,20 +440,6 @@ declare namespace Office {
*
* @remarks
*
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Outlook | Y (Mailbox Preview) | | | | |
- *
- *
* *Supported APIs*
*
* `Office.context.mailbox.item.getCallbackTokenAsync`, `Office.context.mailbox.item.getUserIdentityTokenAsync`
@@ -573,52 +454,10 @@ declare namespace Office {
diagnostics: any;
/**
* Gets an {@link Office.Error} object that provides a description of the error, if any error occurred.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | | Y | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | Y | Y | | |
- *
*/
error: Office.Error;
/**
* Gets the {@link Office.AsyncResultStatus} of the asynchronous operation.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | | Y | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | Y | Y | | |
- *
*/
status: AsyncResultStatus;
/**
@@ -630,25 +469,6 @@ declare namespace Office {
*
* **Note**: What the value property returns for a particular "Async" method varies depending on the purpose and context of that method.
* To determine what is returned by the value property for an "Async" method, refer to the "Callback value" section of the method's topic.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | | Y | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | Y | Y | | |
- *
*/
value: T;
}
@@ -657,7 +477,7 @@ declare namespace Office {
* The current context exists as a property of Office. It is accessed using `Office.context`.
*
* @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
+ * **Hosts:** Access, Excel, Outlook, PowerPoint, Project, Word
*/
interface Context {
/**
@@ -670,24 +490,10 @@ declare namespace Office {
* True, if the current platform allows the add-in to display a UI for selling or upgrading; otherwise returns False.
*
* @remarks
+ *
* The iOS App Store doesn't support apps with add-ins that provide links to additional payment systems. However, Office Add-ins running on
* the Windows desktop or for Office Online in the browser do allow such links. If you want the UI of your add-in to provide a link to an
* external payment system on platforms other than iOS, you can use the commerceAllowed property to control when that link is displayed.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for iPad |
- * | Excel | Y |
- * | Word | Y |
- *
*/
commerceAllowed: boolean;
/**
@@ -698,25 +504,6 @@ declare namespace Office {
* application.
*
* In content add-ins for Access web apps, the `contentLanguage` property gets the add-in culture (e.g., "en-GB").
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | | Y | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | Y | Y | | |
- *
*/
contentLanguage: string;
/**
@@ -737,48 +524,10 @@ declare namespace Office {
*
* When using in Outlook, the applicable modes are Compose or Read.
*
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | Y | | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | | Y | | |
- *
*/
displayLanguage: string;
/**
* Gets an object that represents the document the content or task pane add-in is interacting with.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Access | | Y | |
- * | Excel | Y | Y | Y |
- * | PowerPoint | Y | Y | Y |
- * | Project | Y | | |
- * | Word | Y | Y | Y |
- *
*/
document: Office.Document;
/**
@@ -803,10 +552,9 @@ declare namespace Office {
* [Api set: Mailbox 1.0]
*
* @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | Restricted |
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Compose or Read |
- *
+ *
+ * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}:** Restricted
+ * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}:** Compose or Read
*/
mailbox: Office.Mailbox;
/**
@@ -830,10 +578,9 @@ declare namespace Office {
* [Api set: Mailbox 1.0]
*
* @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | Restricted |
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Compose or Read |
- *
+ *
+ * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}:** Restricted
+ * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}:** Compose or Read
*/
roamingSettings: Office.RoamingSettings;
/**
@@ -843,22 +590,6 @@ declare namespace Office {
* @remarks
* Use the touchEnabled property to determine when your add-in is running on a touch device and if necessary, adjust the kind of controls, and
* size and spacing of elements in your add-in's UI to accommodate touch interactions.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for iPad |
- * | Excel | Y |
- * | PowerPoint | Y |
- * | Word | Y |
- *
*/
touchEnabled: boolean;
/**
@@ -871,26 +602,7 @@ declare namespace Office {
*
* @remarks
* The Error object is accessed from the AsyncResult object that is returned in the function passed as the callback argument of an asynchronous
- * data operation, such as the setSelectedDataAsync method of the Document object.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | | Y | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | Y | Y | | |
- *
+ * data operation, such as the `setSelectedDataAsync` method of the Document object.
*/
interface Error {
/**
@@ -912,31 +624,19 @@ declare namespace Office {
* which button was clicked and to signal the host that it has completed its processing.
*
* @remarks
+ * See [Add-in commands requirement sets](/office/dev/add-ins/reference/requirement-sets/add-in-commands-requirement-sets) for more support information.
*
- *
- * | Add-in type | Content, task pane, Outlook |
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | Restricted |
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Compose or Read |
- *
+ * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}:** Restricted
+ * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}:** Compose or Read
*/
interface Event {
/**
* Information about the control that triggered calling this function.
*
- * **Support details**
+ * @remarks
*
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this property.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Outlook | Y (Mailbox 1.3) | | |
- *
+ * This property is only supported in Outlook in [requirement set](/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets) Mailbox 1.3 and later.
*/
source:Source;
/**
@@ -953,27 +653,12 @@ declare namespace Office {
*
* @remarks
*
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | Restricted |
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Compose or Read |
- *
+ * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}:** Restricted
+ * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}:** Compose or Read
*
- * **Support details**
+ * This property is only supported in Outlook in [requirement set](/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets) Mailbox 1.3 and later.
*
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Excel | Y | Y | Y |
- * | Outlook | Y (Since Mailbox 1.3: without `options` parameter; Mailbox Preview: adds support for `options` parameter) | | |
- * | PowerPoint | Y | Y | Y |
- * | Word | Y | Y | Y |
- *
+ * Mailbox 1.3 does not have the `options` parameter while Mailbox Preview does have support for `options` parameter)
*
* @param options Optional. An object literal that contains one or more of the following properties.
* allowEvent: A boolean value. When the completed method is used to signal completion of an event handler,
@@ -1006,10 +691,8 @@ declare namespace Office {
* Displays a dialog to show or collect information from the user or to facilitate Web navigation.
*
* @remarks
- *
- * | Hosts | Word, Excel, Outlook, PowerPoint |
- * | Requirement sets | DialogApi, Mailbox 1.4 |
- *
+ * **Hosts:** Word, Excel, Outlook, PowerPoint
+ * **Requirement sets:** DialogApi, Mailbox 1.4
*
* This method is available in the DialogApi requirement set for Word, Excel, or PowerPoint add-ins, and in the Mailbox requirement set 1.4
* for Outlook. For more on how to specify a requirement set in your manifest, see
@@ -1107,10 +790,8 @@ declare namespace Office {
* Displays a dialog to show or collect information from the user or to facilitate Web navigation.
*
* @remarks
- *
- * | Hosts | Word, Excel, Outlook, PowerPoint |
- * | Requirement sets | DialogApi, Mailbox 1.4 |
- *
+ * **Hosts:** >Word, Excel, Outlook, PowerPoint
+ * **Requirement sets:** DialogApi, Mailbox 1.4
*
* This method is available in the DialogApi requirement set for Word, Excel, or PowerPoint add-ins, and in the Mailbox requirement set 1.4
* for Outlook. For more on how to specify a requirement set in your manifest, see
@@ -1212,7 +893,7 @@ declare namespace Office {
* Closes the UI container where the JavaScript is executing.
*
* @remarks
- * | Hosts | Excel, Word, PowerPoint, Outlook (Minimum requirement set: Mailbox 1.5) |
+ * **Hosts:** Excel, Word, PowerPoint, Outlook (Minimum requirement set: Mailbox 1.5)
*
* The behavior of this method is specified by the following:
*
@@ -1285,9 +966,8 @@ declare namespace Office {
* Important: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* @remarks
- * | Hosts | Excel, OneNote, Outlook, PowerPoint, Word |
- *
- * | Requirement sets | {@link https://docs.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | IdentityAPI} |
+ * **Hosts:** Excel, OneNote, Outlook, PowerPoint, Word
+ * **Requirement sets:** {@link https://docs.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | IdentityAPI}
*
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign-in with Organizational
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
@@ -1307,9 +987,8 @@ declare namespace Office {
* Important: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* @remarks
- * | Hosts | Excel, OneNote, Outlook, PowerPoint, Word |
- *
- * | Requirement sets | {@link https://docs.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | IdentityAPI} |
+ * **Hosts:** Excel, OneNote, Outlook, PowerPoint, Word
+ * **Requirement sets:** {@link https://docs.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | IdentityAPI}
*
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign-in with Organizational
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
@@ -1684,24 +1363,6 @@ declare namespace Office {
* Office Account \> Office Theme UI, which is applied across all Office host applications. Using Office theme colors is appropriate for mail and
* task pane add-ins.
*
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that these properties are supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop |
- * | Excel | Y |
- * | Outlook | Y (in preview) |
- * | PowerPoint | Y |
- * | Word | Y |
- *
*/
interface OfficeTheme {
/**
@@ -1751,43 +1412,11 @@ declare namespace Office {
* @param expression The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Access | | Y | |
- * | Excel | Y | Y | Y |
- * | Word | Y | | Y |
- *
*/
function select(expression: string, callback?: (result: AsyncResult) => void): Binding;
// Enumerations
/**
* Specifies the state of the active view of the document, for example, whether the user can edit the document.
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | PowerPoint | Y | Y | Y | Y |
- *
*/
enum ActiveView {
/**
@@ -1801,23 +1430,6 @@ declare namespace Office {
}
/**
* Specifies the type of the binding object that should be returned.
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | Y | | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*/
enum BindingType {
/**
@@ -1838,28 +1450,10 @@ declare namespace Office {
* Specifies how to coerce data returned or set by the invoked method.
*
* @remarks
+ *
* PowerPoint supports only `Office.CoercionType.Text`, `Office.CoercionType.Image`, `Office.CoercionType.SlideRange`, and `Office.CoercionType.XmlSvg`.
*
* Project supports only `Office.CoercionType.Text`.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
- * | Access | Y | | | | |
- * | Excel | Y | Y | Y | | |
- * | Outlook | Y | Y | | Y | Y |
- * | PowerPoint | Y | Y | Y | | |
- * | Project | Y | | | | |
- * | Word | Y | Y | Y | | |
- *
*/
enum CoercionType {
/**
@@ -1916,23 +1510,6 @@ declare namespace Office {
* @remarks
*
* Returned by the mode property of the {@link Office.Document | Document} object.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Excel | Y | Y | Y | Y |
- * | PowerPoint | Y | Y | Y | Y |
- * | Project | Y | | | |
- * | Word | Y | | Y | Y |
- *
*/
enum DocumentMode {
/**
@@ -1948,21 +1525,8 @@ declare namespace Office {
* Specifies the type of the XML node.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
*
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Word | Y | Y | Y | Y |
- *
+ * **Requirement Sets:**: CustomXmlParts.
*/
enum CustomXMLNodeType {
/**
@@ -2000,45 +1564,14 @@ declare namespace Office {
* Add-ins for Project support the `Office.EventType.ResourceSelectionChanged`, `Office.EventType.TaskSelectionChanged`, and
* `Office.EventType.ViewSelectionChanged` event types.
*
- * | BindingDataChanged and BindingSelectionChanged hosts | Access, Excel, Word |
- *
* @remarks
*
- * **Support details**
+ * **`BindingDataChanged` and `BindingSelectionChanged` hosts**: Access, Excel, Word.
*
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Excel | Y | Y | Y |
- * | Outlook | Y | Y | Y |
- * | PowerPoint | Y | Y | |
- * | Project | Y | | |
- * | Word | Y | | Y |
- *
*/
enum EventType {
/**
* A Document.ActiveViewChanged event was raised.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | PowerPoint | Y | Y | Y |
- *
*/
ActiveViewChanged,
/**
@@ -2059,47 +1592,12 @@ declare namespace Office {
* Occurs when data within the binding is changed.
* To add an event handler for the BindingDataChanged event of a binding, use the addHandlerAsync method of the Binding object.
* The event handler receives an argument of type {@link Office.BindingDataChangedEventArgs}.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Access | | Y | |
- * | Excel | Y | Y | Y |
- * | Word | Y | Y | Y |
- *
*/
BindingDataChanged,
/**
* Occurs when the selection is changed within the binding. To add an event handler for the BindingSelectionChanged event of a binding, use
* the addHandlerAsync method of the Binding object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}.
*
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Access | | Y | |
- * | Excel | Y | Y | Y |
- * | Word | Y | Y | Y |
- *
*/
BindingSelectionChanged,
/**
@@ -2112,21 +1610,6 @@ declare namespace Office {
DialogEventReceived,
/**
* Triggers when a document-level selection happens.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Excel | | Y | |
- * | Word | Y | Y | |
- *
*/
DocumentSelectionChanged,
/**
@@ -2179,23 +1662,6 @@ declare namespace Office {
ResourceSelectionChanged,
/**
* A Settings.settingsChanged event was raised.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Access | | Y | |
- * | Excel | Y | Y | Y |
- * | PowerPoint | Y | Y | Y |
- * | Word | Y | Y | Y |
- *
*/
SettingsChanged,
/**
@@ -2211,23 +1677,7 @@ declare namespace Office {
* Specifies the format in which to return the document.
*
* @remarks
- * FileType.Text is only supported in Word, FileType.Pdf is only supported in Word for Windows, Word for Mac, Word Online, and PowerPoint.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Excel | Y | Y | Y | Y |
- * | PowerPoint | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
+ * `FileType.Text` is only supported in Word, `FileType.Pdf` is only supported in Word for Windows, Word for Mac, Word Online, and PowerPoint.
*/
enum FileType {
/**
@@ -2245,24 +1695,6 @@ declare namespace Office {
}
/**
* Specifies whether filtering from the host application is applied when the data is retrieved.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Excel | Y | Y | Y |
- * | Project | Y | | |
- * | Word | Y | | Y |
- *
*/
enum FilterType {
/**
@@ -2276,24 +1708,6 @@ declare namespace Office {
}
/**
* Specifies the type of place or object to navigate to.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Excel | Y | Y | Y |
- * | PowerPoint | Y | Y | Y |
- * | Word | Y | | Y |
- *
*/
enum GoToType {
/**
@@ -2324,22 +1738,6 @@ declare namespace Office {
}
/**
* Specifies the relative PowerPoint slide.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | PowerPoint | Y | Y | Y |
- *
*/
enum Index {
/**
@@ -2361,24 +1759,6 @@ declare namespace Office {
}
/**
* Specifies whether to select (highlight) the location to navigate to (when using the {@link Office.Document | Document}.goToByIdAsync method).
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Excel | Y | Y | Y |
- * | PowerPoint | Y | | |
- * | Word | Y | | Y |
- *
*/
enum SelectionMode {
Default,
@@ -2398,22 +1778,6 @@ declare namespace Office {
* For example, if the valueFormat parameter is specified as "formatted", a number formatted as currency, or a date formatted as mm/dd/yy in the
* host application will have its formatting preserved. If the valueFormat parameter is specified as "unformatted", a date will be returned in its
* underlying sequential serial number form.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this enumeration.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
- * | Excel | Y | Y | Y |
- * | Project | Y | | |
- * | Word | Y | | Y |
- *
*/
enum ValueFormat {
/**
@@ -2430,7 +1794,7 @@ declare namespace Office {
* Represents a binding to a section of the document.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* The Binding object exposes the functionality possessed by all bindings regardless of type.
*
@@ -2439,26 +1803,8 @@ declare namespace Office {
* and setDataAsync methods from the Binding object that enable to you interact with the data in the binding. They also inherit the id and type
* properties for querying those property values. Additionally, the MatrixBinding and TableBinding objects expose additional methods for matrix-
* and table-specific features, such as counting the number of rows and columns.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*/
interface Binding {
-
-
/**
* Get the Document object associated with the binding.
*/
@@ -2500,7 +1846,7 @@ declare namespace Office {
* Returns the data contained within the binding.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow,
* startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range).
@@ -2515,7 +1861,7 @@ declare namespace Office {
* Returns the data contained within the binding.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow,
* startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range).
@@ -2529,7 +1875,7 @@ declare namespace Office {
* Removes the specified handler from the binding for the specified event type.
*
* @remarks
- * | Requirement Sets | BindingEvents |
+ * **Requirement Sets:** BindingEvents
*
* @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`.
* @param options Provides options to determine which event handler or handlers are removed.
@@ -2540,7 +1886,7 @@ declare namespace Office {
* Removes the specified handler from the binding for the specified event type.
*
* @remarks
- * | Requirement Sets | BindingEvents |
+ * **Requirement Sets:** BindingEvents
*
* @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -2550,8 +1896,7 @@ declare namespace Office {
* Writes data to the bound section of the document represented by the specified binding object.
*
* @remarks
- *
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* The value passed for data contains the data to be written in the binding. The kind of value passed determines what will be written as
* described in the following table.
@@ -2681,8 +2026,7 @@ declare namespace Office {
* Writes data to the bound section of the document represented by the specified binding object.
*
* @remarks
- *
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* The value passed for data contains the data to be written in the binding. The kind of value passed determines what will be written as
* described in the following table.
@@ -2812,7 +2156,7 @@ declare namespace Office {
* Provides information about the binding that raised the DataChanged event.
*
* @remarks
- *
+ * **Hosts:** Access, Excel, Word
*/
interface BindingDataChangedEventArgs {
/**
@@ -2830,7 +2174,7 @@ declare namespace Office {
* Provides information about the binding that raised the SelectionChanged event.
*
* @remarks
- *
+ * **Hosts:** Access, Excel, Word
*/
interface BindingSelectionChangedEventArgs {
/**
@@ -2889,31 +2233,13 @@ declare namespace Office {
interface Bindings {
/**
* Gets an {@link Office.Document} object that represents the document associated with this set of bindings.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this property.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*/
document: Document;
/**
* Creates a binding against a named object in the document.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* For Excel, the itemName parameter can refer to a named range or a table.
*
@@ -2933,21 +2259,6 @@ declare namespace Office {
* **Note**: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
* these content controls with this method (by specifying its name as the itemName parameter), the operation will fail.
*
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
* @param itemName Name of the bindable object in the document. For Example 'MyExpenses' table in Excel."
* @param bindingType The {@link Office.BindingType} for the data. The method returns null if the selected object cannot be coerced into the specified type.
* @param options Provides options for configuring the binding that is created.
@@ -2959,7 +2270,7 @@ declare namespace Office {
* Creates a binding against a named object in the document.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* For Excel, the itemName parameter can refer to a named range or a table.
*
@@ -2979,21 +2290,6 @@ declare namespace Office {
* **Note**: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
* these content controls with this method (by specifying its name as the itemName parameter), the operation will fail.
*
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
* @param itemName Name of the bindable object in the document. For Example 'MyExpenses' table in Excel."
* @param bindingType The {@link Office.BindingType} for the data. The method returns null if the selected object cannot be coerced into the specified type.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3004,25 +2300,10 @@ declare namespace Office {
* Create a binding by prompting the user to make a selection on the document.
*
* @remarks
- * | Requirement Sets | Not in a set |
+ * **Requirement Sets:** Not in a set
*
* Adds a binding object of the specified type to the Bindings collection, which will be identified with the supplied id.
* The method fails if the specified selection cannot be bound.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- *
*
* @param bindingType Specifies the type of the binding object to create. Required.
* Returns null if the selected object cannot be coerced into the specified type.
@@ -3035,25 +2316,10 @@ declare namespace Office {
* Create a binding by prompting the user to make a selection on the document.
*
* @remarks
- * | Requirement Sets | Not in a set |
+ * **Requirement Sets:** Not in a set
*
* Adds a binding object of the specified type to the Bindings collection, which will be identified with the supplied id.
* The method fails if the specified selection cannot be bound.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- *
*
* @param bindingType Specifies the type of the binding object to create. Required.
* Returns null if the selected object cannot be coerced into the specified type.
@@ -3065,7 +2331,7 @@ declare namespace Office {
* Create a binding based on the user's current selection.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id.
*
@@ -3073,22 +2339,6 @@ declare namespace Office {
* binding is used, and its type cannot be changed by specifying a different value for the bindingType parameter.
* If you need to use an existing id and change the bindingType, call the Bindings.releaseByIdAsync method first to release the binding, and
* then call the addFromSelectionAsync method to reestablish the binding with a new type.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*
* @param bindingType Specifies the type of the binding object to create. Required.
* Returns null if the selected object cannot be coerced into the specified type.
@@ -3101,7 +2351,7 @@ declare namespace Office {
* Create a binding based on the user's current selection.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id.
*
@@ -3109,22 +2359,6 @@ declare namespace Office {
* binding is used, and its type cannot be changed by specifying a different value for the bindingType parameter.
* If you need to use an existing id and change the bindingType, call the Bindings.releaseByIdAsync method first to release the binding, and
* then call the addFromSelectionAsync method to reestablish the binding with a new type.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*
* @param bindingType Specifies the type of the binding object to create. Required.
* Returns null if the selected object cannot be coerced into the specified type.
@@ -3136,24 +2370,8 @@ declare namespace Office {
* Gets all bindings that were previously created.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
- *
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is an array that contains each binding created for the referenced Bindings object.
@@ -3163,23 +2381,7 @@ declare namespace Office {
* Gets all bindings that were previously created.
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* @param callback A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is an array that contains each binding created for the referenced Bindings object.
@@ -3189,25 +2391,9 @@ declare namespace Office {
* Retrieves a binding based on its Name
*
* @remarks
- * | Requirement Sets | CustomXmlParts, MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** CustomXmlParts, MatrixBindings, TableBindings, TextBindings
*
* Fails if the specified id does not exist.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*
* @param id Specifies the unique name of the binding object. Required.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3219,25 +2405,9 @@ declare namespace Office {
* Retrieves a binding based on its Name
*
* @remarks
- * | Requirement Sets | CustomXmlParts, MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** CustomXmlParts, MatrixBindings, TableBindings, TextBindings
*
* Fails if the specified id does not exist.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*
* @param id Specifies the unique name of the binding object. Required.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3248,25 +2418,9 @@ declare namespace Office {
* Removes the binding from the document
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* Fails if the specified id does not exist.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*
* @param id Specifies the unique name to be used to identify the binding object. Required.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3277,25 +2431,9 @@ declare namespace Office {
* Removes the binding from the document
*
* @remarks
- * | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings
*
* Fails if the specified id does not exist.
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this method.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Access | | Y | | |
- * | Excel | Y | Y | Y | Y |
- * | Word | Y | Y | Y | Y |
- *
*
* @param id Specifies the unique name to be used to identify the binding object. Required.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3306,49 +2444,35 @@ declare namespace Office {
* Represents an XML node in a tree in a document.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Word | Y | Y | Y | Y |
- *
+ * **Requirement Sets:** CustomXmlParts
*/
interface CustomXmlNode {
/**
* Gets the base name of the node without the namespace prefix, if one exists.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*/
baseName: string;
/**
* Retrieves the string GUID of the CustomXMLPart.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*/
namespaceUri: string;
/**
* Gets the type of the CustomXMLNode.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*/
nodeType: string;
/**
* Gets the nodes associated with the XPath expression.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param xPath The XPath expression that specifies the nodes to get. Required.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3360,7 +2484,7 @@ declare namespace Office {
* Gets the nodes associated with the XPath expression.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param xPath The XPath expression that specifies the nodes to get. Required.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3371,7 +2495,7 @@ declare namespace Office {
* Gets the node value.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3382,7 +2506,7 @@ declare namespace Office {
* Gets the node value.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is a string that contains the value of the referenced node.
@@ -3392,7 +2516,7 @@ declare namespace Office {
* Gets the text of an XML node in a custom XML part.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3403,7 +2527,7 @@ declare namespace Office {
* Gets the text of an XML node in a custom XML part.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is a string that contains the inner text of the referenced nodes.
@@ -3413,7 +2537,7 @@ declare namespace Office {
* Gets the node's XML.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3424,7 +2548,7 @@ declare namespace Office {
* Gets the node's XML.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is a string that contains the XML of the referenced node.
@@ -3434,7 +2558,7 @@ declare namespace Office {
* Sets the node value.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param value The value to be set on the node
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3445,7 +2569,7 @@ declare namespace Office {
* Sets the node value.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param value The value to be set on the node
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3455,10 +2579,8 @@ declare namespace Office {
* Asynchronously sets the text of an XML node in a custom XML part.
*
* @remarks
- *
- * | Hosts | Word |
- * | Requirement Sets | CustomXmlParts |
- *
+ * **Hosts:** Word
+ * **Requirement Sets:** CustomXmlParts
*
* @param text Required. The text value of the XML node.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3469,10 +2591,8 @@ declare namespace Office {
* Asynchronously sets the text of an XML node in a custom XML part.
*
* @remarks
- *
- * | Hosts | Word |
- * | Requirement Sets | CustomXmlParts |
- *
+ * **Hosts:** Word
+ * **Requirement Sets:** CustomXmlParts
*
* @param text Required. The text value of the XML node.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3482,7 +2602,7 @@ declare namespace Office {
* Sets the node XML.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param xml The XML to be set on the node
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3493,7 +2613,7 @@ declare namespace Office {
* Sets the node XML.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
+ * **Requirement Sets:** CustomXmlParts
*
* @param xml The XML to be set on the node
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -3504,21 +2624,7 @@ declare namespace Office {
* Represents a single CustomXMLPart in an {@link Office.CustomXmlParts} collection.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Word | Y | Y | Y | Y |
- *
+ * **Requirement Sets:** CustomXmlParts
*/
interface CustomXmlPart {
/**
@@ -3630,22 +2736,6 @@ declare namespace Office {
/**
* Provides information about the deleted node that raised the nodeDeleted event.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Word | Y | Y | Y | Y |
- *
*/
interface NodeDeletedEventArgs {
/**
@@ -3667,22 +2757,6 @@ declare namespace Office {
/**
* Provides information about the inserted node that raised the nodeInserted event.
- *
- * @remarks
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Word | Y | Y | Y | Y |
- *
*/
interface NodeInsertedEventArgs {
/**
@@ -3699,21 +2773,6 @@ declare namespace Office {
/**
* Provides information about the replaced node that raised the nodeReplaced event.
- *
- * @remarks
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Word | Y | Y | Y | Y |
- *
*/
interface NodeReplacedEventArgs {
/**
@@ -3739,21 +2798,7 @@ declare namespace Office {
* Represents a collection of CustomXmlPart objects.
*
* @remarks
- * | Requirement Sets | CustomXmlParts |
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Word | Y | | Y | Y |
- *
+ * **Requirement Sets:** CustomXmlParts
*/
interface CustomXmlParts {
/**
@@ -3814,22 +2859,7 @@ declare namespace Office {
* Represents a collection of CustomXmlPart objects.
*
* @remarks
- *
- * | Requirement Sets | CustomXmlParts |
- *
- * **Support details**
- *
- * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application.
- * An empty cell indicates that the Office host application doesn't support this interface.
- *
- * For more information about Office host application and server requirements, see
- * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
- *
- * *Supported hosts, by platform*
- *
- * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | Office for Mac |
- * | Word | Y | Y | Y | Y |
- *
+ * **Requirement Sets:** CustomXmlParts
*/
interface CustomXmlPrefixMappings {
/**
@@ -3914,7 +2944,7 @@ declare namespace Office {
* An abstract class that represents the document the add-in is interacting with.
*
* @remarks
- * | Hosts | Access, Excel, PowerPoint, Project, Word |
+ * **Hosts:** Access, Excel, PowerPoint, Project, Word
*/
interface Document {
/**
@@ -4035,7 +3065,7 @@ declare namespace Office {
* Adds an event handler for a Document object event.
*
* @remarks
- * | Requirement Sets | DocumentEvents |
+ * **Requirement Sets:** DocumentEvents
*
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
*
@@ -4068,7 +3098,7 @@ declare namespace Office {
* Adds an event handler for a Document object event.
*
* @remarks
- * | Requirement Sets | DocumentEvents |
+ * **Requirement Sets:** DocumentEvents
*
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
*
@@ -4100,7 +3130,7 @@ declare namespace Office {
* Returns the state of the current view of the presentation (edit or read).
*
* @remarks
- * | Requirement Sets | ActiveView |
+ * **Requirement Sets:** ActiveView
*
* Can trigger an event when the view changes.
*
@@ -4129,7 +3159,7 @@ declare namespace Office {
* Returns the state of the current view of the presentation (edit or read).
*
* @remarks
- * | Requirement Sets | ActiveView |
+ * **Requirement Sets:** ActiveView
*
* Can trigger an event when the view changes.
*
@@ -4158,7 +3188,7 @@ declare namespace Office {
* Note that specifying file slice size of above permitted limit will result in an "Internal Error" failure.
*
* @remarks
- *
+ * **Requirement Sets:** File
*
* For add-ins running in Office host applications other than Office for iOS, the getFileAsync method supports getting files in slices of up
* to 4194304 bytes (4 MB). For add-ins running in Office for iOS apps, the getFileAsync method supports getting files in slices of up to
@@ -4202,7 +3232,7 @@ declare namespace Office {
* Note that specifying file slice size of above permitted limit will result in an "Internal Error" failure.
*
* @remarks
- *
+ * **Requirement Sets:** File
*
* For add-ins running in Office host applications other than Office for iOS, the getFileAsync method supports getting files in slices of up
* to 4194304 bytes (4 MB). For add-ins running in Office for iOS apps, the getFileAsync method supports getting files in slices of up to
@@ -4244,7 +3274,7 @@ declare namespace Office {
* Gets file properties of the current document.
*
* @remarks
- * | Requirement Sets | Not in a set |
+ * **Requirement Sets:** Not in a set
*
* You get the file's URL with the url property `asyncResult.value.url`.
*
@@ -4273,7 +3303,7 @@ declare namespace Office {
* Gets file properties of the current document.
*
* @remarks
- * | Requirement Sets | Not in a set |
+ * **Requirement Sets:** Not in a set
*
* You get the file's URL with the url property `asyncResult.value.url`.
*
@@ -4301,7 +3331,7 @@ declare namespace Office {
* Reads the data contained in the current selection in the document.
*
* @remarks
- * | Requirement Sets | Selection |
+ * **Requirement Sets:** Selection
*
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
* the following information.
@@ -4397,7 +3427,7 @@ declare namespace Office {
* Reads the data contained in the current selection in the document.
*
* @remarks
- * | Requirement Sets | Selection |
+ * **Requirement Sets:** Selection
*
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
* the following information.
@@ -4490,7 +3520,7 @@ declare namespace Office {
* Goes to the specified object or location in the document.
*
* @remarks
- * | Requirement Sets | not in a set |
+ * **Requirement Sets:** not in a set
*
* PowerPoint doesn't support the goToByIdAsync method in Master Views.
*
@@ -4532,7 +3562,7 @@ declare namespace Office {
* Goes to the specified object or location in the document.
*
* @remarks
- * | Requirement Sets | not in a set |
+ * **Requirement Sets:** not in a set
*
* PowerPoint doesn't support the goToByIdAsync method in Master Views.
*
@@ -4573,7 +3603,7 @@ declare namespace Office {
* Removes an event handler for the specified event type.
*
* @remarks
- * | Requirement Sets | DocumentEvents |
+ * **Requirement Sets:** DocumentEvents
*
* **Support details**
*
@@ -4602,7 +3632,7 @@ declare namespace Office {
* Removes an event handler for the specified event type.
*
* @remarks
- * | Requirement Sets | DocumentEvents |
+ * **Requirement Sets:** DocumentEvents
*
* **Support details**
*
@@ -4630,7 +3660,7 @@ declare namespace Office {
* Writes the specified data into the current selection.
*
* @remarks
- * | Requirement Sets | Selection |
+ * **Requirement Sets:** Selection
*
* **Application-specific behaviors**
*
@@ -4817,7 +3847,7 @@ declare namespace Office {
* Writes the specified data into the current selection.
*
* @remarks
- * | Requirement Sets | Selection |
+ * **Requirement Sets:** Selection
*
* **Application-specific behaviors**
*
@@ -5743,7 +4773,7 @@ declare namespace Office {
* Gets the document file size in bytes.
*
* @remarks
- *
+ * **Requirement Sets:** File
*/
size: number;
/**
@@ -5755,7 +4785,7 @@ declare namespace Office {
*
* @remarks
*
- *
+ * **Requirement Sets:** File
*
* No more than two documents are allowed to be in memory; otherwise the Document.getFileAsync operation will fail. Use the File.closeAsync
* method to close the file when you are finished working with it.
@@ -5793,7 +4823,7 @@ declare namespace Office {
* Returns the specified slice.
*
* @remarks
- *
+ * **Requirement Sets:** File
*
* In the callback function passed to the getSliceAsync method, you can use the properties of the AsyncResult object to return the following
* information.
@@ -5837,7 +4867,7 @@ declare namespace Office {
* Represents a binding in two dimensions of rows and columns.
*
* @remarks
- * | Requirement Sets | MatrixBindings |
+ * **Requirement Sets:** MatrixBindings
*
* The MatrixBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Binding object.
*
@@ -5907,7 +4937,7 @@ declare namespace Office {
*
* @remarks
*
- *
+ * **Requirement Sets:** Settings
*
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
*
@@ -5964,7 +4994,7 @@ declare namespace Office {
*
* @remarks
*
- *
+ * **Requirement Sets:** Settings
*
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
*
@@ -6015,7 +5045,7 @@ declare namespace Office {
* Retrieves the specified setting.
*
* @remarks
- *
+ * **Requirement Sets:** Settings
*
* **Support details**
*
@@ -6043,7 +5073,7 @@ declare namespace Office {
*
* @remarks
*
- *
+ * **Requirement Sets:** Settings
*
* This method is useful in Excel, Word, and PowerPoint coauthoring scenarios when multiple instances of the same add-in are working against
* the same document. Because each add-in is working against an in-memory copy of the settings loaded from the document at the time the user
@@ -6106,7 +5136,7 @@ declare namespace Office {
* call the Settings.saveAsync method.
*
* @remarks
- *
+ * **Requirement Sets:** Settings
*
* null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag.
*
@@ -6135,7 +5165,7 @@ declare namespace Office {
*
* @remarks
*
- *
+ * **Requirement Sets:** Settings
*
* If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType
* will be removed.
@@ -6171,7 +5201,7 @@ declare namespace Office {
*
* @remarks
*
- *
+ * **Requirement Sets:** Settings
*
* If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType
* will be removed.
@@ -6323,7 +5353,7 @@ declare namespace Office {
* the document.
*
* @remarks
- *
+ * **Requirement Sets:** Settings
*
* The set method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name
* in the in-memory copy of the settings property bag. After you call the Settings.saveAsync method, the value is stored in the document as
@@ -6355,7 +5385,7 @@ declare namespace Office {
* Provides information about the settings that raised the settingsChanged event.
*
* @remarks
- *
+ * **Requirement Sets:** Settings
*
* To add an event handler for the settingsChanged event, use the addHandlerAsync method of the
* {@link Office.Settings} object.
@@ -6401,7 +5431,7 @@ declare namespace Office {
* Represents a slice of a document file.
*
* @remarks
- *
+ * **Requirement Sets:** File
*
* The Slice object is accessed with the File.getSliceAsync method.
*
@@ -6443,7 +5473,7 @@ declare namespace Office {
* Represents a binding in two dimensions of rows and columns, optionally with headers.
*
* @remarks
- * | Requirement Sets | TableBindings |
+ * **Requirement Sets:** TableBindings
*
* The TableBinding object inherits the `id` property, `type` property, `getDataAsync` method, and `setDataAsync` method from the
* {@link Office.Binding} object.
@@ -7327,7 +6357,7 @@ declare namespace Office {
* Represents a bound text selection in the document.
*
* @remarks
- * | Requirement Sets | TextBindings |
+ * **Requirement Sets:** TextBindings
*
* The TextBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the {@link Office.Binding}
* object. It does not implement any additional properties or methods of its own.