Ewa.Workbook.recalcAsync(callback, userContext)

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

In this article
Return Value
Remarks
Example

Calculates the workbook.

Ewa.Workbook.recalcAsync(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.recalcAsync] calculates the specified workbook. [Ewa.Workbook.recalcAsync] has the same effect as calculating the workbook.

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 recalculates the workbook and then displays the success of the recalculation 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 recalcAsyncButton()
{
    // Recalculate workbook.
    ewa.getActiveWorkbook().recalcAsync(recalcAsyncCallBack);
}     

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

</script>
<input type="button" id="RecalcWorkbook" value="Calculate Workbook" onclick="recalcAsyncButton()" />

See also

Reference

Ewa.Workbook Object