Export (0) Print
Expand All

TableBinding.setTableOptionsAsync method (JavaScript API for Office)

apps for Office

Updates table formatting options on the bound table.

Last modified: March 03, 2015

Hosts:

Excel

Available in Requirement set

Not in a set

Added in

1.1

See all support details

bindingObj.setTableOptionsAsync(tableOptions [,options] , callback);

Name

Type

Description

Support notes

tableOptions

object

An object literal containing a list of property name-value pairs that define the table options to apply. Required.

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.

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 setting table options.

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:

  • Create an object literal that specifies the table formatting options to update on the bound table.

  • Call setTableOptions on a previously bound table (with an id of myBinding) passing the object with formatting settin as the tableOptions parameter.

function updateTableFormatting(){
    var tableOptions = {bandedRows: true, filterButton: false, style: "TableStyleMedium3"}; 

    Office.select("bindings#myBinding").setTableOptionsAsync(tableOptions, function(asyncResult){});
}

A checkmark (√) 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 apps for Office.

Supported hosts, by platform

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

Excel

Available in requirement sets

Not in a set.

Minimum permission level

WriteDocument

App types

Content, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Introduced

Show:
© 2015 Microsoft