Binding.getDataAsync method

Returns the data contained within the binding.

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

Parameters

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

Remarks

If an optional parameter is omitted, the following default value is used (when applicable to type and format of the data).

When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow, startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range).

Example

function showBindingData() {
    Office.select("bindings#MyBinding").getDataAsync(function (asyncResult) {
        write(asyncResult.value)
    });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

There is an important difference in behavior between using the "table" and "matrix" coercionType with the Binding.getDataAsync method, with respect to data formatted with header rows, as shown in the following two examples. These code examples show event handler functions for the Binding.SelectionChanged event.

If you specify the "table" coercionType, the TableData.rows property ( result.value.rows in the following code example) returns an array that contains only the body rows of the table. So, its 0th row will be the first non-header row in the table.

function selectionChanged(evtArgs) { 
    Office.select("bindings#TableTranslate").getDataAsync({ coercionType: 'table', startRow: evtArgs.startRow, startCol: 0, rowCount: 1, columnCount: 1 },  
        function (result) { 
            if (result.status == 'succeeded') { 
                write("Image to find: " + result.value.rows[0][0]); 
            } 
            else 
                write(result.error.message); 
    }); 
}     
// Function that writes to a div with id='message' on the page. 
function write(message){ 
    document.getElementById('message').innerText += message; 
}

However, if you specify the "matrix" coercionType, result.value in the following code example returns an array that contains the table header in the 0th row. If the table header contains multiple rows, then these are all included in the result.value matrix as separate rows before the table body rows are included.

function selectionChanged(evtArgs) { 
    Office.select("bindings#TableTranslate").getDataAsync({ coercionType: 'matrix', startRow: evtArgs.startRow, startCol: 0, rowCount: 1, columnCount: 1 },  
        function (result) { 
            if (result.status == 'succeeded') { 
                write("Image to find: " + result.value[1][0]); 
            } 
            else 
                write(result.error.message); 
    }); 
}     
// Function that writes to a div with id='message' on the page. 
function write(message){ 
    document.getElementById('message').innerText += message; 
}

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

Support history

See also

Other resources

Bind to regions in a document or spreadsheet