Share via


Ewa.Workbook.refreshAllAsync(callback, userContext)

Applies to: apps for SharePoint | Excel Services | SharePoint Server 2013

In this article
Return Value
Remarks
Example

Refreshes all data connections in the workbook.

Ewa.Workbook.refreshAllAsync(callback, userContext);

Parameters

callback

The function that is called when the request is complete.

userContext

An object provided as a way for callers to pass state through the asynchronous call.

Return Value

None.

Remarks

The [Ewa.Workbook.refreshAllAsync] method refreshes data from external data sources that are connected to the workbook. [Ewa.Workbook.refreshAllAsync] has the same effect as refreshing all data connections.

Important

If the workbook that is refreshed contains Power View sheets, the workbook will be refreshed but the callback specified in Ewa.Workbook.refreshAllAsync will not be called.

Example

The following code example shows how to add a button to the page and then adds an event handler to the button onClick event that refreshes all data connections for the workbook and then displays the success of the refresh operation in the browser status bar. The code example assumes that you are working with an Excel Web Access Web Part on SharePoint Server 2013.

<script type="text/javascript">
 
var ewa = null;
 
// Add event handler for onload event.
if (window.attachEvent) 
{ 
    window.attachEvent("onload", ewaOnPageLoad);    
} 
else 
{ 
    window.addEventListener("DOMContentLoaded", ewaOnPageLoad, false); 
}

// Add event handler for applicationReady event.
function ewaOnPageLoad() 
{ 
Ewa.EwaControl.add_applicationReady(onApplicationReady); 
} 

function onApplicationReady()
{        
    // Get a reference to the Excel Services Web Part.
    ewa = Ewa.EwaControl.getInstances().getItem(0);                                     
}  

function refreshAllAsyncButton()
{
    // Refresh all data connections.
    ewa.getActiveWorkbook().refreshAllAsync(refreshAllAsyncCallBack);
}     

function refreshAllAsyncCallBack(asyncResult)
{
    // Get the value from asyncResult if the asynchronous operation was successful.
    if (asyncResult.getCode() == 0)
    {
        // Display refresh success message.
        window.status = "Data connection refresh successful!";
    }
    else 
    {
         alert("Operation failed with error message " + asyncResult.getDescription() + ".");
    }    
} 

</script>
<input type="button" id="RefreshAllConns" value="Refresh Connections" onclick="refreshAllAsyncButton()" />

See also

Reference

Ewa.Workbook Object