TableBinding.clearFormatsAsync method

Clears formatting on the bound table.

Hosts: Excel
Available in Requirement set Not in a set
Added in 1.1
bindingObj.clearFormatsAsync([,options] , callback);

Parameters

Name Type Description Support notes
options object Specifies any of the following optional parameters
asyncContext array, boolean, null, number, object, string, or undefined A user-defined item of any type that is returned in the AsyncResult object without being altered.
callback object A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.

Callback Value

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 goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information.

Property Use to...
AsyncResult.value Always returns undefined because there is no data or object to retrieve when clearing formats.
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.

Remarks

See How to: Format tables in add-ins for Excel for more information.

Example

The following example shows how to clear the formatting of the bound table with an ID of "myBinding":

Office.select(bindings#myBinding).clearFormatsAsync();

Support details

A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Supported hosts, by platform

Office for Windows desktop Office Online (in browser) Office for iPad
Excel Y Y Y
Available in requirement sets Not in a set
Minimum permission level WriteDocument
Add-in types Content, task pane
Library Office.js
Namespace Office

Support history

Version Changes
1.1 Added support for Excel in Office for iPad.
1.0 Introduced