diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index fde6103b7a..f0ea69d755 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -251,7 +251,7 @@ declare namespace Office { * *Note*: The reason parameter of the initialize event listener function only returns an `InitializationReason` enumeration value for task pane and content add-ins. It does not return a value for Outlook add-ins. * * @remarks - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
* * @param reason Indicates how the app was initialized. */ @@ -267,7 +267,7 @@ declare namespace Office { * Toggles on and off the `Office` alias for the full `Microsoft.Office.WebExtension` namespace. * * @remarks - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
* * @param useShortNamespace True to use the shortcut alias; otherwise false to disable it. The default is true. */ @@ -278,7 +278,7 @@ declare namespace Office { * @remarks * Returned by the status property of the AsyncResult object. * - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
*/ enum AsyncResultStatus { /** @@ -294,7 +294,7 @@ declare namespace Office { * Specifies whether the add-in was just inserted or was already contained in the document. * * @remarks - * Hosts: Excel, Project, Word + *
HostsExcel, Project, Word
*/ enum InitializationReason { /** @@ -310,7 +310,7 @@ declare namespace Office { * Specifies the host Office application in which the add-in is running. * * @remarks - * Hosts: Excel, Word, PowerPoint, Outlook, OneNote, Project, Access + *
HostsExcel, Word, PowerPoint, Outlook, OneNote, Project, Access
*/ enum HostType { /** @@ -346,7 +346,7 @@ declare namespace Office { * Specifies the OS or other platform on which the Office host application is running. * * @remarks - * Hosts: Excel, Word, PowerPoint, Outlook, OneNote, Project, Access + *
HostsExcel, Word, PowerPoint, Outlook, OneNote, Project, Access
*/ enum PlatformType { /** @@ -379,7 +379,7 @@ declare namespace Office { * An object which encapsulates the result of an asynchronous request, including status and error information if the request failed. * * @remarks - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
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. */ @@ -388,21 +388,21 @@ 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 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 - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
*/ asyncContext: any; /** * Gets the {@link Office.AsyncResultStatus} of the asynchronous operation. * * @remarks - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
*/ status: AsyncResultStatus; /** * Gets an {@link Office.Error} object that provides a description of the error, if any error occurred. * * @remarks - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
*/ error: Error; /** @@ -413,7 +413,7 @@ 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. For a complete listing of the "Async" methods, see the Remarks section of the AsyncResult object topic. * - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
*/ value: any; } @@ -421,7 +421,7 @@ declare namespace Office { * Represents the runtime environment of the add-in and provides access to key objects of the API. * * @remarks - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
*/ interface Context { /** @@ -523,7 +523,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. * - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
*/ interface Error { /** @@ -547,7 +547,7 @@ declare namespace Office { * * @remarks * - * Hosts: Excel, Outlook, PowerPoint, Word + *
HostsExcel, Outlook, PowerPoint, Word
* * Add-in type: Content, task pane, Outlook * @@ -604,7 +604,7 @@ declare namespace Office { * Displays a dialog to show or collect information from the user or to facilitate Web navigation. * * @remarks - * Hosts: Word, Excel, Outlook, PowerPoint + *
HostsWord, Excel, Outlook, PowerPoint
* * Requirement sets: DialogApi, Mailbox 1.4 * @@ -704,7 +704,7 @@ declare namespace Office { * * - Called from a module extension: No effect. * - * Hosts: Excel, Word, PowerPoint, Outlook (Minimum requirement set: Mailbox 1.5) + *
HostsExcel, Word, PowerPoint, Outlook (Minimum requirement set: Mailbox 1.5)
*/ closeContainer(): void; } @@ -750,7 +750,7 @@ declare namespace Office { * Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Allows add-ins to identify users. Server side code can use this token to access Microsoft Graph for the add-in's web application by using the {@link https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}. * * @remarks - * Hosts: Excel, OneNote, Outlook, PowerPoint, Word + *
HostsExcel, OneNote, Outlook, PowerPoint, Word
* * Requirement sets: IdentityAPI * @@ -1095,7 +1095,7 @@ declare namespace Office { * Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user with File > 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 - * Hosts: Excel, Outlook, Powerpoint, Project, Word + *
HostsExcel, Outlook, Powerpoint, Project, Word
*/ interface OfficeTheme { /** @@ -1145,7 +1145,7 @@ declare namespace Office { /** * Specifies the state of the active view of the document, for example, whether the user can edit the document. * @remarks - * Hosts: PowerPoint + *
HostsPowerPoint
*/ enum ActiveView { /** @@ -1160,7 +1160,7 @@ declare namespace Office { /** * Specifies the type of the binding object that should be returned. * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
*/ enum BindingType { /** @@ -1182,7 +1182,7 @@ declare namespace Office { * @remarks * PowerPoint supports only `Office.CoercionType.Text`, `Office.CoercionType.Image`, and `Office.CoercionType.SlideRange`. Project supports only `Office.CoercionType.Text`. * - * Hosts: Access, Excel, Outlook, PowerPoint, Project, Word + *
HostsAccess, Excel, Outlook, PowerPoint, Project, Word
*/ enum CoercionType { /** @@ -1231,7 +1231,7 @@ declare namespace Office { * @remarks * Returned by the mode property of the Document object. * - * Hosts: Excel, PowerPoint, Project, Word + *
HostsExcel, PowerPoint, Project, Word
*/ enum DocumentMode { /** @@ -1247,9 +1247,9 @@ declare namespace Office { * Specifies the type of the XML node. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ enum CustomXMLNodeType { /** @@ -1287,7 +1287,7 @@ declare namespace Office { * @remarks * Add-ins for Project support the `Office.EventType.ResourceSelectionChanged`, `Office.EventType.TaskSelectionChanged`, and `Office.EventType.ViewSelectionChanged` event types. * - * Hosts: Access, Excel, PowerPoint, Project, Word + *
HostsAccess, Excel, PowerPoint, Project, Word
*/ enum EventType { /** @@ -1298,7 +1298,7 @@ declare namespace Office { * Occurs when data within the binding is changed. * * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
* * 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 BindingDataChangedEventArgs. */ @@ -1307,9 +1307,9 @@ declare namespace Office { * Occurs when the selection is changed within the binding. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: BindingEvents + *
HostsAccess, Excel, Word
Requirement SetsBindingEvents
* * 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 BindingSelectionChangedEventArgs. */ @@ -1367,7 +1367,7 @@ declare namespace Office { * Specifies the format in which to return the document. * * @remarks - * Hosts: PowerPoint, Word + *
HostsPowerPoint, Word
*/ enum FileType { /** @@ -1387,7 +1387,7 @@ declare namespace Office { * Specifies whether filtering from the host application is applied when the data is retrieved. * * @remarks - * Hosts: Excel, Project, Word + *
HostsExcel, Project, Word
*/ enum FilterType { /** @@ -1403,7 +1403,7 @@ declare namespace Office { * Specifies the type of place or object to navigate to. * * @remarks - * Hosts: Excel, PowerPoint, Word + *
HostsExcel, PowerPoint, Word
*/ enum GoToType { /** @@ -1428,7 +1428,7 @@ declare namespace Office { * Specifies whether to select (highlight) the location to navigate to (when using the Document.goToByIdAsync method). * * @remarks - * Hosts: Excel, PowerPoint, Word + *
HostsExcel, PowerPoint, Word
*/ enum SelectionMode { Default, @@ -1447,7 +1447,7 @@ declare namespace Office { * @remarks * 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. * - * Hosts: Excel, Project, Word + *
HostsExcel, Project, Word
*/ enum ValueFormat { /** @@ -1464,9 +1464,9 @@ declare namespace Office { * Represents a binding to a section of the document. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement sets: MatrixBinding, TableBinding, TextBinding + *
HostsAccess, Excel, Word
Requirement SetsMatrixBinding, TableBinding, TextBinding
* * The Binding object exposes the functionality possessed by all bindings regardless of type. * @@ -1479,21 +1479,21 @@ declare namespace Office { * Get the Document object associated with the binding. * * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
*/ document: Document; /** * A string that uniquely identifies this binding among the bindings in the same Document object. * * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
*/ id: string; /** * Gets the type of the binding. * * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
*/ type: BindingType; /** @@ -1512,9 +1512,9 @@ declare namespace Office { * Returns the data contained within the binding. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement sets: MatrixBindings, TableBindings, TextBindings + *
HostsAccess, Excel, Word
Requirement SetsMatrixBindings, TableBindings, TextBindings
* * When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow, startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range). * @@ -1526,9 +1526,9 @@ declare namespace Office { * Removes the specified handler from the binding for the specified event type. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: BindingEvents + *
HostsAccess, Excel, Word
Requirement SetsBindingEvents
* * @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. @@ -1540,9 +1540,9 @@ declare namespace Office { * * @remarks * - * Hosts: Access, Excel, Word + * * - * Available in Requirement sets: MatrixBindings, TableBindings, TextBindings + *
HostsAccess, Excel, Word
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. * @@ -1669,7 +1669,7 @@ declare namespace Office { * Provides information about the binding that raised the DataChanged event. * * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
*/ interface BindingDataChangedEventArgs { /** @@ -1687,7 +1687,7 @@ declare namespace Office { * Provides information about the binding that raised the SelectionChanged event. * * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
*/ interface BindingSelectionChangedEventArgs { /** @@ -1743,16 +1743,16 @@ declare namespace Office { * Gets an {@link Office.Document} object that represents the document associated with this set of bindings. * * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
*/ document: Document; /** * Creates a binding against a named object in the document. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: MatrixBindings, TableBindings, TextBindings + *
HostsAccess, Excel, Word
Requirement SetsMatrixBindings, TableBindings, TextBindings
* * For Excel, the itemName parameter can refer to a named range or a table. * @@ -1776,9 +1776,9 @@ declare namespace Office { * Create a binding by prompting the user to make a selection on the document. * * @remarks - * Hosts: Access, Excel + * * - * Available in Requirement set: Not in a set + *
HostsAccess, Excel
Requirement SetsNot 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. * @@ -1791,9 +1791,9 @@ declare namespace Office { * Create a binding based on the user's current selection. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: MatrixBindings, TableBindings, TextBindings + *
HostsAccess, Excel, Word
Requirement SetsMatrixBindings, TableBindings, TextBindings
* * Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id. * @@ -1808,9 +1808,9 @@ declare namespace Office { * Gets all bindings that were previously created. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: MatrixBindings, TableBindings, TextBindings + *
HostsAccess, Excel, Word
Requirement SetsMatrixBindings, TableBindings, 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 AsyncResult. @@ -1820,9 +1820,9 @@ declare namespace Office { * Retrieves a binding based on its Name * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: CustomXmlParts, MatrixBindings, TableBindings, TextBindings + *
HostsAccess, Excel, Word
Requirement SetsCustomXmlParts, MatrixBindings, TableBindings, TextBindings
* * Fails if the specified id does not exist. * @@ -1835,9 +1835,9 @@ declare namespace Office { * Removes the binding from the document * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: MatrixBindings, TableBindings, TextBindings + *
HostsAccess, Excel, Word
Requirement SetsMatrixBindings, TableBindings, TextBindings
* * Fails if the specified id does not exist. * @@ -1851,45 +1851,45 @@ declare namespace Office { * Represents an XML node in a tree in a document. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ interface CustomXmlNode { /** * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ baseName: string; /** * Retrieves the string GUID of the CustomXMLPart. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ namespaceUri: string; /** * Gets the type of the CustomXMLNode. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ nodeType: string; /** * Gets the nodes associated with the XPath expression. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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. @@ -1900,9 +1900,9 @@ declare namespace Office { * Gets the node value. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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 AsyncResult. @@ -1912,9 +1912,9 @@ declare namespace Office { * Gets the text of an XML node in a custom XML part. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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 AsyncResult. @@ -1924,9 +1924,9 @@ declare namespace Office { * Gets the node's XML. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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 AsyncResult. @@ -1936,9 +1936,9 @@ declare namespace Office { * Sets the node value. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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. @@ -1949,9 +1949,9 @@ declare namespace Office { * Asynchronously sets the text of an XML node in a custom XML part. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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. @@ -1962,9 +1962,9 @@ declare namespace Office { * Sets the node XML. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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. @@ -1976,36 +1976,36 @@ declare namespace Office { * Represents a single CustomXMLPart in an {@link Office.CustomXmlParts} collection. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ interface CustomXmlPart { /** * True, if the custom XML part is built in; otherwise false. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ builtIn: boolean; /** * Gets the GUID of the CustomXMLPart. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ id: string; /** * Gets the set of namespace prefix mappings ({@link Office.CustomXmlPrefixMappings}) used against the current CustomXMLPart. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ namespaceManager: CustomXmlPrefixMappings; @@ -2013,7 +2013,7 @@ declare namespace Office { * Adds an event handler to the object using the specified event type. * * @remarks - * Hosts: Word + *
HostsWord
* * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -2027,9 +2027,9 @@ declare namespace Office { * Deletes the Custom XML Part. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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 AsyncResult. @@ -2039,9 +2039,9 @@ declare namespace Office { * Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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. @@ -2052,9 +2052,9 @@ declare namespace Office { * Asynchronously gets the XML inside this custom XML part. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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 AsyncResult. @@ -2064,9 +2064,9 @@ declare namespace Office { * Removes an event handler for the specified event type. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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`. * @param handler The name of the handler to remove. @@ -2080,7 +2080,7 @@ declare namespace Office { * Provides information about the deleted node that raised the dataNodeDeleted event. * * @remarks - * Hosts: Word + *
HostsWord
*/ interface NodeDeletedEventArgs { /** @@ -2103,7 +2103,7 @@ declare namespace Office { * Provides information about the inserted node that raised the dataNodeInserted event. * * @remarks - * Hosts: Word + *
HostsWord
*/ interface NodeInsertedEventArgs { /** @@ -2144,18 +2144,18 @@ declare namespace Office { * Represents a collection of CustomXmlPart objects. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
*/ interface CustomXmlParts { /** * Asynchronously adds a new custom XML part to a file. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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. @@ -2166,9 +2166,9 @@ declare namespace Office { * Asynchronously gets the specified custom XML part by its id. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @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. @@ -2179,9 +2179,9 @@ declare namespace Office { * Asynchronously gets the specified custom XML part(s) by its namespace. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * @param ns The namespace URI. * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. @@ -2193,16 +2193,16 @@ declare namespace Office { * Represents a collection of CustomXmlPart objects. * * @remarks - * Hosts: Word + *
HostsWord
*/ interface CustomXmlPrefixMappings { /** * Asynchronously adds a prefix to namespace mapping to use when querying an item. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * If no namespace is assigned to the requested prefix, the method returns an empty string (""). * @@ -2216,9 +2216,9 @@ declare namespace Office { * Asynchronously gets the namespace mapped to the specified prefix. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * 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. * @@ -2231,9 +2231,9 @@ declare namespace Office { * Asynchronously gets the prefix for the specified namespace. * * @remarks - * Hosts: Word + * * - * Available in Requirement set: CustomXmlParts + *
HostsWord
Requirement SetsCustomXmlParts
* * 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. * @@ -2247,14 +2247,14 @@ declare namespace Office { * An abstract class that represents the document the add-in is interacting with. * * @remarks - * Hosts: Access, Excel, PowerPoint, Project, Word + *
HostsAccess, Excel, PowerPoint, Project, Word
*/ interface Document { /** * Gets an object that provides access to the bindings defined in the document. * * @remarks - * Hosts: Access, Excel, Word + *
HostsAccess, Excel, Word
* * 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. */ @@ -2263,37 +2263,37 @@ declare namespace Office { * Gets an object that represents the custom XML parts in the document. * * @remarks - * Hosts: Word + *
HostsWord
*/ customXmlParts: CustomXmlParts; /** * Gets the mode the document is in. * * @remarks - * Hosts: Word + *
HostsWord
*/ mode: DocumentMode; /** * Gets an object that represents the saved custom settings of the content or task pane add-in for the current document. * * @remarks - * Hosts: Word + *
HostsWord
*/ settings: Settings; /** * Gets the URL of the document that the host application currently has open. Returns null if the URL is unavailable. * * @remarks - * Hosts: Word + *
HostsWord
*/ url: string; /** * Adds an event handler for a Document object event. * * @remarks - * Hosts: Excel, PowerPoint, Project, Word + * * - * Available in Requirement set: DocumentEvents + *
HostsExcel, PowerPoint, Project, Word
Requirement SetsDocumentEvents
* * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -2307,9 +2307,9 @@ declare namespace Office { * Returns the state of the current view of the presentation (edit or read). * * @remarks - * Hosts: Excel, PowerPoint, Word + * * - * Available in Requirement set: ActiveView + *
HostsExcel, PowerPoint, Word
Requirement SetsActiveView
* * Can trigger an event when the view changes. * @@ -2321,9 +2321,9 @@ declare namespace Office { * Returns the entire document file in slices of up to 4194304 bytes (4 MB). For add-ins for iOS, file slice is supported up to 65536 (64 KB). Note that specifying file slice size of above permitted limit will result in an "Internal Error" failure. * * @remarks - * Hosts: Excel, PowerPoint, Word + * * - * Available in Requirement set: File + *
HostsExcel, PowerPoint, Word
Requirement SetsFile
* * 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). * @@ -2346,9 +2346,9 @@ declare namespace Office { * Gets file properties of the current document. * * @remarks - * Hosts: Excel, PowerPoint, Word + * * - * Available in Requirement set: not in a set + *
HostsExcel, PowerPoint, Word
Requirement Setsnot in a set
* * You get the file's URL with the url property (`asyncResult.value.url`). * @@ -2360,9 +2360,9 @@ declare namespace Office { * Reads the data contained in the current selection in the document. * * @remarks - * Hosts: Access, Excel, PowerPoint, Project, Word + * * - * Available in Requirement set: Selection + *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsSelection
* * 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. * @@ -2414,9 +2414,9 @@ declare namespace Office { * Goes to the specified object or location in the document. * * @remarks - * Hosts: Excel, PowerPoint, Word + * * - * Available in Requirement set: not in a set + *
HostsExcel, PowerPoint, Word
Requirement Setsnot in a set
* * PowerPoint doesn't support the goToByIdAsync method in Master Views. * @@ -2438,9 +2438,9 @@ declare namespace Office { * Removes an event handler for the specified event type. * * @remarks - * Hosts: Excel, PowerPoint, Project, Word + * * - * Available in Requirement set: DocumentEvents + *
HostsExcel, PowerPoint, Project, Word
Requirement SetsDocumentEvents
* * @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. @@ -2451,9 +2451,9 @@ declare namespace Office { * Writes the specified data into the current selection. * * @remarks - * Hosts: Access, Excel, PowerPoint, Project, Word, Word Online + * * - * Available in Requirement set: Selection + *
HostsAccess, Excel, PowerPoint, Project, Word, Word Online
Requirement SetsSelection
* * **Application-specific behaviors** * @@ -2613,22 +2613,22 @@ declare namespace Office { * @remarks * Access the File object with the AsyncResult.value property in the callback function passed to the Document.getFileAsync method. * - * Hosts: PowerPoint, Word + *
HostsPowerPoint, Word
*/ interface File { /** * Gets the document file size in bytes. * * @remarks - * Hosts: PowerPoint, Word + * * - * Available in Requirement set: File + *
HostsPowerPoint, Word
Requirement SetsFile
*/ size: number; /** * Gets the number of slices into which the file is divided. * @remarks - * Hosts: PowerPoint, Word + *
HostsPowerPoint, Word
*/ sliceCount: number; /** @@ -2636,9 +2636,9 @@ declare namespace Office { * * @remarks * - * Hosts: PowerPoint, Word + * * - * Available in Requirement set: File + *
HostsPowerPoint, Word
Requirement SetsFile
* * 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. * @@ -2674,9 +2674,9 @@ declare namespace Office { * Returns the specified slice. * * @remarks - * Hosts: PowerPoint, Word + * * - * Available in Requirement set: File + *
HostsPowerPoint, Word
Requirement SetsFile
* * In the callback function passed to the getSliceAsync method, you can use the properties of the AsyncResult object to return the following information. * @@ -2718,9 +2718,9 @@ declare namespace Office { * Represents a binding in two dimensions of rows and columns. * * @remarks - * Hosts: Excel, Word + * * - * Available in Requirement set: MatrixBindings + *
HostsExcel, Word
Requirement SetsMatrixBindings
* * The MatrixBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Binding object. */ @@ -2729,18 +2729,18 @@ declare namespace Office { * Gets the number of columns in the matrix data structure, as an integer value. * * @remarks - * Hosts: Access, Excel, PowerPoint, Project, Word + * * - * Available in Requirement set: MatrixBindings + *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsMatrixBindings
*/ columnCount: number; /** * Gets the number of rows in the matrix data structure, as an integer value. * * @remarks - * Hosts: Access, Excel, PowerPoint, Project, Word + * * - * Available in Requirement set: MatrixBindings + *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsMatrixBindings
*/ rowCount: number; } @@ -2754,9 +2754,9 @@ declare namespace Office { * * The Settings object is automatically loaded as part of the Document object, and is available by calling the settings property of that object when the add-in is activated. The developer is responsible for calling the saveAsync method after adding or deleting settings to save the settings in the document. * - * Hosts: Access, Excel, PowerPoint, Word + * * - * Available in Requirement set: Settings + *
HostsAccess, Excel, PowerPoint, Word
Requirement SetsSettings
*/ interface Settings { /** @@ -2767,9 +2767,9 @@ declare namespace Office { * @remarks * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * - * Hosts: Excel + * * - * Available in Requirement set: Settings + *
HostsExcel
Requirement SetsSettings
* * @param eventType Specifies the type of event to add. Required. * @param handler The event handler function to add. Required. @@ -2804,9 +2804,9 @@ declare namespace Office { * Retrieves the specified setting. * * @remarks - * Hosts: Access, Excel, PowerPoint, Word + * * - * Available in Requirement set: Settings + *
HostsAccess, Excel, PowerPoint, Word
Requirement SetsSettings
* * @param settingName The case-sensitive name of the setting to retrieve. * @returns An object that has property names mapped to JSON serialized values. @@ -2845,9 +2845,9 @@ declare namespace Office { * * * - * Hosts: Access, Excel, PowerPoint, Word + * * - * Available in Requirement set: Settings + *
HostsAccess, Excel, PowerPoint, Word
Requirement SetsSettings
* * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter. */ @@ -2860,9 +2860,9 @@ declare namespace Office { * @remarks * null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag. * - * Hosts: Access, Excel, PowerPoint, Word + * * - * Available in Requirement set: Settings + *
HostsAccess, Excel, PowerPoint, Word
Requirement SetsSettings
* * @param settingName The case-sensitive name of the setting to remove. */ @@ -2873,9 +2873,9 @@ declare namespace Office { * @remarks * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType will be removed. * - * Hosts: Access, Excel, PowerPoint + * * - * Available in Requirement set: Settings + *
HostsAccess, Excel, PowerPoint
Requirement SetsSettings
* * @param eventType Specifies the type of event to remove. Required. * @param options Provides options to determine which event handler or handlers are removed. @@ -2915,7 +2915,7 @@ declare namespace Office { * * * - * Hosts: Access, Excel, PowerPoint, Word + *
HostsAccess, Excel, PowerPoint, Word
* * @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 AsyncResult. When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter to return the following information. @@ -2929,9 +2929,9 @@ declare namespace Office { * @remarks * 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. * - * Hosts: Access, Excel, PowerPoint, Word + * * - * Available in Requirement set: Settings + *
HostsAccess, Excel, PowerPoint, Word
Requirement SetsSettings
* * @param settingName The case-sensitive name of the setting to set or create. * @param value Specifies the value to be stored. @@ -2944,9 +2944,9 @@ declare namespace Office { * @remarks * The Slice object is accessed with the File.getSliceAsync method. * - * Hosts: PowerPoint, Word + * * - * Available in Requirement set: File + *
HostsPowerPoint, Word
Requirement SetsFile
*/ interface Slice { /** @@ -2955,27 +2955,27 @@ declare namespace Office { * @remarks * Files in the "compressed" format will return a byte array that can be transformed to a base64-encoded string if required. * - * Hosts: PowerPoint, Word + * * - * Available in Requirement set: File + *
HostsPowerPoint, Word
Requirement SetsFile
*/ data: any; /** * Gets the zero-based index of the file slice. * * @remarks - * Hosts: PowerPoint, Word + * * - * Available in Requirement set: File + *
HostsPowerPoint, Word
Requirement SetsFile
*/ index: number; /** * Gets the size of the slice in bytes. * * @remarks - * Hosts: PowerPoint, Word + * * - * Available in Requirement set: File + *
HostsPowerPoint, Word
Requirement SetsFile
*/ size: number; } @@ -2983,9 +2983,9 @@ declare namespace Office { * Represents a binding in two dimensions of rows and columns, optionally with headers. * * @remarks - * Hosts: Access, Excel, PowerPoint, Project, Word + * * - * Available in Requirement set: TableBindings + *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsTableBindings
* * The TableBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Binding object. * @@ -2996,27 +2996,27 @@ declare namespace Office { * Gets the number of columns in the TableBinding, as an integer value. * * @remarks - * Hosts: Access, Excel,Word + * * - * Available in Requirement set: TableBindings + *
HostsAccess, Excel,Word
Requirement SetsTableBindings
*/ columnCount: number; /** * True, if the table has headers; otherwise false. * * @remarks - * Hosts: Access, Excel, PowerPoint, Project, Word + * * - * Available in Requirement set: TableBindings + *
HostsAccess, Excel, PowerPoint, Project, Word
Requirement SetsTableBindings
*/ hasHeaders: boolean; /** * Gets the number of rows in the TableBinding, as an integer value. * * @remarks - * Hosts: Access, Excel,Word + * * - * Available in Requirement set: TableBindings + *
HostsAccess, Excel,Word
Requirement SetsTableBindings
* * When you insert an empty table by selecting a single row in Excel 2013 and Excel Online (using Table on the Insert tab), both Office host applications create a single row of headers followed by a single blank row. However, if your add-in's script creates a binding for this newly inserted table (for example, by using the addFromSelectionAsync method), and then checks the value of the rowCount property, the value returned will differ depending whether the spreadsheet is open in Excel 2013 or Excel Online. @@ -3033,9 +3033,9 @@ declare namespace Office { * Adds the specified data to the table as additional columns. * * @remarks - * Hosts: Excel, Word + * * - * Available in Requirement set: TableBindings + *
HostsExcel, Word
Requirement SetsTableBindings
* * To add one or more columns specifying the values of the data and headers, pass a TableData object as the data parameter. To add one or more columns specifying only the data, pass an array of arrays ("matrix") as the data parameter. * @@ -3058,9 +3058,9 @@ declare namespace Office { * Adds the specified data to the table as additional rows. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: TableBindings + *
HostsAccess, Excel, Word
Requirement SetsTableBindings
* * To add one or more columns specifying the values of the data and headers, pass a TableData object as the data parameter. To add one or more columns specifying only the data, pass an array of arrays ("matrix") as the data parameter. * @@ -3083,9 +3083,9 @@ declare namespace Office { * Deletes all non-header rows and their values in the table, shifting appropriately for the host application. * * @remarks - * Hosts: Access, Excel, Word + * * - * Available in Requirement set: TableBindings + *
HostsAccess, Excel, Word
Requirement SetsTableBindings
* * In Excel, if the table has no header row, this method will delete the table itself. * @@ -3097,9 +3097,9 @@ declare namespace Office { * Clears formatting on the bound table. * * @remarks - * Hosts: Excel + * * - * Available in Requirement set: Not in a set + *
HostsExcel
Requirement SetsNot in a set
* * See {@link https://docs.microsoft.com/en-us/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | Format tables in add-ins for Excel} for more information. * @@ -3119,9 +3119,9 @@ declare namespace Office { * Sets formatting on specified items and data in the table. * * @remarks - * Hosts: Excel + * * - * Available in Requirement set: Not in a set + *
HostsExcel
Requirement SetsNot in a set
* * **Specifying the cellFormat parameter** * @@ -3237,9 +3237,9 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * Hosts: Excel + * * - * Available in Requirement set: Not in a set + *
HostsExcel
Requirement SetsNot 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. * @@ -3278,9 +3278,9 @@ declare namespace Office { * Represents the data in a table or a {@link Office.TableBinding}. * * @remarks - * Hosts: Excel, Word + * * - * Available in Requirement set: TableBindings + *
HostsExcel, Word
Requirement SetsTableBindings
*/ class TableData { constructor(rows: any[][], headers: any[]); @@ -3297,9 +3297,9 @@ declare namespace Office { * * - If you overwrite or update an existing table, the existing headers are not altered. * - * Hosts: Excel, Word + * * - * Available in Requirement set: TableBindings + *
HostsExcel, Word
Requirement SetsTableBindings
*/ headers: any[]; /** @@ -3314,9 +3314,9 @@ declare namespace Office { * * - If you overwrite or update an existing table, the existing rows are not altered. * - * Hosts: Excel, Word + * * - * Available in Requirement set: TableBindings + *
HostsExcel, Word
Requirement SetsTableBindings
*/ rows: any[][]; } @@ -3324,7 +3324,7 @@ declare namespace Office { * Specifies enumerated values for the cells: property in the cellFormat parameter of {@link https://docs.microsoft.com/en-us/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | table formatting methods}. * * @remarks - * Hosts: Excel + *
HostsExcel
*/ enum Table { /** @@ -3344,9 +3344,9 @@ declare namespace Office { * Represents a bound text selection in the document. * * @remarks - * Hosts: Access, Excel, PowerPoint, Project, Word + * * - * Available in Requirement set: TextBindings + *
HostsAccess, Excel, PowerPoint, Project, Word
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. */ @@ -3357,7 +3357,7 @@ declare namespace Office { * @remarks * A ProjectProjectFields constant can be used as a parameter of the getProjectFieldAsync method. * - * Hosts: Project + *
HostsProject
*/ enum ProjectProjectFields { /** @@ -4228,7 +4228,7 @@ 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. * - * Hosts: Project + *
HostsProject
*/ enum ProjectTaskFields { /** @@ -5364,7 +5364,7 @@ declare namespace Office { * @remarks * The getSelectedViewAsync method returns the ProjectViewTypes constant value and name that corresponds to the active view. * - * Hosts: Project + *
HostsProject
*/ enum ProjectViewTypes { /**