diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index d29491618e..7ecd02afd1 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -349,7 +349,7 @@ declare namespace Office { /** * Returns a promise of an object described in the expression. Callback is invoked only if method fails. * @param expression The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName' - * @param callback The optional callback method + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ export function select(expression: string, callback?: (result: AsyncResult) => void): Binding; // Enumerations @@ -674,8 +674,9 @@ declare namespace Office { * * @param eventType The event type. For example, for bindings, it can be **Office.EventType.BindingSelectionChanged**, **Office.EventType.BindingDataChanged**, or the corresponding text values of these enumerations. * @param handler The event handler function to add. - * @param options { asyncContext: context } Where context is an object of any type that keeps state for the callback. - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. + * @param options Syntax example: {asyncContext:context} + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addHandlerAsync(eventType: EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -704,11 +705,11 @@ declare namespace Office { * * filterType: Specify whether to get only the visible (filtered in) data or all the data (default is all). Useful when filtering data. Use Office.FilterType or text value. * - * asyncContext: Object keeping state for the callback + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. * * rows: Only for table bindings in content add-ins for Access. Specifies the pre-defined string "thisRow" to get data in the currently selected row. - * @param callback The optional callback method + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getDataAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -725,7 +726,7 @@ declare namespace Office { * * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. * - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ removeHandlerAsync(eventType: EventType, options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -765,7 +766,7 @@ declare namespace Office { * * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. * - * @param callback The optional callback method + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ setDataAsync(data: TableData | any, options?: any, callback?: (result: AsyncResult) => void): void; } @@ -777,9 +778,9 @@ declare namespace Office { * @param bindingType The Office BindingType for the data * @param options Syntax example: {id: "BindingID"} * id: Name of the binding, autogenerated if not supplied. - * asyncContext: Object keeping state for the callback + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. * columns: The string[] of the columns involved in the binding - * @param callback The optional callback method + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addFromNamedItemAsync(itemName: string, bindingType: BindingType, options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -787,10 +788,10 @@ declare namespace Office { * @param bindingType The Office BindingType for the data * @param options addFromPromptAsyncOptions- e.g. {promptText: "Please select data", id: "mySales"} * promptText: Greet your users with a friendly word. - * asyncContext: Object keeping state for the callback + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. * id: Identifier. * sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string. - * @param callback The optional callback method + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addFromPromptAsync(bindingType: BindingType, options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -798,33 +799,33 @@ declare namespace Office { * @param bindingType The Office BindingType for the data * @param options addFromSelectionAsyncOptions- e.g. {id: "BindingID"} * id: Identifier. - * asyncContext: Object keeping state for the callback + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. * columns: The string[] of the columns involved in the binding * sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string. - * @param callback The optional callback method + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addFromSelectionAsync(bindingType: BindingType, options?: any, callback?: (result: AsyncResult) => void): void; /** * Gets an array with all the binding objects in the document. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getAllAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Retrieves a binding based on its Name * @param id The binding id * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getByIdAsync(id: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Removes the binding from the document * @param id The binding id * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ releaseByIdAsync(id: string, options?: any, callback?: (result: AsyncResult) => void): void; } @@ -839,53 +840,53 @@ declare namespace Office { * Gets the nodes associated with the xPath expression. * @param xPath The xPath expression * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getNodesAsync(xPath: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Gets the node value. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getNodeValueAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the text of an XML node in a custom XML part. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getTextAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Gets the node's XML. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getXmlAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Sets the node value. * @param value The value to be set on the node * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ setNodeValueAsync(value: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Asynchronously sets the text of an XML node in a custom XML part. * @param text Required. The text value of the XML node. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ setTextAsync(text: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Sets the node XML. * @param xml The XML to be set on the node * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ setXmlAsync(xml: string, options?: any, callback?: (result: AsyncResult) => void): void; } @@ -898,30 +899,30 @@ declare namespace Office { * @param eventType The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced' * @param handler The name of the handler * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addHandlerAsync(eventType: EventType, handler?: (result: any) => void, options?: any, callback?: (result: AsyncResult) => void): void; /** * Deletes the Custom XML Part. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ deleteAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Gets the nodes associated with the xPath expression. * @param xPath The xPath expression * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getNodesAsync(xPath: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Gets the XML for the Custom XML Part. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getXmlAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -929,8 +930,8 @@ declare namespace Office { * @param eventType The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced' * @param options Syntax example: {handler:eventHandler} * handler: Indicates a specific handler to be removed, if not specified all handlers are removed - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ removeHandlerAsync(eventType: EventType, options?: any, callback?: (result: AsyncResult) => void): void; } @@ -939,24 +940,24 @@ declare namespace Office { * Asynchronously adds a new custom XML part to a file. * @param xml The XML to add to the newly created custom XML part. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addAsync(xml: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part by its id. * @param id The id of the custom XML part. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getByIdAsync(id: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Asynchronously gets the specified custom XML part(s) by its namespace. * @param ns The namespace to search. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getByNamespaceAsync(ns: string, options?: any, callback?: (result: AsyncResult) => void): void; } @@ -966,24 +967,24 @@ declare namespace Office { * @param prefix The namespace prefix * @param ns The namespace URI * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addNamespaceAsync(prefix: string, ns: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Gets a namespace with the specified prefix * @param prefix The namespace prefix * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getNamespaceAsync(prefix: string, options?: any, callback?: (result: AsyncResult) => void): void; /** * Gets a prefix for the specified URI * @param ns The namespace URI * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getPrefixAsync(ns: string, options?: any, callback?: (result: AsyncResult) => void): void; } @@ -998,15 +999,15 @@ declare namespace Office { * @param eventType The event type. For document can be 'DocumentSelectionChanged' * @param handler The name of the handler * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addHandlerAsync(eventType: EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** * Returns the current view of the presentation. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getActiveViewAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -1014,14 +1015,14 @@ declare namespace Office { * @param fileType The format in which the file will be returned * @param options Syntax example: {sliceSize:1024} * sliceSize: Specifies the desired slice size (in bytes) up to 4MB. If not specified a default slice size of 4MB will be used. - * @param callback The optional callback method + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getFileAsync(fileType: FileType, options?: any, callback?: (result: AsyncResult) => void): void; /** * Gets file properties of the current document. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getFilePropertiesAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -1030,27 +1031,27 @@ declare namespace Office { * @param options Syntax example: {valueFormat: 'formatted', filterType:'all'} * valueFormat: Get data with or without format. Use Office.ValueFormat or text value. * filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value. - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getSelectedDataAsync(coercionType: CoercionType, options?: any, callback?: (result: AsyncResult) => void): void; /** * Goes to the specified object or location in the document. * @param id The identifier of the object or location to go to. * @param goToType The type of the location to go to. - * @param options Syntax example: {asyncContext:context} + * @param options Syntax example: {selectionMode:Office.SelectionMode.Selected} * selectionMode: Use Office.SelectionMode or text value. - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ goToByIdAsync(id: string | number, goToType: GoToType, options?: any, callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for the specified event type. * @param eventType The event type. For document can be 'DocumentSelectionChanged' * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. * handler: The name of the handler. If not specified all handlers are removed - * @param callback The optional callback method + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ removeHandlerAsync(eventType: EventType, options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -1058,8 +1059,8 @@ declare namespace Office { * @param data The data to be set. Either a string or value, 2d array or TableData object * @param options Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'} * coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type. - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ setSelectedDataAsync(data: string | TableData | any[][], options?: any, callback?: (result: AsyncResult) => void): void; } @@ -1103,7 +1104,7 @@ declare namespace Office { * 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. * * Hosts: PowerPoint, Word - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional. * @remarks * 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. * In the callback function passed to the closeAsync method, you can use the properties of the AsyncResult object to return the following information. @@ -1112,7 +1113,7 @@ declare namespace Office { * |AsyncResult.value|Always returns undefined because there is no object or data to retrieve.| * |AsyncResult.status|Determine the success or failure of the operation.| * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|Access your user-defined object or value, if you passed one as the asyncContext parameter.| + * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| */ closeAsync(callback?: (result: AsyncResult) => void): void; /** @@ -1120,7 +1121,7 @@ declare namespace Office { * @remarks * Hosts: PowerPoint, Word * @param sliceIndex Specifies the zero-based index of the slice to be retrieved. Required. - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional. * @remarks * 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. * In the callback function passed to the getSliceAsync method, you can use the properties of the AsyncResult object to return the following information. @@ -1129,7 +1130,7 @@ declare namespace Office { * |AsyncResult.value|Access the Slice object.| * |AsyncResult.status|Determine the success or failure of the operation.| * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|Access your user-defined object or value, if you passed one as the asyncContext parameter.| + * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| */ getSliceAsync(sliceIndex: number, callback?: (result: AsyncResult) => void): void; } @@ -1193,7 +1194,7 @@ declare namespace Office { * @param handler The event handler function to add. Required. * @param options Specifies any of the following optional parameters. * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. * @remarks * 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. * In the callback function passed to the addHandlerAsync method, you can use the properties of the AsyncResult object to return the following information. @@ -1202,7 +1203,7 @@ declare namespace Office { * |AsyncResult.value|Always returns undefined because there is no data or object to retrieve when adding an event handler.| * |AsyncResult.status|Determine the success or failure of the operation.| * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|Access your user-defined object or value, if you passed one as the asyncContext parameter.| + * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| */ addHandlerAsync(eventType: EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -1220,7 +1221,7 @@ declare namespace Office { * The refreshAsync method can be called from add-ins created for Excel, but since it doesn't support coauthoring there is no reason to do so. * * Hosts: Access, Excel, PowerPoint, Word - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. * @remarks * 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. * In the callback function passed to the refreshAsync method, you can use the properties of the AsyncResult object to return the following information. @@ -1229,7 +1230,7 @@ declare namespace Office { * |AsyncResult.value|Access a Settings object with the refreshed values.| * |AsyncResult.status|Determine the success or failure of the operation.| * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|Access your user-defined object or value, if you passed one as the asyncContext parameter.| + * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| */ refreshAsync(callback?: (result: AsyncResult) => void): void; /** @@ -1253,7 +1254,7 @@ declare namespace Office { * @param options Specifies any of the following optional parameters. * @param handler Specifies the name of the handler to remove. * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. * @remarks * 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. * In the callback function passed to the removeHandlerAsync method, you can use the properties of the AsyncResult object to return the following information. @@ -1271,8 +1272,8 @@ declare namespace Office { * Hosts: Access, Excel, PowerPoint, Word * @param options Syntax example: {overwriteIfStale:false} * @param overwriteIfStale Indicates whether the setting will be replaced if stale. - * asyncContext: Object keeping state for the callback - * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional. + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional. * @remarks * 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. * In the callback function passed to the saveAsync method, you can use the properties of the AsyncResult object to return the following information. @@ -1281,7 +1282,7 @@ declare namespace Office { * |AsyncResult.value|Always returns undefined because there is no object or data to retrieve.| * |AsyncResult.status|Determine the success or failure of the operation.| * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|Access your user-defined object or value, if you passed one as the asyncContext parameter.| + * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| */ saveAsync(callback?: (result: AsyncResult) => void): void; /** @@ -1335,30 +1336,30 @@ declare namespace Office { * Adds the specified columns to the table * @param tableData A TableData object with the headers and rows * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addColumnsAsync(tableData: TableData | any[][], options?: any, callback?: (result: AsyncResult) => void): void; /** * Adds the specified rows to the table * @param rows A 2D array with the rows to add * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ addRowsAsync(rows: TableData | any[][], options?: any, callback?: (result: AsyncResult) => void): void; /** * Clears the table * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ deleteAllDataValuesAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Clears formatting on the bound table. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ clearFormatsAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -1366,8 +1367,8 @@ declare namespace Office { * @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from. * @param formats An array specifying the format properties to get. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getFormatsAsync(cellReference?: any, formats?: any[], options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -1377,16 +1378,16 @@ declare namespace Office { * type: The kind of item to format. String. * formats: An object literal containing a list of property name-value pairs that define the formatting to apply. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ setFormatsAsync(formatsInfo?: any[], options?: any, callback?: (result: AsyncResult) => void): void; /** * Updates table formatting options on the bound table. * @param tableOptions An object literal containing a list of property name-value pairs that define the table options to apply. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ setTableOptionsAsync(tableOptions: any, options?: any, callback?: (result: AsyncResult) => void): void; } @@ -3535,8 +3536,8 @@ declare namespace Office { * Get Project field (Ex. ProjectWebAccessURL). * @param fieldId Project level fields. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getProjectFieldAsync(fieldId: number, options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -3544,37 +3545,37 @@ declare namespace Office { * @param resourceId Either a string or value of the Resource Id. * @param fieldId Resource Fields. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getResourceFieldAsync(resourceId: string, fieldId: number, options?: any, callback?: (result: AsyncResult) => void): void; /** * Get the current selected Resource's Id. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getSelectedResourceAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Get the current selected Task's Id. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getSelectedTaskAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Get the current selected View Type (Ex. Gantt) and View Name. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getSelectedViewAsync(options?: any, callback?: (result: AsyncResult) => void): void; /** * Get the Task Name, WSS Task Id, and ResourceNames for given taskId. * @param taskId Either a string or value of the Task Id. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getTaskAsync(taskId: string, options?: any, callback?: (result: AsyncResult) => void): void; /** @@ -3582,15 +3583,15 @@ declare namespace Office { * @param taskId Either a string or value of the Task Id. * @param fieldId Task Fields. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getTaskFieldAsync(taskId: string, fieldId: number, options?: any, callback?: (result: AsyncResult) => void): void; /** * Get the WSS Url and list name for the Tasks List, the MPP is synced too. * @param options Syntax example: {asyncContext:context} - * asyncContext: Object keeping state for the callback - * @param callback The optional callback method + * asyncContext: A user-defined item of any type that is returned in the AsyncResult object without being altered. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. */ getWSSUrlAsync(options?: any, callback?: (result: AsyncResult) => void): void; }