diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index b224b54b08..9b35c3f8c0 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -692,7 +692,9 @@ declare namespace Office { * * @remarks * **Hosts:** Word, Excel, Outlook, PowerPoint - * **Requirement sets:** DialogApi, Mailbox 1.4 + * **Requirement sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets | 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 @@ -791,7 +793,9 @@ declare namespace Office { * * @remarks * **Hosts:** >Word, Excel, Outlook, PowerPoint - * **Requirement sets:** DialogApi, Mailbox 1.4 + * **Requirement sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets | 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 @@ -886,6 +890,10 @@ declare namespace Office { displayDialogAsync(startAddress: string, callback?: (result: AsyncResult) => void): void; /** * Delivers a message from the dialog box to its parent/opener page. The page calling this API must be on the same domain as the parent. + * + * @remarks + * **Requirement sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi} + * * @param message Accepts a message from the dialog to deliver to the add-in. In addition to a boolean, anything that can serialized to a string including JSON and XML can be sent. */ messageParent(message: boolean | string): void; @@ -894,6 +902,7 @@ declare namespace Office { * * @remarks * **Hosts:** Excel, Word, PowerPoint, Outlook (Minimum requirement set: Mailbox 1.5) + * **Requirement sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi} * * The behavior of this method is specified by the following: * @@ -967,7 +976,7 @@ declare namespace Office { * * @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} + * **Requirement sets:** {@link https://docs.microsoft.com/en-us/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | 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. @@ -988,7 +997,7 @@ declare namespace Office { * * @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} + * **Requirement sets:** {@link https://docs.microsoft.com/en-us/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | 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. @@ -1384,6 +1393,9 @@ declare namespace Office { } /** * The object that is returned when `UI.displayDialogAsync` is called. It exposes methods for registering event handlers and closing the dialog. + * + * @remarks + * **Requirement Set:** [DialogApi](/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets) */ interface Dialog { /** @@ -1523,10 +1535,6 @@ declare namespace Office { } /** * Specifies the type of the XML node. - * - * @remarks - * - * **Requirement Sets:**: CustomXmlParts. */ enum CustomXMLNodeType { /** @@ -1793,9 +1801,6 @@ declare namespace Office { /** * Represents a binding to a section of the document. * - * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings - * * The Binding object exposes the functionality possessed by all bindings regardless of type. * * The Binding object is never called directly. It is the abstract parent class of the objects that represent each type of binding: @@ -1822,6 +1827,9 @@ declare namespace Office { * `Office.EventType.BindingDataChanged` and `Office.EventType.BindingSelectionChanged`. * * @remarks + * + * **Requirement Set:** [BindingEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#bindingevents) + * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * * @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`. @@ -1835,6 +1843,9 @@ declare namespace Office { * `Office.EventType.BindingDataChanged` and `Office.EventType.BindingSelectionChanged`. * * @remarks + * + * **Requirement Set:** [BindingEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#bindingevents) + * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * * @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`. @@ -1846,7 +1857,15 @@ declare namespace Office { * Returns the data contained within the binding. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * 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). @@ -1861,8 +1880,16 @@ declare namespace Office { * Returns the data contained within the binding. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings - * + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * 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). * @@ -1875,8 +1902,9 @@ declare namespace Office { * Removes the specified handler from the binding for the specified event type. * * @remarks - * **Requirement Sets:** BindingEvents - * + * + * **Requirement Set:** [BindingEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -1886,8 +1914,9 @@ declare namespace Office { * Removes the specified handler from the binding for the specified event type. * * @remarks - * **Requirement Sets:** BindingEvents - * + * + * **Requirement Set:** [BindingEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. */ @@ -1896,8 +1925,16 @@ 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:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * 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. * @@ -2026,7 +2063,14 @@ declare namespace Office { * Writes data to the bound section of the document represented by the specified binding object. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * 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. @@ -2239,7 +2283,10 @@ declare namespace Office { * Creates a binding against a named object in the document. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * For Excel, the itemName parameter can refer to a named range or a table. * @@ -2270,7 +2317,9 @@ declare namespace Office { * Creates a binding against a named object in the document. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * For Excel, the itemName parameter can refer to a named range or a table. * @@ -2300,7 +2349,7 @@ 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:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | 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. @@ -2316,7 +2365,7 @@ 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:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | 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. @@ -2331,7 +2380,10 @@ declare namespace Office { * Create a binding based on the user's current selection. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id. * @@ -2351,7 +2403,10 @@ declare namespace Office { * Create a binding based on the user's current selection. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id. * @@ -2370,8 +2425,11 @@ declare namespace Office { * Gets all bindings that were previously created. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings - * + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} + * * @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. @@ -2381,7 +2439,10 @@ declare namespace Office { * Gets all bindings that were previously created. * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | 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. @@ -2391,7 +2452,10 @@ declare namespace Office { * Retrieves a binding based on its Name * * @remarks - * **Requirement Sets:** CustomXmlParts, MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * Fails if the specified id does not exist. * @@ -2405,7 +2469,10 @@ declare namespace Office { * Retrieves a binding based on its Name * * @remarks - * **Requirement Sets:** CustomXmlParts, MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * Fails if the specified id does not exist. * @@ -2418,7 +2485,10 @@ declare namespace Office { * Removes the binding from the document * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * Fails if the specified id does not exist. * @@ -2431,7 +2501,10 @@ declare namespace Office { * Removes the binding from the document * * @remarks - * **Requirement Sets:** MatrixBindings, TableBindings, TextBindings + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * Fails if the specified id does not exist. * @@ -2442,37 +2515,25 @@ declare namespace Office { } /** * Represents an XML node in a tree in a document. - * - * @remarks - * **Requirement Sets:** CustomXmlParts */ interface CustomXmlNode { /** * Gets the base name of the node without the namespace prefix, if one exists. - * - * @remarks - * **Requirement Sets:** CustomXmlParts */ baseName: string; /** * Retrieves the string GUID of the CustomXMLPart. - * - * @remarks - * **Requirement Sets:** CustomXmlParts */ namespaceUri: string; /** * Gets the type of the CustomXMLNode. - * - * @remarks - * **Requirement Sets:** CustomXmlParts */ nodeType: string; /** * Gets the nodes associated with the XPath expression. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -2484,7 +2545,7 @@ declare namespace Office { * Gets the nodes associated with the XPath expression. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2495,7 +2556,7 @@ declare namespace Office { * Gets the node value. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2506,7 +2567,7 @@ declare namespace Office { * Gets the node value. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -2516,7 +2577,7 @@ declare namespace Office { * Gets the text of an XML node in a custom XML part. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2527,7 +2588,7 @@ declare namespace Office { * Gets the text of an XML node in a custom XML part. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -2537,7 +2598,7 @@ declare namespace Office { * Gets the node's XML. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2548,7 +2609,7 @@ declare namespace Office { * Gets the node's XML. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -2558,7 +2619,7 @@ declare namespace Office { * Sets the node value. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -2569,7 +2630,7 @@ declare namespace Office { * Sets the node value. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2579,8 +2640,7 @@ declare namespace Office { * Asynchronously sets the text of an XML node in a custom XML part. * * @remarks - * **Hosts:** Word - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -2591,8 +2651,7 @@ declare namespace Office { * Asynchronously sets the text of an XML node in a custom XML part. * * @remarks - * **Hosts:** Word - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2602,7 +2661,7 @@ declare namespace Office { * Sets the node XML. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -2613,7 +2672,7 @@ declare namespace Office { * Sets the node XML. * * @remarks - * **Requirement Sets:** CustomXmlParts + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2622,9 +2681,6 @@ declare namespace Office { } /** * Represents a single CustomXMLPart in an {@link Office.CustomXmlParts} collection. - * - * @remarks - * **Requirement Sets:** CustomXmlParts */ interface CustomXmlPart { /** @@ -2643,6 +2699,7 @@ declare namespace Office { * Adds an event handler to the object using the specified event type. * * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -2658,6 +2715,7 @@ declare namespace Office { * Adds an event handler to the object using the specified event type. * * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -2670,6 +2728,9 @@ declare namespace Office { addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, callback?: (result: AsyncResult) => void): void; /** * Deletes the Custom XML Part. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2677,12 +2738,18 @@ declare namespace Office { deleteAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Deletes the Custom XML Part. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ deleteAsync(callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param xPath An XPath expression that specifies the nodes you want returned. Required. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -2692,6 +2759,9 @@ declare namespace Office { getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param xPath An XPath expression that specifies the nodes you want returned. Required. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -2700,6 +2770,9 @@ declare namespace Office { getNodesAsync(xPath: string, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the XML inside this custom XML part. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -2708,6 +2781,9 @@ declare namespace Office { getXmlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the XML inside this custom XML part. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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 CustomXmlPart object. @@ -2715,6 +2791,9 @@ declare namespace Office { getXmlAsync(callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for the specified event type. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as * `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`. @@ -2725,6 +2804,9 @@ declare namespace Office { removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, options?: RemoveHandlerOptions, callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for the specified event type. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as * `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`. @@ -2796,13 +2878,13 @@ declare namespace Office { /** * Represents a collection of CustomXmlPart objects. - * - * @remarks - * **Requirement Sets:** CustomXmlParts */ interface CustomXmlParts { /** * Asynchronously adds a new custom XML part to a file. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param xml The XML to add to the newly created custom XML part. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -2812,6 +2894,9 @@ declare namespace Office { addAsync(xml: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously adds a new custom XML part to a file. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param xml The XML to add to the newly created custom XML part. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -2820,6 +2905,9 @@ declare namespace Office { addAsync(xml: string, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part by its id. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param id The GUID of the custom XML part, including opening and closing braces. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -2830,6 +2918,9 @@ declare namespace Office { getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part by its id. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param id The GUID of the custom XML part, including opening and closing braces. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -2839,6 +2930,9 @@ declare namespace Office { getByIdAsync(id: string, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part(s) by its namespace. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param ns The namespace URI. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -2848,6 +2942,9 @@ declare namespace Office { getByNamespaceAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part(s) by its namespace. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param ns The namespace URI. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -2857,15 +2954,15 @@ declare namespace Office { } /** * Represents a collection of CustomXmlPart objects. - * - * @remarks - * **Requirement Sets:** CustomXmlParts */ interface CustomXmlPrefixMappings { /** * Asynchronously adds a prefix to namespace mapping to use when querying an item. * * @remarks + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If no namespace is assigned to the requested prefix, the method returns an empty string (""). * * @param prefix Specifies the prefix to add to the prefix mapping list. Required. @@ -2878,6 +2975,9 @@ declare namespace Office { * Asynchronously adds a prefix to namespace mapping to use when querying an item. * * @remarks + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If no namespace is assigned to the requested prefix, the method returns an empty string (""). * * @param prefix Specifies the prefix to add to the prefix mapping list. Required. @@ -2889,7 +2989,9 @@ declare namespace Office { * Asynchronously gets the namespace mapped to the specified prefix. * * @remarks - * + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one * added or used by the data store internally, in which case it will return an error. * @@ -2903,7 +3005,9 @@ declare namespace Office { * Asynchronously gets the namespace mapped to the specified prefix. * * @remarks - * + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one * added or used by the data store internally, in which case it will return an error. * @@ -2916,7 +3020,9 @@ declare namespace Office { * Asynchronously gets the prefix for the specified namespace. * * @remarks - * + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in * the namespace manager, the method returns the first prefix that matches the supplied namespace. * @@ -2930,7 +3036,9 @@ declare namespace Office { * Asynchronously gets the prefix for the specified namespace. * * @remarks - * + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in * the namespace manager, the method returns the first prefix that matches the supplied namespace. * @@ -2953,139 +3061,31 @@ declare namespace Office { * @remarks * You don't instantiate the Document object directly in your script. To call members of the Document object to interact with the current * document or worksheet, use `Office.context.document` in your script. - * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ bindings: Bindings; /** * Gets an object that represents the custom XML parts in the document. - * - * @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
Word Y Y Y Y
*/ customXmlParts: CustomXmlParts; /** * Gets the mode the document is in. - * - * @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
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ mode: DocumentMode; /** * Gets an object that represents the saved custom settings of the content or task pane add-in for the current document. - * - * @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
OneNote Y
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ settings: Settings; /** * Gets the URL of the document that the host application currently has open. Returns null if the URL is unavailable. - * - * @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
Access Y
Excel Y Y Y
PowerPoint Y
Word Y Y Y
*/ url: string; /** * Adds an event handler for a Document object event. * * @remarks - * **Requirement Sets:** DocumentEvents + * **Requirement Sets:** [DocumentEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. - * - * **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
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
* * @param eventType For a Document object event, the eventType parameter can be specified as `Office.EventType.Document.SelectionChanged` or * `Office.EventType.Document.ActiveViewChanged`, or the corresponding text value of this enumeration. @@ -3098,27 +3098,9 @@ declare namespace Office { * Adds an event handler for a Document object event. * * @remarks - * **Requirement Sets:** DocumentEvents + * **Requirement Sets:** [DocumentEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. - * - * **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
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
* * @param eventType For a Document object event, the eventType parameter can be specified as `Office.EventType.Document.SelectionChanged` or * `Office.EventType.Document.ActiveViewChanged`, or the corresponding text value of this enumeration. @@ -3130,23 +3112,9 @@ declare namespace Office { * Returns the state of the current view of the presentation (edit or read). * * @remarks - * **Requirement Sets:** ActiveView + * **Requirement Sets:** [ActiveView](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#activeview) * * Can trigger an event when the view changes. - * - * **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
PowerPoint Y Y Y Y
* * @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}. @@ -3159,23 +3127,9 @@ declare namespace Office { * Returns the state of the current view of the presentation (edit or read). * * @remarks - * **Requirement Sets:** ActiveView + * **Requirement Sets:** [ActiveView](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#activeview) * * Can trigger an event when the view changes. - * - * **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
PowerPoint Y Y Y Y
* * @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 the state of the presentation's current view. @@ -3188,7 +3142,10 @@ declare namespace Office { * Note that specifying file slice size of above permitted limit will result in an "Internal Error" failure. * * @remarks - * **Requirement Sets:** File + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#compressedfile | CompressedFile} (when using `Office.FileType.Compressed`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#file | File}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`) * * 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 @@ -3204,22 +3161,6 @@ declare namespace Office { * PowerPoint for Windows desktop, Mac, iPad, and PowerPoint Online: `Office.FileType.Compressed`, `Office.FileType.Pdf` * * Word for Windows desktop, Mac, iPad, and Word Online: `Office.FileType.Compressed`, `Office.FileType.Pdf`, `Office.FileType.Text` - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y Y
* * @param fileType The format in which the file will be returned * @param options Provides options for setting the size of slices that the document will be divided into. @@ -3232,8 +3173,10 @@ declare namespace Office { * Note that specifying file slice size of above permitted limit will result in an "Internal Error" failure. * * @remarks - * **Requirement Sets:** File - * + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#compressedfile | CompressedFile} (when using `Office.FileType.Compressed`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#file | File}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`) + * * 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 * 65536 (64 KB). @@ -3248,22 +3191,6 @@ declare namespace Office { * PowerPoint for Windows desktop, Mac, iPad, and PowerPoint Online: `Office.FileType.Compressed`, `Office.FileType.Pdf` * * Word for Windows desktop, Mac, iPad, and Word Online: `Office.FileType.Compressed`, `Office.FileType.Pdf`, `Office.FileType.Text` - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y Y
* * @param fileType The format in which the file will be returned * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -3274,25 +3201,9 @@ declare namespace Office { * Gets file properties of the current document. * * @remarks - * **Requirement Sets:** Not in a set + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * You get the file's URL with the url property `asyncResult.value.url`. - * - * **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
Excel Y Y Y Y
PowerPoint 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}. @@ -3303,25 +3214,9 @@ declare namespace Office { * Gets file properties of the current document. * * @remarks - * **Requirement Sets:** Not in a set + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * You get the file's URL with the url property `asyncResult.value.url`. - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y Y
* * @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 the file's properties (with the URL found at `asyncResult.value.url`). @@ -3331,7 +3226,13 @@ declare namespace Office { * Reads the data contained in the current selection in the document. * * @remarks - * **Requirement Sets:** Selection + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#selection | Selection}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * 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. @@ -3396,23 +3297,6 @@ declare namespace Office { * * * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
- * * @param coercionType The type of data structure to return. See the remarks section for each host's supported coercion types. * * @param options Provides options for customizing what data is returned and how it is formatted. @@ -3427,7 +3311,13 @@ declare namespace Office { * Reads the data contained in the current selection in the document. * * @remarks - * **Requirement Sets:** Selection + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#selection | Selection}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * 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. @@ -3492,23 +3382,6 @@ declare namespace Office { * * * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
- * * @param coercionType The type of data structure to return. See the remarks section for each host's supported coercion types. * @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 the data in the current selection. @@ -3520,7 +3393,7 @@ declare namespace Office { * Goes to the specified object or location in the document. * * @remarks - * **Requirement Sets:** not in a set + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * PowerPoint doesn't support the goToByIdAsync method in Master Views. * @@ -3534,22 +3407,6 @@ declare namespace Office { * * In Word: `Office.SelectionMode.Selected` selects all content in the binding. Office.SelectionMode.None for text bindings, moves the cursor * to the beginning of the text; for matrix bindings and table bindings, selects the first data cell (not first cell in header row for tables). - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y
* * @param id The identifier of the object or location to go to. * @param goToType The type of the location to go to. @@ -3562,7 +3419,7 @@ declare namespace Office { * Goes to the specified object or location in the document. * * @remarks - * **Requirement Sets:** not in a set + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * PowerPoint doesn't support the goToByIdAsync method in Master Views. * @@ -3576,22 +3433,6 @@ declare namespace Office { * * In Word: `Office.SelectionMode.Selected` selects all content in the binding. Office.SelectionMode.None for text bindings, moves the cursor * to the beginning of the text; for matrix bindings and table bindings, selects the first data cell (not first cell in header row for tables). - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y
* * @param id The identifier of the object or location to go to. * @param goToType The type of the location to go to. @@ -3603,25 +3444,7 @@ declare namespace Office { * Removes an event handler for the specified event type. * * @remarks - * **Requirement Sets:** DocumentEvents - * - * **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
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
+ * **Requirement Sets:** [DocumentEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#documentevents) * * @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'. * @param options Provides options to determine which event handler or handlers are removed. @@ -3632,25 +3455,7 @@ declare namespace Office { * Removes an event handler for the specified event type. * * @remarks - * **Requirement Sets:** DocumentEvents - * - * **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
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
+ * **Requirement Sets:** [DocumentEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#documentevents) * * @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -3660,7 +3465,14 @@ declare namespace Office { * Writes the specified data into the current selection. * * @remarks - * **Requirement Sets:** Selection + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#imagecoercion | ImageCoercion} (when using `Office.CoercionType.Image`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#selection | Selection}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * **Application-specific behaviors** * @@ -3794,22 +3606,6 @@ declare namespace Office { * * * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
* * @param data The data to be set. Either a string or {@link Office.CoercionType} value, 2d array or TableData object. * @@ -3847,7 +3643,14 @@ declare namespace Office { * Writes the specified data into the current selection. * * @remarks - * **Requirement Sets:** Selection + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#imagecoercion | ImageCoercion} (when using `Office.CoercionType.Image`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#selection | Selection}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * **Application-specific behaviors** * @@ -3980,22 +3783,6 @@ declare namespace Office { * * * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
* * @param data The data to be set. Either a string or {@link Office.CoercionType} value, 2d array or TableData object. * @@ -4034,22 +3821,6 @@ declare namespace Office { * @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}. * The `value` property of the result contains the `fieldValue` property, which represents the value of the specified field. - * - * @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)
Project Y
*/ getProjectFieldAsync(fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4058,21 +3829,6 @@ declare namespace Office { * @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 contains the `fieldValue` property, which represents the value of the specified field. * - * @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)
Project Y
*/ getProjectFieldAsync(fieldId: number, callback?: (result: AsyncResult) => void): void; /** @@ -4083,21 +3839,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getResourceFieldAsync(resourceId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4107,21 +3848,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getResourceFieldAsync(resourceId: string, fieldId: number, callback?: (result: AsyncResult) => void): void; /** @@ -4130,21 +3856,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getSelectedResourceAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4152,21 +3863,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getSelectedResourceAsync(callback?: (result: AsyncResult) => void): void; /** @@ -4175,21 +3871,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getSelectedTaskAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4197,21 +3878,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getSelectedTaskAsync(callback?: (result: AsyncResult) => void): void; /** @@ -4222,21 +3888,6 @@ declare namespace Office { * `viewName` - The name of the view, as a ProjectViewTypes constant. * `viewType` - The type of view, as the integer value of a ProjectViewTypes constant. * - * @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)
Project Y
*/ getSelectedViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4246,21 +3897,6 @@ declare namespace Office { * `viewName` - The name of the view, as a ProjectViewTypes constant. * `viewType` - The type of view, as the integer value of a ProjectViewTypes constant. * - * @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)
Project Y
*/ getSelectedViewAsync(callback?: (result: AsyncResult) => void): void; /** @@ -4273,21 +3909,6 @@ declare namespace Office { * `wssTaskId` - The ID of the task in the synchronized SharePoint task list. If the project is not synchronized with a SharePoint task list, the value is 0. * `resourceNames` - The comma-separated list of the names of resources that are assigned to the task. * - * @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)
Project Y
*/ getTaskAsync(taskId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4299,21 +3920,6 @@ declare namespace Office { * `wssTaskId` - The ID of the task in the synchronized SharePoint task list. If the project is not synchronized with a SharePoint task list, the value is 0. * `resourceNames` - The comma-separated list of the names of resources that are assigned to the task. * - * @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)
Project Y
*/ getTaskAsync(taskId: string, callback?: (result: AsyncResult) => void): void; /** @@ -4324,21 +3930,6 @@ declare namespace Office { * @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 contains the `fieldValue` property, which represents the value of the specified field. * - * @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)
Project Y
*/ getTaskFieldAsync(taskId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4348,21 +3939,6 @@ declare namespace Office { * @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 contains the `fieldValue` property, which represents the value of the specified field. * - * @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)
Project Y
*/ getTaskFieldAsync(taskId: string, fieldId: number, callback?: (result: AsyncResult) => void): void; /** @@ -4373,21 +3949,6 @@ declare namespace Office { * `listName` - the name of the synchronized SharePoint task list. * `serverUrl` - the URL of the synchronized SharePoint task list. * - * @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)
Project Y
*/ getWSSUrlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4397,21 +3958,6 @@ declare namespace Office { * `listName` - the name of the synchronized SharePoint task list. * `serverUrl` - the URL of the synchronized SharePoint task list. * - * @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)
Project Y
*/ getWSSUrlAsync(callback?: (result: AsyncResult) => void): void; /** @@ -4423,21 +3969,6 @@ declare namespace Office { * @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 the highest index number in the current project's resource collection. * - * @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)
Project Y
*/ getMaxResourceIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4448,21 +3979,6 @@ declare namespace Office { * @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 the highest index number in the current project's resource collection. * - * @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)
Project Y
*/ getMaxResourceIndexAsync(callback?: (result: AsyncResult) => void): void; /** @@ -4474,21 +3990,6 @@ declare namespace Office { * @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 the highest index number in the current project's task collection. * - * @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)
Project Y
*/ getMaxTaskIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4499,21 +4000,6 @@ declare namespace Office { * @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 the highest index number in the current project's task collection. * - * @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)
Project Y
*/ getMaxTaskIndexAsync(callback?: (result: AsyncResult) => void): void; /** @@ -4526,21 +4012,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getResourceByIndexAsync(resourceIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4552,21 +4023,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getResourceByIndexAsync(resourceIndex: number, callback?: (result: AsyncResult) => void): void; /** @@ -4579,21 +4035,6 @@ declare namespace Office { * @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 the GUID of the task as a string. * - * @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)
Project Y
*/ getTaskByIndexAsync(taskIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4605,21 +4046,6 @@ declare namespace Office { * @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 the GUID of the task as a string. * - * @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)
Project Y
*/ getTaskByIndexAsync(taskIndex: number, callback?: (result: AsyncResult) => void): void; /** @@ -4633,21 +4059,6 @@ declare namespace Office { * @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}. * - * @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)
Project Y
*/ setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4660,21 +4071,6 @@ declare namespace Office { * @param fieldValue Value of the target field. * @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)
Project Y
*/ setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult) => void): void; /** @@ -4688,21 +4084,6 @@ declare namespace Office { * @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}. * - * @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)
Project Y
*/ setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4715,21 +4096,6 @@ declare namespace Office { * @param fieldValue Value of the target field. * @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)
Project Y
*/ setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult) => void): void; } @@ -4752,28 +4118,10 @@ declare namespace Office { * @remarks * Access the File object with the AsyncResult.value property in the callback function passed to the Document.getFileAsync method. * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ interface File { /** * Gets the document file size in bytes. - * - * @remarks - * **Requirement Sets:** File */ size: number; /** @@ -4785,7 +4133,7 @@ declare namespace Office { * * @remarks * - * **Requirement Sets:** File + * **Requirement Sets:** [File](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -4823,7 +4171,7 @@ declare namespace Office { * Returns the specified slice. * * @remarks - * **Requirement Sets:** File + * **Requirement Sets:** [File](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -4867,44 +4215,16 @@ declare namespace Office { * Represents a binding in two dimensions of rows and columns. * * @remarks - * **Requirement Sets:** MatrixBindings - * * The MatrixBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Binding 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 Office for Mac
Excel Y Y Y Y
Word Y Y Y Y
*/ interface MatrixBinding extends Binding { /** * Gets the number of columns in the matrix data structure, as an integer value. - * - * @remarks - * - * - * - *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsMatrixBindings
*/ columnCount: number; /** * Gets the number of rows in the matrix data structure, as an integer value. - * - * @remarks - * - * - * - *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsMatrixBindings
*/ rowCount: number; } @@ -4912,10 +4232,6 @@ declare namespace Office { * Represents custom settings for a task pane or content add-in that are stored in the host document as name/value pairs. * * @remarks - * - * - * - *
HostsAccess, Excel, PowerPoint, Word
Requirement SetsSettings
* * The settings created by using the methods of the Settings object are saved per add-in and per document. * That is, they are available only to the add-in that created them, and only from the document in which they are saved. @@ -4936,9 +4252,6 @@ declare namespace Office { * spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. * * @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. * * @param eventType Specifies the type of event to add. Required. @@ -4968,21 +4281,6 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
*/ addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4993,8 +4291,6 @@ declare namespace Office { * spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. * * @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. * @@ -5024,45 +4320,13 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
*/ addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void; /** * Retrieves the specified setting. * * @remarks - * **Requirement Sets:** Settings - * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} * * @param settingName The case-sensitive name of the setting to retrieve. * @returns An object that has property names mapped to JSON serialized values. @@ -5072,8 +4336,7 @@ declare namespace Office { * Reads all settings persisted in the document and refreshes the content or task pane add-in's copy of those settings held in memory. * * @remarks - * - * **Requirement Sets:** Settings + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | 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 @@ -5106,23 +4369,6 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
PowerPoint Y Y
Word Y Y
* * @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 an {@link Office.Settings} object with the refreshed values. @@ -5136,27 +4382,10 @@ declare namespace Office { * call the Settings.saveAsync method. * * @remarks - * **Requirement Sets:** Settings + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} * * null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag. * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
- * * @param settingName The case-sensitive name of the setting to remove. */ remove(name: string): void; @@ -5164,8 +4393,6 @@ declare namespace Office { * Removes an event handler for the settingsChanged event. * * @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. @@ -5175,21 +4402,6 @@ declare namespace Office { * * In the callback function passed to the removeHandlerAsync method, you can use the properties of the AsyncResult object to return the * following information. - * - * **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
* * @param eventType Specifies the type of event to remove. Required. * @param options Provides options to determine which event handler or handlers are removed. @@ -5200,8 +4412,6 @@ declare namespace Office { * Removes an event handler for the settingsChanged event. * * @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. @@ -5211,21 +4421,6 @@ declare namespace Office { * * In the callback function passed to the removeHandlerAsync method, you can use the properties of the AsyncResult object to return the * following information. - * - * **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
* * @param eventType Specifies the type of event to remove. Required. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -5235,6 +4430,8 @@ declare namespace Office { * Persists the in-memory copy of the settings property bag in the document. * * @remarks + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * * Any settings previously saved by an add-in are loaded when it is initialized, so during the lifetime of the session you can just use the * set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are * available the next time the add-in is used, use the saveAsync method. @@ -5267,23 +4464,6 @@ declare namespace Office { * * * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
- * * @param options Provides options for saving settings. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ @@ -5292,6 +4472,8 @@ declare namespace Office { * Persists the in-memory copy of the settings property bag in the document. * * @remarks + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * * Any settings previously saved by an add-in are loaded when it is initialized, so during the lifetime of the session you can just use the * set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are * available the next time the add-in is used, use the saveAsync method. @@ -5324,23 +4506,6 @@ declare namespace Office { * * * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
- * * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ saveAsync(callback?: (result: AsyncResult) => void): void; @@ -5353,29 +4518,12 @@ declare namespace Office { * the document. * * @remarks - * **Requirement Sets:** Settings + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | 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 * the serialized JSON representation of its data type. A maximum of 2MB is available for the settings of each add-in. * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
- * * @param settingName The case-sensitive name of the setting to set or create. * @param value Specifies the value to be stored. */ @@ -5384,9 +4532,6 @@ 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. * @@ -5401,21 +4546,6 @@ declare namespace Office { * is running with any Excel client, but the event will fire only when the add-in is loaded with a spreadsheet * that is opened in Excel Online, and more than one user is editing the spreadsheet (co-authoring). * Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. - * - * **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
Excel Y
Word Y Y
*/ interface SettingsChangedEventArgs { /** @@ -5428,27 +4558,7 @@ declare namespace Office { type: EventType; } /** - * Represents a slice of a document file. - * - * @remarks - * **Requirement Sets:** File - * - * The Slice object is accessed with the File.getSliceAsync method. - * - * **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
PowerPoint Y Y Y
Word Y Y Y
+ * Represents a slice of a document file. The Slice object is accessed with the `File.getSliceAsync` method. */ interface Slice { /** @@ -5473,7 +4583,6 @@ declare namespace Office { * Represents a binding in two dimensions of rows and columns, optionally with headers. * * @remarks - * **Requirement Sets:** TableBindings * * The TableBinding object inherits the `id` property, `type` property, `getDataAsync` method, and `setDataAsync` method from the * {@link Office.Binding} object. @@ -5484,46 +4593,10 @@ declare namespace Office { interface TableBinding extends Binding { /** * Gets the number of columns in the TableBinding, as an integer value. - * - * @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
*/ columnCount: number; /** * True, if the table has headers; otherwise false. - * - * @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
*/ hasHeaders: boolean; /** @@ -5543,22 +4616,6 @@ declare namespace Office { * strings. * * In content add-ins for Access, for performance reasons the rowCount property always returns -1. - * - * **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
*/ rowCount: number; /** @@ -5582,22 +4639,6 @@ declare namespace Office { * * Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in * a single call to this method. - * - * **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 tableData An array of arrays ("matrix") or a TableData object that contains one or more columns of data to add to the table. Required. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -5625,22 +4666,6 @@ declare namespace Office { * * Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in * a single call to this method. - * - * **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 tableData An array of arrays ("matrix") or a TableData object that contains one or more columns of data to add to the table. Required. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -5664,22 +4689,6 @@ declare namespace Office { * * Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in * a single call to this method. - * - * **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 rows An array of arrays ("matrix") or a TableData object that contains one or more rows of data to add to the table. Required. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -5704,22 +4713,6 @@ declare namespace Office { * * Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in * a single call to this method. - * - * **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 rows An array of arrays ("matrix") or a TableData object that contains one or more rows of data to add to the table. Required. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -5731,22 +4724,6 @@ declare namespace Office { * @remarks * * In Excel, if the table has no header row, this method will delete the table itself. - * - * **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 Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -5758,22 +4735,6 @@ declare namespace Office { * @remarks * * In Excel, if the table has no header row, this method will delete the table itself. - * - * **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 callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ @@ -5783,20 +4744,6 @@ declare namespace Office { * * @remarks * See {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | Format tables in add-ins for Excel} for more information. - * - * **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
Excel Y Y Y Y
* * @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}. @@ -5807,20 +4754,6 @@ declare namespace Office { * * @remarks * See {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | Format tables in add-ins for Excel} for more information. - * - * **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
Excel Y Y Y Y
* * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ @@ -6025,20 +4958,6 @@ declare namespace Office { * * For more details and examples, see * {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | How to format tables in add-ins for Excel}. - * - * **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
Excel Y Y Y Y
* * @param cellFormat An array that contains one or more JavaScript objects that specify which cells to target and the formatting to apply to them. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -6138,20 +5057,6 @@ declare namespace Office { * * For more details and examples, see * {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | How to format tables in add-ins for Excel}. - * - * **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
Excel Y Y Y Y
* * @param cellFormat An array that contains one or more JavaScript objects that specify which cells to target and the formatting to apply to them. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -6161,10 +5066,8 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * - * - * - *
HostsExcel
Requirement SetsNot in a set
+ * **Hosts:** Excel + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information. * @@ -6190,20 +5093,6 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
Excel Y Y Y Y
* * @param tableOptions An object literal containing a list of property name-value pairs that define the table options to apply. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -6215,10 +5104,8 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * - * - * - *
HostsExcel
Requirement SetsNot in a set
+ * **Hosts:** Excel + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information. * @@ -6244,20 +5131,6 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
Excel Y Y Y Y
* * @param tableOptions An object literal containing a list of property name-value pairs that define the table options to apply. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -6267,12 +5140,6 @@ declare namespace Office { } /** * Represents the data in a table or an {@link Office.TableBinding}. - * - * @remarks - * - * - * - *
HostsExcel, Word
Requirement SetsTableBindings
*/ class TableData { constructor(rows: any[][], headers: any[]); @@ -6281,10 +5148,6 @@ declare namespace Office { * Gets or sets the headers of the table. * * @remarks - * - * - * - *
HostsExcel, Word
Requirement SetsTableBindings
* * To specify headers, you must specify an array of arrays that corresponds to the structure of the table. For example, to specify headers * for a two-column table you would set the header property to [['header1', 'header2']]. @@ -6302,10 +5165,6 @@ declare namespace Office { * Returns an empty array if there are no rows. * * @remarks - * - * - * - *
HostsExcel, Word
Requirement SetsTableBindings
* * To specify rows, you must specify an array of arrays that corresponds to the structure of the table. For example, to specify two rows of * string values in a two-column table you would set the rows property to [['a', 'b'], ['c', 'd']]. @@ -6322,22 +5181,6 @@ declare namespace Office { /** * Specifies enumerated values for the `cells` property in the cellFormat parameter of * {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | table formatting methods}. - * - * @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
Excel Y Y Y Y
*/ enum Table { /** @@ -6355,27 +5198,9 @@ declare namespace Office { } /** * Represents a bound text selection in the document. - * - * @remarks - * **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. - * - * **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
Excel Y Y Y Y
Word Y Y Y Y
*/ interface TextBinding extends Binding { } /** @@ -6384,20 +5209,6 @@ declare namespace Office { * @remarks * * A ProjectProjectFields constant can be used as a parameter of the {@link Office.Document | Document}.getProjectFieldAsync method. - * - * **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)
Project Y
*/ enum ProjectProjectFields { /** @@ -6460,20 +5271,6 @@ declare namespace Office { * For more information about working with fields in Project, see * {@link https://support.office.com/article/Available-fields-reference-615a4563-1cc3-40f4-b66f-1b17e793a460 | Available fields} reference. In * Project Help, search for Available fields. - * - * **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)
Project Y
*/ enum ProjectResourceFields { /** @@ -7287,20 +6084,6 @@ declare namespace Office { * For more information about working with fields in Project, see the * {@link https://support.office.com/article/Available-fields-reference-615a4563-1cc3-40f4-b66f-1b17e793a460 | Available fields} reference. * In Project Help, search for Available fields. - * - * **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)
Project Y
*/ enum ProjectTaskFields { /** @@ -8449,20 +7232,6 @@ declare namespace Office { * @remarks * The {@link Office.Document | Document}.getSelectedViewAsync method returns the ProjectViewTypes constant value and name that corresponds to the * active view. - * - * **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)
Project Y
*/ enum ProjectViewTypes { /** diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 1b779997e5..1a8aa1ed08 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/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 - *
HostsAccess, 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,31 +477,17 @@ declare namespace Office { * The current context exists as a property of Office. It is accessed using `Office.context`. * * @remarks - *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
+ * **Hosts:** Access, Excel, Outlook, PowerPoint, Project, Word */ interface Context { /** * 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; /** @@ -692,25 +498,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; /** @@ -731,48 +518,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; /** @@ -797,10 +546,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; /** @@ -824,10 +572,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; /** @@ -837,22 +584,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; /** @@ -865,26 +596,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 { /** @@ -906,31 +618,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 typeContent, 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; /** @@ -947,27 +647,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, @@ -1000,10 +685,10 @@ declare namespace Office { * Displays a dialog to show or collect information from the user or to facilitate Web navigation. * * @remarks - * - * - * - *
HostsWord, Excel, Outlook, PowerPoint
Requirement setsDialogApi, Mailbox 1.4
+ * **Hosts:** Word, Excel, Outlook, PowerPoint + * **Requirement sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets | 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 @@ -1101,10 +786,10 @@ declare namespace Office { * Displays a dialog to show or collect information from the user or to facilitate Web navigation. * * @remarks - * - * - * - *
HostsWord, Excel, Outlook, PowerPoint
Requirement setsDialogApi, Mailbox 1.4
+ * **Hosts:** >Word, Excel, Outlook, PowerPoint + * **Requirement sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets | 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 @@ -1199,6 +884,10 @@ declare namespace Office { displayDialogAsync(startAddress: string, callback?: (result: AsyncResult) => void): void; /** * Delivers a message from the dialog box to its parent/opener page. The page calling this API must be on the same domain as the parent. + * + * @remarks + * **Requirement sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi} + * * @param message Accepts a message from the dialog to deliver to the add-in. In addition to a boolean, anything that can serialized to a string including JSON and XML can be sent. */ messageParent(message: boolean | string): void; @@ -1206,7 +895,8 @@ declare namespace Office { * Closes the UI container where the JavaScript is executing. * * @remarks - *
HostsExcel, Word, PowerPoint, Outlook (Minimum requirement set: Mailbox 1.5)
+ * **Hosts:** Excel, Word, PowerPoint, Outlook (Minimum requirement set: Mailbox 1.5) + * **Requirement sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi} * * The behavior of this method is specified by the following: * @@ -1263,6 +953,7 @@ declare namespace Office { */ asyncContext?: any } + /** * Provides an option for preserving context data of any type, unchanged, for use in a callback. */ @@ -1600,24 +1291,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 { /** @@ -1639,6 +1312,9 @@ declare namespace Office { } /** * The object that is returned when `UI.displayDialogAsync` is called. It exposes methods for registering event handlers and closing the dialog. + * + * @remarks + * **Requirement Set:** [DialogApi](/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets) */ interface Dialog { /** @@ -1667,43 +1343,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 { /** @@ -1717,23 +1361,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 { /** @@ -1754,28 +1381,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 { /** @@ -1832,23 +1441,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 { /** @@ -1862,23 +1454,6 @@ declare namespace Office { } /** * Specifies the type of the XML node. - * - * @remarks - *
Requirement SetsCustomXmlParts
- * - * **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
*/ enum CustomXMLNodeType { /** @@ -1916,45 +1491,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 hostsAccess, 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, /** @@ -1975,47 +1519,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, /** @@ -2028,21 +1537,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, /** @@ -2095,23 +1589,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, /** @@ -2127,23 +1604,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 { /** @@ -2161,24 +1622,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 { /** @@ -2192,24 +1635,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 { /** @@ -2240,22 +1665,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 { /** @@ -2277,24 +1686,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, @@ -2314,22 +1705,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 { /** @@ -2345,9 +1720,6 @@ declare namespace Office { /** * Represents a binding to a section of the document. * - * @remarks - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
- * * The Binding object exposes the functionality possessed by all bindings regardless of type. * * The Binding object is never called directly. It is the abstract parent class of the objects that represent each type of binding: @@ -2355,26 +1727,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. */ @@ -2392,6 +1746,9 @@ declare namespace Office { * `Office.EventType.BindingDataChanged` and `Office.EventType.BindingSelectionChanged`. * * @remarks + * + * **Requirement Set:** [BindingEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#bindingevents) + * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * * @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`. @@ -2405,6 +1762,9 @@ declare namespace Office { * `Office.EventType.BindingDataChanged` and `Office.EventType.BindingSelectionChanged`. * * @remarks + * + * **Requirement Set:** [BindingEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#bindingevents) + * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * * @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`. @@ -2416,7 +1776,15 @@ declare namespace Office { * Returns the data contained within the binding. * * @remarks - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * 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). @@ -2431,8 +1799,16 @@ declare namespace Office { * Returns the data contained within the binding. * * @remarks - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
- * + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * 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). * @@ -2445,8 +1821,9 @@ declare namespace Office { * Removes the specified handler from the binding for the specified event type. * * @remarks - *
Requirement SetsBindingEvents
- * + * + * **Requirement Set:** [BindingEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -2456,8 +1833,9 @@ declare namespace Office { * Removes the specified handler from the binding for the specified event type. * * @remarks - *
Requirement SetsBindingEvents
- * + * + * **Requirement Set:** [BindingEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. */ @@ -2466,9 +1844,16 @@ declare namespace Office { * Writes data to the bound section of the document represented by the specified binding object. * * @remarks + * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * - *
Requirement SetsMatrixBindings, 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. * @@ -2597,8 +1982,14 @@ declare namespace Office { * Writes data to the bound section of the document represented by the specified binding object. * * @remarks - * - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * 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. @@ -2728,7 +2119,7 @@ declare namespace Office { * Provides information about the binding that raised the DataChanged event. * * @remarks - *
HostsAccess, Excel, Word
+ * **Hosts:** Access, Excel, Word */ interface BindingDataChangedEventArgs { /** @@ -2746,7 +2137,7 @@ declare namespace Office { * Provides information about the binding that raised the SelectionChanged event. * * @remarks - *
HostsAccess, Excel, Word
+ * **Hosts:** Access, Excel, Word */ interface BindingSelectionChangedEventArgs { /** @@ -2805,31 +2196,16 @@ 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 SetsMatrixBindings, TableBindings, TextBindings
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * For Excel, the itemName parameter can refer to a named range or a table. * @@ -2849,21 +2225,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. @@ -2875,7 +2236,9 @@ declare namespace Office { * Creates a binding against a named object in the document. * * @remarks - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * For Excel, the itemName parameter can refer to a named range or a table. * @@ -2895,21 +2258,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}. @@ -2920,25 +2268,10 @@ declare namespace Office { * Create a binding by prompting the user to make a selection on the document. * * @remarks - *
Requirement SetsNot in a set
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | 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. @@ -2951,25 +2284,10 @@ declare namespace Office { * Create a binding by prompting the user to make a selection on the document. * * @remarks - *
Requirement SetsNot in a set
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | 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. @@ -2981,7 +2299,10 @@ declare namespace Office { * Create a binding based on the user's current selection. * * @remarks - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id. * @@ -2989,22 +2310,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. @@ -3017,7 +2322,10 @@ declare namespace Office { * Create a binding based on the user's current selection. * * @remarks - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id. * @@ -3025,22 +2333,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. @@ -3052,23 +2344,10 @@ declare namespace Office { * Gets all bindings that were previously created. * * @remarks - *
Requirement SetsMatrixBindings, 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:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | TextBindings} * * @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}. @@ -3079,23 +2358,10 @@ declare namespace Office { * Gets all bindings that were previously created. * * @remarks - *
Requirement SetsMatrixBindings, 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:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | 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. @@ -3105,25 +2371,12 @@ declare namespace Office { * Retrieves a binding based on its Name * * @remarks - *
Requirement SetsCustomXmlParts, MatrixBindings, TableBindings, TextBindings
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | 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. @@ -3135,25 +2388,12 @@ declare namespace Office { * Retrieves a binding based on its Name * * @remarks - *
Requirement SetsCustomXmlParts, MatrixBindings, TableBindings, TextBindings
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | 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}. @@ -3164,25 +2404,12 @@ declare namespace Office { * Removes the binding from the document * * @remarks - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | 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. @@ -3193,25 +2420,12 @@ declare namespace Office { * Removes the binding from the document * * @remarks - *
Requirement SetsMatrixBindings, TableBindings, TextBindings
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixbindings | MatrixBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablebindings | TableBindings}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textbindings | 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}. @@ -3220,51 +2434,25 @@ declare namespace Office { } /** * Represents an XML node in a tree in a document. - * - * @remarks - *
Requirement SetsCustomXmlParts
- * - * **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 CustomXmlNode { /** * Gets the base name of the node without the namespace prefix, if one exists. - * - * @remarks - *
Requirement SetsCustomXmlParts
*/ baseName: string; /** * Retrieves the string GUID of the CustomXMLPart. - * - * @remarks - *
Requirement SetsCustomXmlParts
*/ namespaceUri: string; /** * Gets the type of the CustomXMLNode. - * - * @remarks - *
Requirement SetsCustomXmlParts
*/ nodeType: string; /** * Gets the nodes associated with the XPath expression. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -3276,7 +2464,7 @@ declare namespace Office { * Gets the nodes associated with the XPath expression. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3287,7 +2475,7 @@ declare namespace Office { * Gets the node value. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3298,7 +2486,7 @@ declare namespace Office { * Gets the node value. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -3308,7 +2496,7 @@ declare namespace Office { * Gets the text of an XML node in a custom XML part. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3319,7 +2507,7 @@ declare namespace Office { * Gets the text of an XML node in a custom XML part. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -3329,7 +2517,7 @@ declare namespace Office { * Gets the node's XML. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3340,7 +2528,7 @@ declare namespace Office { * Gets the node's XML. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -3350,7 +2538,7 @@ declare namespace Office { * Sets the node value. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -3361,7 +2549,7 @@ declare namespace Office { * Sets the node value. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3371,10 +2559,7 @@ declare namespace Office { * Asynchronously sets the text of an XML node in a custom XML part. * * @remarks - * - * - * - *
HostsWord
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -3385,10 +2570,7 @@ declare namespace Office { * Asynchronously sets the text of an XML node in a custom XML part. * * @remarks - * - * - * - *
HostsWord
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3398,7 +2580,7 @@ declare namespace Office { * Sets the node XML. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -3409,7 +2591,7 @@ declare namespace Office { * Sets the node XML. * * @remarks - *
Requirement SetsCustomXmlParts
+ * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3418,23 +2600,6 @@ declare namespace Office { } /** * Represents a single CustomXMLPart in an {@link Office.CustomXmlParts} collection. - * - * @remarks - *
Requirement SetsCustomXmlParts
- * - * **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 CustomXmlPart { /** @@ -3453,6 +2618,7 @@ declare namespace Office { * Adds an event handler to the object using the specified event type. * * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -3468,6 +2634,7 @@ declare namespace Office { * Adds an event handler to the object using the specified event type. * * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -3480,6 +2647,9 @@ declare namespace Office { addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, callback?: (result: AsyncResult) => void): void; /** * Deletes the Custom XML Part. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3487,12 +2657,18 @@ declare namespace Office { deleteAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Deletes the Custom XML Part. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ deleteAsync(callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param xPath An XPath expression that specifies the nodes you want returned. Required. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -3502,6 +2678,9 @@ declare namespace Office { getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param xPath An XPath expression that specifies the nodes you want returned. Required. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -3510,6 +2689,9 @@ declare namespace Office { getNodesAsync(xPath: string, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the XML inside this custom XML part. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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}. @@ -3518,6 +2700,9 @@ declare namespace Office { getXmlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the XML inside this custom XML part. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-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 CustomXmlPart object. @@ -3525,6 +2710,9 @@ declare namespace Office { getXmlAsync(callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for the specified event type. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as * `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`. @@ -3535,6 +2723,9 @@ declare namespace Office { removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, options?: RemoveHandlerOptions, callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for the specified event type. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as * `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`. @@ -3546,22 +2737,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 { /** @@ -3583,22 +2758,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 { /** @@ -3615,21 +2774,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 { /** @@ -3653,27 +2797,13 @@ declare namespace Office { /** * Represents a collection of CustomXmlPart objects. - * - * @remarks - *
Requirement SetsCustomXmlParts
- * - * **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
*/ interface CustomXmlParts { /** * Asynchronously adds a new custom XML part to a file. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param xml The XML to add to the newly created custom XML part. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -3683,6 +2813,9 @@ declare namespace Office { addAsync(xml: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously adds a new custom XML part to a file. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param xml The XML to add to the newly created custom XML part. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -3691,6 +2824,9 @@ declare namespace Office { addAsync(xml: string, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part by its id. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param id The GUID of the custom XML part, including opening and closing braces. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -3701,6 +2837,9 @@ declare namespace Office { getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part by its id. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param id The GUID of the custom XML part, including opening and closing braces. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -3710,6 +2849,9 @@ declare namespace Office { getByIdAsync(id: string, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part(s) by its namespace. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param ns The namespace URI. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -3719,6 +2861,9 @@ declare namespace Office { getByNamespaceAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part(s) by its namespace. + * + * @remarks + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) * * @param ns The namespace URI. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -3728,30 +2873,15 @@ declare namespace Office { } /** * Represents a collection of CustomXmlPart objects. - * - * @remarks - * - *
Requirement SetsCustomXmlParts
- * - * **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 CustomXmlPrefixMappings { /** * Asynchronously adds a prefix to namespace mapping to use when querying an item. * * @remarks + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If no namespace is assigned to the requested prefix, the method returns an empty string (""). * * @param prefix Specifies the prefix to add to the prefix mapping list. Required. @@ -3764,6 +2894,9 @@ declare namespace Office { * Asynchronously adds a prefix to namespace mapping to use when querying an item. * * @remarks + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If no namespace is assigned to the requested prefix, the method returns an empty string (""). * * @param prefix Specifies the prefix to add to the prefix mapping list. Required. @@ -3775,7 +2908,9 @@ declare namespace Office { * Asynchronously gets the namespace mapped to the specified prefix. * * @remarks - * + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one * added or used by the data store internally, in which case it will return an error. * @@ -3789,7 +2924,9 @@ declare namespace Office { * Asynchronously gets the namespace mapped to the specified prefix. * * @remarks - * + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one * added or used by the data store internally, in which case it will return an error. * @@ -3802,7 +2939,9 @@ declare namespace Office { * Asynchronously gets the prefix for the specified namespace. * * @remarks - * + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in * the namespace manager, the method returns the first prefix that matches the supplied namespace. * @@ -3816,7 +2955,9 @@ declare namespace Office { * Asynchronously gets the prefix for the specified namespace. * * @remarks - * + * + * **Requirement Sets:** [CustomXmlParts](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#customxmlparts) + * * If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in * the namespace manager, the method returns the first prefix that matches the supplied namespace. * @@ -3830,7 +2971,7 @@ declare namespace Office { * An abstract class that represents the document the add-in is interacting with. * * @remarks - *
HostsAccess, Excel, PowerPoint, Project, Word
+ * **Hosts:** Access, Excel, PowerPoint, Project, Word */ interface Document { /** @@ -3839,139 +2980,31 @@ declare namespace Office { * @remarks * You don't instantiate the Document object directly in your script. To call members of the Document object to interact with the current * document or worksheet, use `Office.context.document` in your script. - * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ bindings: Bindings; /** * Gets an object that represents the custom XML parts in the document. - * - * @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
Word Y Y Y Y
*/ customXmlParts: CustomXmlParts; /** * Gets the mode the document is in. - * - * @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
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ mode: DocumentMode; /** * Gets an object that represents the saved custom settings of the content or task pane add-in for the current document. - * - * @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
OneNote Y
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ settings: Settings; /** * Gets the URL of the document that the host application currently has open. Returns null if the URL is unavailable. - * - * @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
Access Y
Excel Y Y Y
PowerPoint Y
Word Y Y Y
*/ url: string; /** * Adds an event handler for a Document object event. * * @remarks - *
Requirement SetsDocumentEvents
+ * **Requirement Sets:** [DocumentEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. - * - * **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
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
* * @param eventType For a Document object event, the eventType parameter can be specified as `Office.EventType.Document.SelectionChanged` or * `Office.EventType.Document.ActiveViewChanged`, or the corresponding text value of this enumeration. @@ -3984,27 +3017,9 @@ declare namespace Office { * Adds an event handler for a Document object event. * * @remarks - *
Requirement SetsDocumentEvents
+ * **Requirement Sets:** [DocumentEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. - * - * **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
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
* * @param eventType For a Document object event, the eventType parameter can be specified as `Office.EventType.Document.SelectionChanged` or * `Office.EventType.Document.ActiveViewChanged`, or the corresponding text value of this enumeration. @@ -4016,23 +3031,9 @@ declare namespace Office { * Returns the state of the current view of the presentation (edit or read). * * @remarks - *
Requirement SetsActiveView
+ * **Requirement Sets:** [ActiveView](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#activeview) * * Can trigger an event when the view changes. - * - * **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
PowerPoint Y Y Y Y
* * @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}. @@ -4045,23 +3046,9 @@ declare namespace Office { * Returns the state of the current view of the presentation (edit or read). * * @remarks - *
Requirement SetsActiveView
+ * **Requirement Sets:** [ActiveView](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#activeview) * * Can trigger an event when the view changes. - * - * **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
PowerPoint Y Y Y Y
* * @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 the state of the presentation's current view. @@ -4074,7 +3061,10 @@ declare namespace Office { * Note that specifying file slice size of above permitted limit will result in an "Internal Error" failure. * * @remarks - *
Requirement SetsFile
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#compressedfile | CompressedFile} (when using `Office.FileType.Compressed`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#file | File}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`) * * 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 @@ -4090,22 +3080,6 @@ declare namespace Office { * PowerPoint for Windows desktop, Mac, iPad, and PowerPoint Online: `Office.FileType.Compressed`, `Office.FileType.Pdf` * * Word for Windows desktop, Mac, iPad, and Word Online: `Office.FileType.Compressed`, `Office.FileType.Pdf`, `Office.FileType.Text` - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y Y
* * @param fileType The format in which the file will be returned * @param options Provides options for setting the size of slices that the document will be divided into. @@ -4118,8 +3092,10 @@ declare namespace Office { * Note that specifying file slice size of above permitted limit will result in an "Internal Error" failure. * * @remarks - *
Requirement SetsFile
- * + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#compressedfile | CompressedFile} (when using `Office.FileType.Compressed`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#file | File}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`) + * * 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 * 65536 (64 KB). @@ -4134,22 +3110,6 @@ declare namespace Office { * PowerPoint for Windows desktop, Mac, iPad, and PowerPoint Online: `Office.FileType.Compressed`, `Office.FileType.Pdf` * * Word for Windows desktop, Mac, iPad, and Word Online: `Office.FileType.Compressed`, `Office.FileType.Pdf`, `Office.FileType.Text` - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y Y
* * @param fileType The format in which the file will be returned * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -4160,25 +3120,9 @@ declare namespace Office { * Gets file properties of the current document. * * @remarks - *
Requirement SetsNot in a set
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * You get the file's URL with the url property `asyncResult.value.url`. - * - * **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
Excel Y Y Y Y
PowerPoint 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}. @@ -4189,25 +3133,9 @@ declare namespace Office { * Gets file properties of the current document. * * @remarks - *
Requirement SetsNot in a set
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * You get the file's URL with the url property `asyncResult.value.url`. - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y Y
* * @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 the file's properties (with the URL found at `asyncResult.value.url`). @@ -4217,7 +3145,13 @@ declare namespace Office { * Reads the data contained in the current selection in the document. * * @remarks - *
Requirement SetsSelection
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#selection | Selection}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * 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. @@ -4282,23 +3216,6 @@ declare namespace Office { * * * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
- * * @param coercionType The type of data structure to return. See the remarks section for each host's supported coercion types. * * @param options Provides options for customizing what data is returned and how it is formatted. @@ -4313,7 +3230,13 @@ declare namespace Office { * Reads the data contained in the current selection in the document. * * @remarks - *
Requirement SetsSelection
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#selection | Selection}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * 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. @@ -4378,23 +3301,6 @@ declare namespace Office { * * * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
- * * @param coercionType The type of data structure to return. See the remarks section for each host's supported coercion types. * @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 the data in the current selection. @@ -4406,7 +3312,7 @@ declare namespace Office { * Goes to the specified object or location in the document. * * @remarks - *
Requirement Setsnot in a set
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * PowerPoint doesn't support the goToByIdAsync method in Master Views. * @@ -4420,22 +3326,6 @@ declare namespace Office { * * In Word: `Office.SelectionMode.Selected` selects all content in the binding. Office.SelectionMode.None for text bindings, moves the cursor * to the beginning of the text; for matrix bindings and table bindings, selects the first data cell (not first cell in header row for tables). - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y
* * @param id The identifier of the object or location to go to. * @param goToType The type of the location to go to. @@ -4448,7 +3338,7 @@ declare namespace Office { * Goes to the specified object or location in the document. * * @remarks - *
Requirement Setsnot in a set
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * PowerPoint doesn't support the goToByIdAsync method in Master Views. * @@ -4462,22 +3352,6 @@ declare namespace Office { * * In Word: `Office.SelectionMode.Selected` selects all content in the binding. Office.SelectionMode.None for text bindings, moves the cursor * to the beginning of the text; for matrix bindings and table bindings, selects the first data cell (not first cell in header row for tables). - * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y
* * @param id The identifier of the object or location to go to. * @param goToType The type of the location to go to. @@ -4489,25 +3363,7 @@ declare namespace Office { * Removes an event handler for the specified event type. * * @remarks - *
Requirement SetsDocumentEvents
- * - * **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
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
+ * **Requirement Sets:** [DocumentEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#documentevents) * * @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'. * @param options Provides options to determine which event handler or handlers are removed. @@ -4518,25 +3374,7 @@ declare namespace Office { * Removes an event handler for the specified event type. * * @remarks - *
Requirement SetsDocumentEvents
- * - * **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
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
+ * **Requirement Sets:** [DocumentEvents](/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#documentevents) * * @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -4546,7 +3384,14 @@ declare namespace Office { * Writes the specified data into the current selection. * * @remarks - *
Requirement SetsSelection
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#imagecoercion | ImageCoercion} (when using `Office.CoercionType.Image`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#selection | Selection}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * **Application-specific behaviors** * @@ -4680,22 +3525,6 @@ declare namespace Office { * * * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
* * @param data The data to be set. Either a string or {@link Office.CoercionType} value, 2d array or TableData object. * @@ -4733,7 +3562,14 @@ declare namespace Office { * Writes the specified data into the current selection. * * @remarks - *
Requirement SetsSelection
+ * **Requirement Sets:** + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#imagecoercion | ImageCoercion} (when using `Office.CoercionType.Image`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#selection | Selection}, + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`), + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) * * **Application-specific behaviors** * @@ -4866,22 +3702,6 @@ declare namespace Office { * * * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Project Y
Word Y Y Y Y
* * @param data The data to be set. Either a string or {@link Office.CoercionType} value, 2d array or TableData object. * @@ -4920,22 +3740,6 @@ declare namespace Office { * @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}. * The `value` property of the result contains the `fieldValue` property, which represents the value of the specified field. - * - * @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)
Project Y
*/ getProjectFieldAsync(fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4944,21 +3748,6 @@ declare namespace Office { * @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 contains the `fieldValue` property, which represents the value of the specified field. * - * @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)
Project Y
*/ getProjectFieldAsync(fieldId: number, callback?: (result: AsyncResult) => void): void; /** @@ -4969,21 +3758,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getResourceFieldAsync(resourceId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -4993,21 +3767,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getResourceFieldAsync(resourceId: string, fieldId: number, callback?: (result: AsyncResult) => void): void; /** @@ -5016,21 +3775,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getSelectedResourceAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5038,21 +3782,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getSelectedResourceAsync(callback?: (result: AsyncResult) => void): void; /** @@ -5061,21 +3790,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getSelectedTaskAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5083,21 +3797,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getSelectedTaskAsync(callback?: (result: AsyncResult) => void): void; /** @@ -5108,21 +3807,6 @@ declare namespace Office { * `viewName` - The name of the view, as a ProjectViewTypes constant. * `viewType` - The type of view, as the integer value of a ProjectViewTypes constant. * - * @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)
Project Y
*/ getSelectedViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5132,21 +3816,6 @@ declare namespace Office { * `viewName` - The name of the view, as a ProjectViewTypes constant. * `viewType` - The type of view, as the integer value of a ProjectViewTypes constant. * - * @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)
Project Y
*/ getSelectedViewAsync(callback?: (result: AsyncResult) => void): void; /** @@ -5159,21 +3828,6 @@ declare namespace Office { * `wssTaskId` - The ID of the task in the synchronized SharePoint task list. If the project is not synchronized with a SharePoint task list, the value is 0. * `resourceNames` - The comma-separated list of the names of resources that are assigned to the task. * - * @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)
Project Y
*/ getTaskAsync(taskId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5185,21 +3839,6 @@ declare namespace Office { * `wssTaskId` - The ID of the task in the synchronized SharePoint task list. If the project is not synchronized with a SharePoint task list, the value is 0. * `resourceNames` - The comma-separated list of the names of resources that are assigned to the task. * - * @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)
Project Y
*/ getTaskAsync(taskId: string, callback?: (result: AsyncResult) => void): void; /** @@ -5210,21 +3849,6 @@ declare namespace Office { * @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 contains the `fieldValue` property, which represents the value of the specified field. * - * @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)
Project Y
*/ getTaskFieldAsync(taskId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5234,21 +3858,6 @@ declare namespace Office { * @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 contains the `fieldValue` property, which represents the value of the specified field. * - * @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)
Project Y
*/ getTaskFieldAsync(taskId: string, fieldId: number, callback?: (result: AsyncResult) => void): void; /** @@ -5259,21 +3868,6 @@ declare namespace Office { * `listName` - the name of the synchronized SharePoint task list. * `serverUrl` - the URL of the synchronized SharePoint task list. * - * @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)
Project Y
*/ getWSSUrlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5283,21 +3877,6 @@ declare namespace Office { * `listName` - the name of the synchronized SharePoint task list. * `serverUrl` - the URL of the synchronized SharePoint task list. * - * @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)
Project Y
*/ getWSSUrlAsync(callback?: (result: AsyncResult) => void): void; /** @@ -5309,21 +3888,6 @@ declare namespace Office { * @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 the highest index number in the current project's resource collection. * - * @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)
Project Y
*/ getMaxResourceIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5334,21 +3898,6 @@ declare namespace Office { * @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 the highest index number in the current project's resource collection. * - * @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)
Project Y
*/ getMaxResourceIndexAsync(callback?: (result: AsyncResult) => void): void; /** @@ -5360,21 +3909,6 @@ declare namespace Office { * @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 the highest index number in the current project's task collection. * - * @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)
Project Y
*/ getMaxTaskIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5385,21 +3919,6 @@ declare namespace Office { * @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 the highest index number in the current project's task collection. * - * @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)
Project Y
*/ getMaxTaskIndexAsync(callback?: (result: AsyncResult) => void): void; /** @@ -5412,21 +3931,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getResourceByIndexAsync(resourceIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5438,21 +3942,6 @@ declare namespace Office { * @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 the GUID of the resource as a string. * - * @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)
Project Y
*/ getResourceByIndexAsync(resourceIndex: number, callback?: (result: AsyncResult) => void): void; /** @@ -5465,21 +3954,6 @@ declare namespace Office { * @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 the GUID of the task as a string. * - * @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)
Project Y
*/ getTaskByIndexAsync(taskIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5491,21 +3965,6 @@ declare namespace Office { * @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 the GUID of the task as a string. * - * @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)
Project Y
*/ getTaskByIndexAsync(taskIndex: number, callback?: (result: AsyncResult) => void): void; /** @@ -5519,21 +3978,6 @@ declare namespace Office { * @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}. * - * @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)
Project Y
*/ setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5546,21 +3990,6 @@ declare namespace Office { * @param fieldValue Value of the target field. * @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)
Project Y
*/ setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult) => void): void; /** @@ -5574,21 +4003,6 @@ declare namespace Office { * @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}. * - * @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)
Project Y
*/ setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5601,21 +4015,6 @@ declare namespace Office { * @param fieldValue Value of the target field. * @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)
Project Y
*/ setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult) => void): void; } @@ -5638,28 +4037,10 @@ declare namespace Office { * @remarks * Access the File object with the AsyncResult.value property in the callback function passed to the Document.getFileAsync method. * - * **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
Excel Y Y Y Y
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ interface File { /** * Gets the document file size in bytes. - * - * @remarks - *
Requirement SetsFile
*/ size: number; /** @@ -5671,7 +4052,7 @@ declare namespace Office { * * @remarks * - *
Requirement SetsFile
+ * **Requirement Sets:** [File](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -5709,7 +4090,7 @@ declare namespace Office { * Returns the specified slice. * * @remarks - *
Requirement SetsFile
+ * **Requirement Sets:** [File](/office/dev/add-ins/reference/requirement-sets/office-add-in-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. @@ -5753,44 +4134,16 @@ declare namespace Office { * Represents a binding in two dimensions of rows and columns. * * @remarks - *
Requirement SetsMatrixBindings
- * * The MatrixBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Binding 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 Office for Mac
Excel Y Y Y Y
Word Y Y Y Y
*/ interface MatrixBinding extends Binding { /** * Gets the number of columns in the matrix data structure, as an integer value. - * - * @remarks - * - * - * - *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsMatrixBindings
*/ columnCount: number; /** * Gets the number of rows in the matrix data structure, as an integer value. - * - * @remarks - * - * - * - *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsMatrixBindings
*/ rowCount: number; } @@ -5798,10 +4151,6 @@ declare namespace Office { * Represents custom settings for a task pane or content add-in that are stored in the host document as name/value pairs. * * @remarks - * - * - * - *
HostsAccess, Excel, PowerPoint, Word
Requirement SetsSettings
* * The settings created by using the methods of the Settings object are saved per add-in and per document. * That is, they are available only to the add-in that created them, and only from the document in which they are saved. @@ -5822,9 +4171,6 @@ declare namespace Office { * spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. * * @remarks - * - *
Requirement SetsSettings
- * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * * @param eventType Specifies the type of event to add. Required. @@ -5854,21 +4200,6 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
*/ addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** @@ -5879,8 +4210,6 @@ declare namespace Office { * spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. * * @remarks - * - *
Requirement SetsSettings
* * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -5910,45 +4239,13 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
*/ addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void; /** * Retrieves the specified setting. * * @remarks - *
Requirement SetsSettings
- * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} * * @param settingName The case-sensitive name of the setting to retrieve. * @returns An object that has property names mapped to JSON serialized values. @@ -5958,8 +4255,7 @@ declare namespace Office { * Reads all settings persisted in the document and refreshes the content or task pane add-in's copy of those settings held in memory. * * @remarks - * - *
Requirement SetsSettings
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | 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 @@ -5992,23 +4288,6 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
PowerPoint Y Y
Word Y Y
* * @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 an {@link Office.Settings} object with the refreshed values. @@ -6022,27 +4301,10 @@ declare namespace Office { * call the Settings.saveAsync method. * * @remarks - *
Requirement SetsSettings
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} * * null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag. * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
- * * @param settingName The case-sensitive name of the setting to remove. */ remove(name: string): void; @@ -6050,8 +4312,6 @@ declare namespace Office { * Removes an event handler for the settingsChanged event. * * @remarks - * - *
Requirement SetsSettings
* * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType * will be removed. @@ -6061,21 +4321,6 @@ declare namespace Office { * * In the callback function passed to the removeHandlerAsync method, you can use the properties of the AsyncResult object to return the * following information. - * - * **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
* * @param eventType Specifies the type of event to remove. Required. * @param options Provides options to determine which event handler or handlers are removed. @@ -6086,8 +4331,6 @@ declare namespace Office { * Removes an event handler for the settingsChanged event. * * @remarks - * - *
Requirement SetsSettings
* * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType * will be removed. @@ -6097,21 +4340,6 @@ declare namespace Office { * * In the callback function passed to the removeHandlerAsync method, you can use the properties of the AsyncResult object to return the * following information. - * - * **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
* * @param eventType Specifies the type of event to remove. Required. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -6121,6 +4349,8 @@ declare namespace Office { * Persists the in-memory copy of the settings property bag in the document. * * @remarks + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * * Any settings previously saved by an add-in are loaded when it is initialized, so during the lifetime of the session you can just use the * set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are * available the next time the add-in is used, use the saveAsync method. @@ -6153,23 +4383,6 @@ declare namespace Office { * * * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
- * * @param options Provides options for saving settings. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ @@ -6178,6 +4391,8 @@ declare namespace Office { * Persists the in-memory copy of the settings property bag in the document. * * @remarks + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * * Any settings previously saved by an add-in are loaded when it is initialized, so during the lifetime of the session you can just use the * set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are * available the next time the add-in is used, use the saveAsync method. @@ -6210,23 +4425,6 @@ declare namespace Office { * * * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
- * * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ saveAsync(callback?: (result: AsyncResult) => void): void; @@ -6239,29 +4437,12 @@ declare namespace Office { * the document. * * @remarks - *
Requirement SetsSettings
+ * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | 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 * the serialized JSON representation of its data type. A maximum of 2MB is available for the settings of each add-in. * - * **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
PowerPoint Y Y Y Y
Word Y Y Y Y
- * * @param settingName The case-sensitive name of the setting to set or create. * @param value Specifies the value to be stored. */ @@ -6270,9 +4451,6 @@ declare namespace Office { /** * Provides information about the settings that raised the settingsChanged event. * - * @remarks - *
Requirement SetsSettings
- * * To add an event handler for the settingsChanged event, use the addHandlerAsync method of the * {@link Office.Settings} object. * @@ -6287,21 +4465,6 @@ declare namespace Office { * is running with any Excel client, but the event will fire only when the add-in is loaded with a spreadsheet * that is opened in Excel Online, and more than one user is editing the spreadsheet (co-authoring). * Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. - * - * **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
Excel Y
Word Y Y
*/ interface SettingsChangedEventArgs { /** @@ -6314,27 +4477,7 @@ declare namespace Office { type: EventType; } /** - * Represents a slice of a document file. - * - * @remarks - *
Requirement SetsFile
- * - * The Slice object is accessed with the File.getSliceAsync method. - * - * **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
PowerPoint Y Y Y
Word Y Y Y
+ * Represents a slice of a document file. The Slice object is accessed with the `File.getSliceAsync` method. */ interface Slice { /** @@ -6359,7 +4502,6 @@ declare namespace Office { * Represents a binding in two dimensions of rows and columns, optionally with headers. * * @remarks - *
Requirement SetsTableBindings
* * The TableBinding object inherits the `id` property, `type` property, `getDataAsync` method, and `setDataAsync` method from the * {@link Office.Binding} object. @@ -6370,46 +4512,10 @@ declare namespace Office { interface TableBinding extends Binding { /** * Gets the number of columns in the TableBinding, as an integer value. - * - * @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
*/ columnCount: number; /** * True, if the table has headers; otherwise false. - * - * @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
*/ hasHeaders: boolean; /** @@ -6429,22 +4535,6 @@ declare namespace Office { * strings. * * In content add-ins for Access, for performance reasons the rowCount property always returns -1. - * - * **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
*/ rowCount: number; /** @@ -6468,22 +4558,6 @@ declare namespace Office { * * Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in * a single call to this method. - * - * **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 tableData An array of arrays ("matrix") or a TableData object that contains one or more columns of data to add to the table. Required. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -6511,22 +4585,6 @@ declare namespace Office { * * Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in * a single call to this method. - * - * **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 tableData An array of arrays ("matrix") or a TableData object that contains one or more columns of data to add to the table. Required. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -6550,22 +4608,6 @@ declare namespace Office { * * Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in * a single call to this method. - * - * **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 rows An array of arrays ("matrix") or a TableData object that contains one or more rows of data to add to the table. Required. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -6590,22 +4632,6 @@ declare namespace Office { * * Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in * a single call to this method. - * - * **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 rows An array of arrays ("matrix") or a TableData object that contains one or more rows of data to add to the table. Required. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -6617,22 +4643,6 @@ declare namespace Office { * @remarks * * In Excel, if the table has no header row, this method will delete the table itself. - * - * **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 Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -6644,22 +4654,6 @@ declare namespace Office { * @remarks * * In Excel, if the table has no header row, this method will delete the table itself. - * - * **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 callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ @@ -6669,20 +4663,6 @@ declare namespace Office { * * @remarks * See {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | Format tables in add-ins for Excel} for more information. - * - * **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
Excel Y Y Y Y
* * @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}. @@ -6693,20 +4673,6 @@ declare namespace Office { * * @remarks * See {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | Format tables in add-ins for Excel} for more information. - * - * **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
Excel Y Y Y Y
* * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. */ @@ -6911,20 +4877,6 @@ declare namespace Office { * * For more details and examples, see * {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | How to format tables in add-ins for Excel}. - * - * **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
Excel Y Y Y Y
* * @param cellFormat An array that contains one or more JavaScript objects that specify which cells to target and the formatting to apply to them. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -7024,20 +4976,6 @@ declare namespace Office { * * For more details and examples, see * {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | How to format tables in add-ins for Excel}. - * - * **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
Excel Y Y Y Y
* * @param cellFormat An array that contains one or more JavaScript objects that specify which cells to target and the formatting to apply to them. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -7047,10 +4985,8 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * - * - * - *
HostsExcel
Requirement SetsNot in a set
+ * **Hosts:** Excel + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information. * @@ -7076,20 +5012,6 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
Excel Y Y Y Y
* * @param tableOptions An object literal containing a list of property name-value pairs that define the table options to apply. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -7101,10 +5023,8 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * - * - * - *
HostsExcel
Requirement SetsNot in a set
+ * **Hosts:** Excel + * **Requirement Sets:** {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information. * @@ -7130,20 +5050,6 @@ declare namespace Office { * A user-defined item of any type that is returned in the AsyncResult object without being altered. * * - * - * **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
Excel Y Y Y Y
* * @param tableOptions An object literal containing a list of property name-value pairs that define the table options to apply. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. @@ -7153,12 +5059,6 @@ declare namespace Office { } /** * Represents the data in a table or an {@link Office.TableBinding}. - * - * @remarks - * - * - * - *
HostsExcel, Word
Requirement SetsTableBindings
*/ class TableData { constructor(rows: any[][], headers: any[]); @@ -7167,10 +5067,6 @@ declare namespace Office { * Gets or sets the headers of the table. * * @remarks - * - * - * - *
HostsExcel, Word
Requirement SetsTableBindings
* * To specify headers, you must specify an array of arrays that corresponds to the structure of the table. For example, to specify headers * for a two-column table you would set the header property to [['header1', 'header2']]. @@ -7188,10 +5084,6 @@ declare namespace Office { * Returns an empty array if there are no rows. * * @remarks - * - * - * - *
HostsExcel, Word
Requirement SetsTableBindings
* * To specify rows, you must specify an array of arrays that corresponds to the structure of the table. For example, to specify two rows of * string values in a two-column table you would set the rows property to [['a', 'b'], ['c', 'd']]. @@ -7208,22 +5100,6 @@ declare namespace Office { /** * Specifies enumerated values for the `cells` property in the cellFormat parameter of * {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | table formatting methods}. - * - * @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
Excel Y Y Y Y
*/ enum Table { /** @@ -7241,27 +5117,9 @@ declare namespace Office { } /** * Represents a bound text selection in the document. - * - * @remarks - *
Requirement SetsTextBindings
- * + * * 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. - * - * **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
Excel Y Y Y Y
Word Y Y Y Y
*/ interface TextBinding extends Binding { } /** @@ -7270,20 +5128,6 @@ declare namespace Office { * @remarks * * A ProjectProjectFields constant can be used as a parameter of the {@link Office.Document | Document}.getProjectFieldAsync method. - * - * **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)
Project Y
*/ enum ProjectProjectFields { /** @@ -7346,20 +5190,6 @@ declare namespace Office { * For more information about working with fields in Project, see * {@link https://support.office.com/article/Available-fields-reference-615a4563-1cc3-40f4-b66f-1b17e793a460 | Available fields} reference. In * Project Help, search for Available fields. - * - * **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)
Project Y
*/ enum ProjectResourceFields { /** @@ -8173,20 +6003,6 @@ declare namespace Office { * For more information about working with fields in Project, see the * {@link https://support.office.com/article/Available-fields-reference-615a4563-1cc3-40f4-b66f-1b17e793a460 | Available fields} reference. * In Project Help, search for Available fields. - * - * **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)
Project Y
*/ enum ProjectTaskFields { /** @@ -9335,20 +7151,6 @@ declare namespace Office { * @remarks * The {@link Office.Document | Document}.getSelectedViewAsync method returns the ProjectViewTypes constant value and name that corresponds to the * active view. - * - * **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)
Project Y
*/ enum ProjectViewTypes { /**