Docs API Reference

TableBinding.addRowsAsync method

Adds rows and values to a table.

Hosts: Access, Excel, Word
Available in Requirement set TableBindings
Last changed in 1.1
bindingObj.addRowsAsync(rows, [,options], callback);

Parameters

rows
    Type: Array

    An array of arrays that contains one or more rows of data to add to the table. Required.

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: object

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

Name Type Description Support notes
rows array An array of arrays that contains one or more rows of data to add to the table. 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.

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 addRowsAsync 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 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.

Remarks

The success or failure of an addRowsAsync operation is atomic. That is, the entire add rows operation must succeed, or it will be completely rolled back (and the AsyncResult.status property returned to the callback will report failure):

  • Each row in the array you pass as the data argument must have the same number of columns as the table being updated. If not, the entire operation will fail.

  • Each row and cell in the array must successfully add that row and cell to the table in the newly added row(s). If any row or cell fails to be set for any reason, the entire operation will fail.

Additional remarks for Excel Online

The total number of cells in the value passed to the rows parameter can't exceed 20,000 in a single call to this method.

Example

function addRowsToTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        var binding = asyncResult.value;
        binding.addRowsAsync([["6", "k"], ["7", "j"]]);
    });
}

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
Access Y
Excel Y Y Y
Word Y Y Y
Available in requirement sets TableBindings
Minimum permission level ReadWriteDocument
Add-in types Content, task pane
Library Office.js
Namespace Office

Support history

Version Changes
1.1 Added support for Excel and Word in Office for iPad
1.1 Added support for writing table data in add-ins for Access.
1.0 Introduced