Export (0) Print
Expand All

TableBinding.clearFormatsAsync method (JavaScript API for Office v1.1)

JavaScript API for Office v1.1

Clears formatting on the bound table.

Last modified: June 12, 2014

Introduced in Office.js version

1.1

Available in requirement sets

Not in a set

bindingObj.clearFormatsAsync([,options] , callback);

options

Type: object

Specifies the following optional parameters.

asyncContext

Type: 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. Optional.

callback

Type: function

A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional.

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.

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

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

App types

Content apps, Task pane apps

Supported clients

Excel 2013 SP1, Excel 2013 RT

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft