vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-09-24 10:00:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #31846 from AlexJerabek/AlexJ-Callbacks

Browse Source 
[office-js, office-js-preview] Adding overloads for callback methods
This commit is contained in:
Sheetal Nandi
2019-01-02 14:20:28 -08:00
committed by GitHub
parent 1b768218fc 099d1b993b
commit 1a2ac36dd9
2 changed files with 127 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/office-js-preview/index.d.ts
Vendored
+61
View File
@@ -1103,6 +1103,7 @@ declare namespace Office {
* @param callback - Optional. Accepts a callback method to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
*/
displayDialogAsync(startAddress: string, options?: DialogOptions, callback?: (result: AsyncResult<Dialog>) => void): void;
displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => 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.
* @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.
@@ -2295,6 +2296,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult<void>) => void): void;
addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult<void>) => void): void;
/**
* Returns the data contained within the binding.
*
@@ -2310,6 +2312,7 @@ declare namespace Office {
* If the `coercionType` parameter is specified (and the call is successful), the data is returned in the format described in the CoercionType enumeration topic.
*/
getDataAsync<T>(options?: GetBindingDataOptions, callback?: (result: AsyncResult<T>) => void): void;
getDataAsync<T>(callback?: (result: AsyncResult<T>) => void): void;
/**
* Removes the specified handler from the binding for the specified event type.
*
@@ -2321,6 +2324,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;
/**
* Writes data to the bound section of the document represented by the specified binding object.
*
@@ -2452,6 +2456,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setDataAsync(data: TableData | any, options?: SetBindingDataOptions, callback?: (result: AsyncResult<void>) => void): void;
setDataAsync(data: TableData | any, callback?: (result: AsyncResult<void>) => void): void;
}
/**
@@ -2601,6 +2606,7 @@ declare namespace Office {
* The `value` property of the result is the Binding object that represents the specified named item.
*/
addFromNamedItemAsync(itemName: string, bindingType: BindingType, options?: AddBindingFromNamedItemOptions, callback?: (result: AsyncResult<Binding>) => void): void;
addFromNamedItemAsync(itemName: string, bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;
/**
* Create a binding by prompting the user to make a selection on the document.
*
@@ -2632,6 +2638,7 @@ declare namespace Office {
* The `value` property of the result is the Binding object that represents the selection specified by the user.
*/
addFromPromptAsync(bindingType: BindingType, options?: AddBindingFromPromptOptions, callback?: (result: AsyncResult<Binding>) => void): void;
addFromPromptAsync(bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;
/**
* Create a binding based on the user's current selection.
*
@@ -2668,6 +2675,7 @@ declare namespace Office {
* The `value` property of the result is the Binding object that represents the selection specified by the user.
*/
addFromSelectionAsync(bindingType: BindingType, options?: AddBindingFromSelectionOptions, callback?: (result: AsyncResult<Binding>) => void): void;
addFromSelectionAsync(bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;
/**
* Gets all bindings that were previously created.
*
@@ -2695,6 +2703,7 @@ declare namespace Office {
* The `value` property of the result is an array that contains each binding created for the referenced Bindings object.
*/
getAllAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Binding[]>) => void): void;
getAllAsync(callback?: (result: AsyncResult<Binding[]>) => void): void;
/**
* Retrieves a binding based on its Name
*
@@ -2725,6 +2734,7 @@ declare namespace Office {
* The `value` property of the result is the Binding object specified by the id in the call.
*/
getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Binding>) => void): void;
getByIdAsync(id: string, callback?: (result: AsyncResult<Binding>) => void): void;
/**
* Removes the binding from the document
*
@@ -2754,6 +2764,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
releaseByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
releaseByIdAsync(id: string, callback?: (result: AsyncResult<void>) => void): void;
}
/**
* Represents an XML node in a tree in a document.
@@ -2809,6 +2820,7 @@ declare namespace Office {
* The `value` property of the result is an array of CustomXmlNode objects that represent the nodes specified by the XPath expression passed to the `xPath` parameter.
*/
getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
getNodesAsync(xPath: string, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
/**
* Gets the node value.
*
@@ -2820,6 +2832,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the value of the referenced node.
*/
getNodeValueAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getNodeValueAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Gets the text of an XML node in a custom XML part.
*
@@ -2831,6 +2844,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the inner text of the referenced nodes.
*/
getTextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getTextAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Gets the node's XML.
*
@@ -2842,6 +2856,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the XML of the referenced node.
*/
getXmlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getXmlAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Sets the node value.
*
@@ -2853,6 +2868,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setNodeValueAsync(value: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setNodeValueAsync(value: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Asynchronously sets the text of an XML node in a custom XML part.
*
@@ -2866,6 +2882,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setTextAsync(text: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setTextAsync(text: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Sets the node XML.
*
@@ -2877,6 +2894,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setXmlAsync(xml: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setXmlAsync(xml: string, callback?: (result: AsyncResult<void>) => void): void;
}
/**
* Represents a single CustomXMLPart in an {@link Office.CustomXmlParts} collection.
@@ -2927,6 +2945,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;
/**
* Deletes the Custom XML Part.
*
@@ -2936,6 +2955,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
deleteAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
deleteAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
* Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath.
*
@@ -2947,6 +2967,7 @@ declare namespace Office {
* The `value` property of the result is an array of CustomXmlNode objects that represent the nodes specified by the XPath expression passed to the xPath parameter.
*/
getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
getNodesAsync(xPath: string, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
/**
* Asynchronously gets the XML inside this custom XML part.
*
@@ -2957,6 +2978,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the XML of the referenced CustomXmlPart object.
*/
getXmlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getXmlAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Removes an event handler for the specified event type.
*
@@ -2969,6 +2991,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;
}
/**
@@ -3108,6 +3131,7 @@ declare namespace Office {
* The `value` property of the result is the newly created CustomXmlPart object.
*/
addAsync(xml: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;
addAsync(xml: string, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;
/**
* Asynchronously gets the specified custom XML part by its id.
*
@@ -3118,6 +3142,7 @@ declare namespace Office {
* If there is no custom XML part with the specified id, the method returns null.
*/
getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;
getByIdAsync(id: string, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;
/**
* Asynchronously gets the specified custom XML part(s) by its namespace.
*
@@ -3127,6 +3152,7 @@ declare namespace Office {
* The `value` property of the result is an array of CustomXmlPart objects that match the specified namespace.
*/
getByNamespaceAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart[]>) => void): void;
getByNamespaceAsync(ns: string, callback?: (result: AsyncResult<CustomXmlPart[]>) => void): void;
}
/**
* Represents a collection of CustomXmlPart objects.
@@ -3162,6 +3188,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addNamespaceAsync(prefix: string, ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addNamespaceAsync(prefix: string, ns: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Asynchronously gets the namespace mapped to the specified prefix.
*
@@ -3176,6 +3203,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the namespace mapped to the specified prefix.
*/
getNamespaceAsync(prefix: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getNamespaceAsync(prefix: string, callback?: (result: AsyncResult<string>) => void): void;
/**
* Asynchronously gets the prefix for the specified namespace.
*
@@ -3190,6 +3218,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the prefix of the specified namespace.
*/
getPrefixAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getPrefixAsync(ns: string, callback?: (result: AsyncResult<string>) => void): void;
}
/**
* An abstract class that represents the document the add-in is interacting with.
@@ -3345,6 +3374,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult<void>) => void): void;
/**
* Returns the state of the current view of the presentation (edit or read).
*
@@ -3374,6 +3404,7 @@ declare namespace Office {
* such as Normal or Outline View. "read" corresponds to either Slide Show or Reading View.
*/
getActiveViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<"edit" | "read">) => void): void;
getActiveViewAsync(callback?: (result: AsyncResult<"edit" | "read">) => void): void;
/**
* 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.
@@ -3418,6 +3449,7 @@ declare namespace Office {
* The `value` property of the result is the File object.
*/
getFileAsync(fileType: FileType, options?: GetFileOptions, callback?: (result: AsyncResult<Office.File>) => void): void;
getFileAsync(fileType: FileType, callback?: (result: AsyncResult<Office.File>) => void): void;
/**
* Gets file properties of the current document.
*
@@ -3447,6 +3479,7 @@ declare namespace Office {
* The `value` property of the result is the file's properties (with the URL found at `asyncResult.value.url`).
*/
getFilePropertiesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Office.FileProperties>) => void): void;
getFilePropertiesAsync(callback?: (result: AsyncResult<Office.FileProperties>) => void): void;
/**
* Reads the data contained in the current selection in the document.
*
@@ -3539,6 +3572,7 @@ declare namespace Office {
* (See Remarks for more information about data coercion.)
*/
getSelectedDataAsync<T>(coerciontype: Office.CoercionType, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<T>) => void): void;
getSelectedDataAsync<T>(coerciontype: Office.CoercionType, callback?: (result: AsyncResult<T>) => void): void;
/**
* Goes to the specified object or location in the document.
*
@@ -3581,6 +3615,7 @@ declare namespace Office {
* The `value` property of the result is the current view.
*/
goToByIdAsync(id: string | number, goToType: GoToType, options?: GoToByIdOptions, callback?: (result: AsyncResult<any>) => void): void;
goToByIdAsync(id: string | number, goToType: GoToType, callback?: (result: AsyncResult<any>) => void): void;
/**
* Removes an event handler for the specified event type.
*
@@ -3610,6 +3645,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;
/**
* Writes the specified data into the current selection.
*
@@ -3723,6 +3759,7 @@ declare namespace Office {
* The AsyncResult.value property always returns undefined because there is no object or data to retrieve.
*/
setSelectedDataAsync(data: string | TableData | any[][], options?: SetSelectedDataOptions, callback?: (result: AsyncResult<void>) => void): void;
setSelectedDataAsync(data: string | TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;
/**
* Project documents only. Get Project field (Ex. ProjectWebAccessURL).
* @param fieldId Project level fields.
@@ -3747,6 +3784,7 @@ declare namespace Office {
* </table>
*/
getProjectFieldAsync(fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getProjectFieldAsync(fieldId: number, callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get resource field for provided resource Id. (Ex.ResourceName)
* @param resourceId Either a string or value of the Resource Id.
@@ -3772,6 +3810,7 @@ declare namespace Office {
* </table>
*/
getResourceFieldAsync(resourceId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getResourceFieldAsync(resourceId: string, fieldId: number, callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Get the current selected Resource's Id.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3795,6 +3834,7 @@ declare namespace Office {
* </table>
*/
getSelectedResourceAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getSelectedResourceAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Get the current selected Task's Id.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3818,6 +3858,7 @@ declare namespace Office {
* </table>
*/
getSelectedTaskAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getSelectedTaskAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Get the current selected View Type (Ex. Gantt) and View Name.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3843,6 +3884,7 @@ declare namespace Office {
* </table>
*/
getSelectedViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getSelectedViewAsync(callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get the Task Name, WSS Task Id, and ResourceNames for given taskId.
* @param taskId Either a string or value of the Task Id.
@@ -3870,6 +3912,7 @@ declare namespace Office {
* </table>
*/
getTaskAsync(taskId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getTaskAsync(taskId: string, callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get task field for provided task Id. (Ex. StartDate).
* @param taskId Either a string or value of the Task Id.
@@ -3895,6 +3938,7 @@ declare namespace Office {
* </table>
*/
getTaskFieldAsync(taskId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getTaskFieldAsync(taskId: string, fieldId: number, callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get the WSS Url and list name for the Tasks List, the MPP is synced too.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3920,6 +3964,7 @@ declare namespace Office {
* </table>
*/
getWSSUrlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getWSSUrlAsync(callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get the maximum index of the collection of resources in the current project.
*
@@ -3946,6 +3991,7 @@ declare namespace Office {
* </table>
*/
getMaxResourceIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<number>) => void): void;
getMaxResourceIndexAsync(callback?: (result: AsyncResult<number>) => void): void;
/**
* Project documents only. Get the maximum index of the collection of tasks in the current project.
*
@@ -3972,6 +4018,7 @@ declare namespace Office {
* </table>
*/
getMaxTaskIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<number>) => void): void;
getMaxTaskIndexAsync(callback?: (result: AsyncResult<number>) => void): void;
/**
* Project documents only. Get the GUID of the resource that has the specified index in the resource collection.
*
@@ -3999,6 +4046,7 @@ declare namespace Office {
* </table>
*/
getResourceByIndexAsync(resourceIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getResourceByIndexAsync(resourceIndex: number, callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Get the GUID of the task that has the specified index in the task collection.
*
@@ -4026,6 +4074,7 @@ declare namespace Office {
* </table>
*/
getTaskByIndexAsync(taskIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getTaskByIndexAsync(taskIndex: number, callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Set resource field for specified resource Id.
*
@@ -4054,6 +4103,7 @@ declare namespace Office {
* </table>
*/
setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult<void>) => void): void;
/**
* Project documents only. Set task field for specified task Id.
*
@@ -4082,6 +4132,7 @@ declare namespace Office {
* </table>
*/
setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult<void>) => void): void;
}
/**
* Provides information about the document that raised the SelectionChanged event.
@@ -4332,6 +4383,7 @@ declare namespace Office {
* </table>
*/
addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult<void>) => void): void;
/**
* Retrieves the specified setting.
*
@@ -4487,6 +4539,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;
/**
* Persists the in-memory copy of the settings property bag in the document.
*
@@ -4544,6 +4597,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
saveAsync(options?: SaveSettingsOptions, callback?: (result: AsyncResult<void>) => void): void;
saveAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
* Sets or creates the specified setting.
*
@@ -4804,6 +4858,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addColumnsAsync(tableData: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addColumnsAsync(tableData: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;
/**
* Adds the specified data to the table as additional rows.
*
@@ -4844,6 +4899,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addRowsAsync(rows: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addRowsAsync(rows: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;
/**
* Deletes all non-header rows and their values in the table, shifting appropriately for the host application.
*
@@ -4871,6 +4927,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
deleteAllDataValuesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
deleteAllDataValuesAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
* Clears formatting on the bound table.
*
@@ -4895,6 +4952,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
clearFormatsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
clearFormatsAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
* Gets the formatting on specified items in the table.
*
@@ -4949,6 +5007,7 @@ declare namespace Office {
* The `value` property of the result is an array containing one or more JavaScript objects specifying the formatting of their corresponding cells.
*/
getFormatsAsync(cellReference?: any, formats?: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult< ({ cells: any, format: any})[]>) => void): void;
getFormatsAsync(cellReference?: any, formats?: any[], callback?: (result: AsyncResult< ({ cells: any, format: any})[]>) => void): void;
/**
* Sets formatting on specified items and data in the table.
*
@@ -5062,6 +5121,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setFormatsAsync(cellFormat: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setFormatsAsync(cellFormat: any[], callback?: (result: AsyncResult<void>) => void): void;
/**
* Updates table formatting options on the bound table.
*
@@ -5115,6 +5175,7 @@ declare namespace Office {
*
*/
setTableOptionsAsync(tableOptions: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setTableOptionsAsync(tableOptions: any, callback?: (result: AsyncResult<void>) => void): void;
}
/**
* Represents the data in a table or a {@link Office.TableBinding}.
types/office-js/index.d.ts
Vendored
+66
View File
@@ -1103,6 +1103,7 @@ declare namespace Office {
* @param callback - Optional. Accepts a callback method to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
*/
displayDialogAsync(startAddress: string, options?: DialogOptions, callback?: (result: AsyncResult<Dialog>) => void): void;
displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => 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.
* @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.
@@ -2295,6 +2296,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult<void>) => void): void;
addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult<void>) => void): void;
/**
* Returns the data contained within the binding.
*
@@ -2310,6 +2312,7 @@ declare namespace Office {
* If the `coercionType` parameter is specified (and the call is successful), the data is returned in the format described in the CoercionType enumeration topic.
*/
getDataAsync<T>(options?: GetBindingDataOptions, callback?: (result: AsyncResult<T>) => void): void;
getDataAsync<T>(callback?: (result: AsyncResult<T>) => void): void;
/**
* Removes the specified handler from the binding for the specified event type.
*
@@ -2321,6 +2324,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;
/**
* Writes data to the bound section of the document represented by the specified binding object.
*
@@ -2452,6 +2456,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setDataAsync(data: TableData | any, options?: SetBindingDataOptions, callback?: (result: AsyncResult<void>) => void): void;
setDataAsync(data: TableData | any, callback?: (result: AsyncResult<void>) => void): void;
}
/**
@@ -2601,6 +2606,7 @@ declare namespace Office {
* The `value` property of the result is the Binding object that represents the specified named item.
*/
addFromNamedItemAsync(itemName: string, bindingType: BindingType, options?: AddBindingFromNamedItemOptions, callback?: (result: AsyncResult<Binding>) => void): void;
addFromNamedItemAsync(itemName: string, bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;
/**
* Create a binding by prompting the user to make a selection on the document.
*
@@ -2632,6 +2638,7 @@ declare namespace Office {
* The `value` property of the result is the Binding object that represents the selection specified by the user.
*/
addFromPromptAsync(bindingType: BindingType, options?: AddBindingFromPromptOptions, callback?: (result: AsyncResult<Binding>) => void): void;
addFromPromptAsync(bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;
/**
* Create a binding based on the user's current selection.
*
@@ -2668,6 +2675,7 @@ declare namespace Office {
* The `value` property of the result is the Binding object that represents the selection specified by the user.
*/
addFromSelectionAsync(bindingType: BindingType, options?: AddBindingFromSelectionOptions, callback?: (result: AsyncResult<Binding>) => void): void;
addFromSelectionAsync(bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;
/**
* Gets all bindings that were previously created.
*
@@ -2695,6 +2703,7 @@ declare namespace Office {
* The `value` property of the result is an array that contains each binding created for the referenced Bindings object.
*/
getAllAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Binding[]>) => void): void;
getAllAsync(callback?: (result: AsyncResult<Binding[]>) => void): void;
/**
* Retrieves a binding based on its Name
*
@@ -2725,6 +2734,7 @@ declare namespace Office {
* The `value` property of the result is the Binding object specified by the id in the call.
*/
getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Binding>) => void): void;
getByIdAsync(id: string, callback?: (result: AsyncResult<Binding>) => void): void;
/**
* Removes the binding from the document
*
@@ -2754,6 +2764,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
releaseByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
releaseByIdAsync(id: string, callback?: (result: AsyncResult<void>) => void): void;
}
/**
* Represents an XML node in a tree in a document.
@@ -2809,6 +2820,7 @@ declare namespace Office {
* The `value` property of the result is an array of CustomXmlNode objects that represent the nodes specified by the XPath expression passed to the `xPath` parameter.
*/
getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
getNodesAsync(xPath: string, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
/**
* Gets the node value.
*
@@ -2820,6 +2832,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the value of the referenced node.
*/
getNodeValueAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getNodeValueAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Gets the text of an XML node in a custom XML part.
*
@@ -2831,6 +2844,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the inner text of the referenced nodes.
*/
getTextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getTextAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Gets the node's XML.
*
@@ -2842,6 +2856,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the XML of the referenced node.
*/
getXmlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getXmlAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Sets the node value.
*
@@ -2853,6 +2868,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setNodeValueAsync(value: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setNodeValueAsync(value: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Asynchronously sets the text of an XML node in a custom XML part.
*
@@ -2866,6 +2882,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setTextAsync(text: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setTextAsync(text: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Sets the node XML.
*
@@ -2877,6 +2894,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setXmlAsync(xml: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setXmlAsync(xml: string, callback?: (result: AsyncResult<void>) => void): void;
}
/**
* Represents a single CustomXMLPart in an {@link Office.CustomXmlParts} collection.
@@ -2927,6 +2945,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;
/**
* Deletes the Custom XML Part.
*
@@ -2936,6 +2955,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
deleteAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
deleteAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
* Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath.
*
@@ -2947,6 +2967,7 @@ declare namespace Office {
* The `value` property of the result is an array of CustomXmlNode objects that represent the nodes specified by the XPath expression passed to the xPath parameter.
*/
getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
getNodesAsync(xPath: string, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
/**
* Asynchronously gets the XML inside this custom XML part.
*
@@ -2957,6 +2978,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the XML of the referenced CustomXmlPart object.
*/
getXmlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getXmlAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Removes an event handler for the specified event type.
*
@@ -2969,6 +2991,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;
}
/**
@@ -3108,6 +3131,7 @@ declare namespace Office {
* The `value` property of the result is the newly created CustomXmlPart object.
*/
addAsync(xml: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;
addAsync(xml: string, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;
/**
* Asynchronously gets the specified custom XML part by its id.
*
@@ -3118,6 +3142,7 @@ declare namespace Office {
* If there is no custom XML part with the specified id, the method returns null.
*/
getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;
getByIdAsync(id: string, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;
/**
* Asynchronously gets the specified custom XML part(s) by its namespace.
*
@@ -3127,6 +3152,7 @@ declare namespace Office {
* The `value` property of the result is an array of CustomXmlPart objects that match the specified namespace.
*/
getByNamespaceAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart[]>) => void): void;
getByNamespaceAsync(ns: string, callback?: (result: AsyncResult<CustomXmlPart[]>) => void): void;
}
/**
* Represents a collection of CustomXmlPart objects.
@@ -3162,6 +3188,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addNamespaceAsync(prefix: string, ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addNamespaceAsync(prefix: string, ns: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Asynchronously gets the namespace mapped to the specified prefix.
*
@@ -3176,6 +3203,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the namespace mapped to the specified prefix.
*/
getNamespaceAsync(prefix: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getNamespaceAsync(prefix: string, callback?: (result: AsyncResult<string>) => void): void;
/**
* Asynchronously gets the prefix for the specified namespace.
*
@@ -3190,6 +3218,7 @@ declare namespace Office {
* The `value` property of the result is a string that contains the prefix of the specified namespace.
*/
getPrefixAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getPrefixAsync(ns: string, callback?: (result: AsyncResult<string>) => void): void;
}
/**
* An abstract class that represents the document the add-in is interacting with.
@@ -3345,6 +3374,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult<void>) => void): void;
/**
* Returns the state of the current view of the presentation (edit or read).
*
@@ -3374,6 +3404,7 @@ declare namespace Office {
* such as Normal or Outline View. "read" corresponds to either Slide Show or Reading View.
*/
getActiveViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<"edit" | "read">) => void): void;
getActiveViewAsync(callback?: (result: AsyncResult<"edit" | "read">) => void): void;
/**
* 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.
@@ -3418,6 +3449,7 @@ declare namespace Office {
* The `value` property of the result is the File object.
*/
getFileAsync(fileType: FileType, options?: GetFileOptions, callback?: (result: AsyncResult<Office.File>) => void): void;
getFileAsync(fileType: FileType, callback?: (result: AsyncResult<Office.File>) => void): void;
/**
* Gets file properties of the current document.
*
@@ -3447,6 +3479,7 @@ declare namespace Office {
* The `value` property of the result is the file's properties (with the URL found at `asyncResult.value.url`).
*/
getFilePropertiesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Office.FileProperties>) => void): void;
getFilePropertiesAsync(callback?: (result: AsyncResult<Office.FileProperties>) => void): void;
/**
* Reads the data contained in the current selection in the document.
*
@@ -3539,6 +3572,7 @@ declare namespace Office {
* (See Remarks for more information about data coercion.)
*/
getSelectedDataAsync<T>(coerciontype: Office.CoercionType, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<T>) => void): void;
getSelectedDataAsync<T>(coerciontype: Office.CoercionType, callback?: (result: AsyncResult<T>) => void): void;
/**
* Goes to the specified object or location in the document.
*
@@ -3581,6 +3615,7 @@ declare namespace Office {
* The `value` property of the result is the current view.
*/
goToByIdAsync(id: string | number, goToType: GoToType, options?: GoToByIdOptions, callback?: (result: AsyncResult<any>) => void): void;
goToByIdAsync(id: string | number, goToType: GoToType, callback?: (result: AsyncResult<any>) => void): void;
/**
* Removes an event handler for the specified event type.
*
@@ -3610,6 +3645,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;
/**
* Writes the specified data into the current selection.
*
@@ -3723,6 +3759,7 @@ declare namespace Office {
* The AsyncResult.value property always returns undefined because there is no object or data to retrieve.
*/
setSelectedDataAsync(data: string | TableData | any[][], options?: SetSelectedDataOptions, callback?: (result: AsyncResult<void>) => void): void;
setSelectedDataAsync(data: string | TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;
/**
* Project documents only. Get Project field (Ex. ProjectWebAccessURL).
* @param fieldId Project level fields.
@@ -3747,6 +3784,7 @@ declare namespace Office {
* </table>
*/
getProjectFieldAsync(fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getProjectFieldAsync(fieldId: number, callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get resource field for provided resource Id. (Ex.ResourceName)
* @param resourceId Either a string or value of the Resource Id.
@@ -3772,6 +3810,7 @@ declare namespace Office {
* </table>
*/
getResourceFieldAsync(resourceId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getResourceFieldAsync(resourceId: string, fieldId: number, callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Get the current selected Resource's Id.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3795,6 +3834,7 @@ declare namespace Office {
* </table>
*/
getSelectedResourceAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getSelectedResourceAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Get the current selected Task's Id.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3818,6 +3858,7 @@ declare namespace Office {
* </table>
*/
getSelectedTaskAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getSelectedTaskAsync(callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Get the current selected View Type (Ex. Gantt) and View Name.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3843,6 +3884,7 @@ declare namespace Office {
* </table>
*/
getSelectedViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getSelectedViewAsync(callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get the Task Name, WSS Task Id, and ResourceNames for given taskId.
* @param taskId Either a string or value of the Task Id.
@@ -3870,6 +3912,7 @@ declare namespace Office {
* </table>
*/
getTaskAsync(taskId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getTaskAsync(taskId: string, callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get task field for provided task Id. (Ex. StartDate).
* @param taskId Either a string or value of the Task Id.
@@ -3895,6 +3938,7 @@ declare namespace Office {
* </table>
*/
getTaskFieldAsync(taskId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getTaskFieldAsync(taskId: string, fieldId: number, callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get the WSS Url and list name for the Tasks List, the MPP is synced too.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3920,6 +3964,7 @@ declare namespace Office {
* </table>
*/
getWSSUrlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
getWSSUrlAsync(callback?: (result: AsyncResult<any>) => void): void;
/**
* Project documents only. Get the maximum index of the collection of resources in the current project.
*
@@ -3946,6 +3991,7 @@ declare namespace Office {
* </table>
*/
getMaxResourceIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<number>) => void): void;
getMaxResourceIndexAsync(callback?: (result: AsyncResult<number>) => void): void;
/**
* Project documents only. Get the maximum index of the collection of tasks in the current project.
*
@@ -3972,6 +4018,7 @@ declare namespace Office {
* </table>
*/
getMaxTaskIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<number>) => void): void;
getMaxTaskIndexAsync(callback?: (result: AsyncResult<number>) => void): void;
/**
* Project documents only. Get the GUID of the resource that has the specified index in the resource collection.
*
@@ -3999,6 +4046,7 @@ declare namespace Office {
* </table>
*/
getResourceByIndexAsync(resourceIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getResourceByIndexAsync(resourceIndex: number, callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Get the GUID of the task that has the specified index in the task collection.
*
@@ -4026,6 +4074,7 @@ declare namespace Office {
* </table>
*/
getTaskByIndexAsync(taskIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getTaskByIndexAsync(taskIndex: number, callback?: (result: AsyncResult<string>) => void): void;
/**
* Project documents only. Set resource field for specified resource Id.
*
@@ -4054,6 +4103,7 @@ declare namespace Office {
* </table>
*/
setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult<void>) => void): void;
/**
* Project documents only. Set task field for specified task Id.
*
@@ -4082,6 +4132,7 @@ declare namespace Office {
* </table>
*/
setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult<void>) => void): void;
}
/**
* Provides information about the document that raised the SelectionChanged event.
@@ -4332,6 +4383,7 @@ declare namespace Office {
* </table>
*/
addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult<void>) => void): void;
/**
* Retrieves the specified setting.
*
@@ -4487,6 +4539,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;
/**
* Persists the in-memory copy of the settings property bag in the document.
*
@@ -4544,6 +4597,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
saveAsync(options?: SaveSettingsOptions, callback?: (result: AsyncResult<void>) => void): void;
saveAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
* Sets or creates the specified setting.
*
@@ -4804,6 +4858,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addColumnsAsync(tableData: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addColumnsAsync(tableData: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;
/**
* Adds the specified data to the table as additional rows.
*
@@ -4844,6 +4899,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
addRowsAsync(rows: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
addRowsAsync(rows: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;
/**
* Deletes all non-header rows and their values in the table, shifting appropriately for the host application.
*
@@ -4871,6 +4927,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
deleteAllDataValuesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
deleteAllDataValuesAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
* Clears formatting on the bound table.
*
@@ -4895,6 +4952,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
clearFormatsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
clearFormatsAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
* Gets the formatting on specified items in the table.
*
@@ -4949,6 +5007,7 @@ declare namespace Office {
* The `value` property of the result is an array containing one or more JavaScript objects specifying the formatting of their corresponding cells.
*/
getFormatsAsync(cellReference?: any, formats?: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult< ({ cells: any, format: any})[]>) => void): void;
getFormatsAsync(cellReference?: any, formats?: any[], callback?: (result: AsyncResult< ({ cells: any, format: any})[]>) => void): void;
/**
* Sets formatting on specified items and data in the table.
*
@@ -5062,6 +5121,7 @@ declare namespace Office {
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
*/
setFormatsAsync(cellFormat: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setFormatsAsync(cellFormat: any[], callback?: (result: AsyncResult<void>) => void): void;
/**
* Updates table formatting options on the bound table.
*
@@ -5115,6 +5175,7 @@ declare namespace Office {
*
*/
setTableOptionsAsync(tableOptions: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
setTableOptionsAsync(tableOptions: any, callback?: (result: AsyncResult<void>) => void): void;
}
/**
* Represents the data in a table or a {@link Office.TableBinding}.
@@ -8712,6 +8773,7 @@ declare namespace Office {
* The body is provided in the requested format in the asyncResult.value property.
*/
getAsync(coerciontype: Office.CoercionType, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
getAsync(coerciontype: Office.CoercionType, callback?: (result: AsyncResult<string>) => void): void;
/**
* Returns the current body in a specified format.
*
@@ -8750,6 +8812,7 @@ declare namespace Office {
* The content type is returned as one of the CoercionType values in the asyncResult.value property.
*/
getTypeAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Office.CoercionType>) => void): void;
getTypeAsync(callback?: (result: AsyncResult<Office.CoercionType>) => void): void;
/**
* Adds the specified content to the beginning of the item body.
*
@@ -8784,6 +8847,7 @@ declare namespace Office {
* Any errors encountered will be provided in the asyncResult.error property.
*/
prependAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
prependAsync(data: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Adds the specified content to the beginning of the item body.
*
@@ -8883,6 +8947,7 @@ declare namespace Office {
* Any errors encountered will be provided in the asyncResult.error property.
*/
setAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
setAsync(data: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Replaces the entire body with the specified text.
*
@@ -8990,6 +9055,7 @@ declare namespace Office {
* Any errors encountered will be provided in the asyncResult.error property.
*/
setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
setSelectedDataAsync(data: string, callback?: (result: AsyncResult<void>) => void): void;
/**
* Replaces the selection in the body with the specified text.
*