Ewa.EwaControl.add_workbookChanged(function)

Applies to: apps for SharePoint | SharePoint Server 2010

In this article
Return Value
Remarks
Example

Subscribes an event handler to the workbookChanged event.

Ewa.EwaControl.add_workbookChanged(function);

Parameters

function

The event handler to subscribe to the event.

Return Value

None.

Remarks

The EwaControl.add_workbookChanged method subscribes an event handler to the workbookChanged event. The workbookChanged event is raised when the workbook is changed, including when the workbook is reloaded.

When the specified event handler for the workbookChanged event is invoked, it is invoked with a single argument of type Ewa.WorkbookEventArgs. The Ewa.WorkbookEventArgs object contains information about the workbook associated with the gridSynchronized event.

Example

The following code example shows how to subscribe an event handler to the workbookChanged event that uses the Ewa.WorkbookEventArgs to display the path of the associated workbook in an alert message.

<script type="text/javascript">
var ewa = null;

// Add event handler for onload event.
if (window.attachEvent) 
{ 
    window.attachEvent("onload", ewaOmPageLoad);    
} 
else 
{ 
    window.addEventListener("DOMContentLoaded", ewaOmPageLoad, false); 
}
// Add event handler for applicationReady event.
function ewaOnPageLoad()
{
    if (typeof (Ewa) != "undefined")
    {
        Ewa.EwaControl.add_applicationReady(ewaApplicationReady);
    }
    else
    {
        alert("Error - the EWA JS is not loaded.");
    }
}

function ewaApplicationReady()
{
    ewa = Ewa.EwaControl.getInstances().getItem(0);

    // Add event handler for workbookChanged event.
    ewa.add_workbookChanged(wkbookChanged);

}

function wkbookChanged(args)
{
    alert("The Workbook has changed.");
}
</script>

See Also

Reference

Ewa.EwaControl.remove_workbookChanged(function)

Ewa.EwaControl Object