getRange()

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

In this article
Return Value
Remarks
Example

Gets the Ewa.Range Objectassociated with a given rangeChange event.

var value = Ewa.RangeChangeEventArgs.getRange()

Return Value

Type: [Ewa.Range]

Remarks

The Ewa.RangeChangeEventArgs.getRange method returns the range that is associated with the range change event.

Example

The following code example subscribes an event handler to the dataEntered event. When the specified event handler for the dataEntered event is invoked, it is invoked with a single argument of type Ewa.RangeChangeEventArgs. The Ewa.RangeChangeEventArgs object contains information about the Ewa.Range object associated with the dataEntered event.

The code example then shows how to use the Ewa.RangeChangeEventArgs object to get information about the specified range. 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;

// Run the Excel load handler on page load
if (window.attachEvent) {
    window.attachEvent("onload", loadEwaOnPageLoad);
} else {
    window.addEventListener("DOMContentLoaded", loadEwaOnPageLoad, false);
}

// Event handler for page load event 
function loadEwaOnPageLoad() {
    if (typeof (Ewa) != "undefined") {
        // Retrieve workbook from SharePoint location when EWA is ready
        Ewa.EwaControl.add_applicationReady(ewaApplicationReady);
    }
    else {
        alert("Error - the EWA is not loaded.");
    }
    // ...
}

function ewaApplicationReady() {
    // Get a reference to the EWA web part that represents the Ewa web part
    // in SharePoint:
    ewa = Ewa.EwaControl.getInstances().getItem(0);

    var sheets = ewa.getActiveWorkbook().getSheets();
    var sheet;

    // Add the event handler to every sheet in the workbook
    for (i = 0; i < sheets.getCount(); i++) {
        sheet = sheets.getItem(i);
        sheet.add_dataEntered(sheetDataEnteredHandler);
    }
}

function sheetDataEnteredHandler(rangeChangeArgs) {
    var sheetName = rangeChangeArgs.getRange().getSheet().getName();
    var col = rangeChangeArgs.getRange().getColumn();
    var row = rangeChangeArgs.getRange().getRow();
         // Get the formatted value 
    var value = rangeChangeArgs.getFormattedValues();
    alert("The range was located at row " + (row + 1) + " and column " + (col + 1) + " with value " + "\"" + value + "\"" + ".");
}
</script> 

See also

Reference

Ewa.RangeChangeEventArgs Object

Ewa.Range Object

Ewa.Sheet.add_dataEntered(function)