Ewa.Range Object

Applies to: apps for SharePoint | SharePoint Server 2010

Represents a range in a workbook.

Ewa.Range

Remarks

The range object describes a range in terms of R1C1 coordinates. For example, the "B3:D7" range is equivalent to row = 2, column = 1, rowCount =5, columnCount = 3. The single cell range "A1" is equivalent to row = 0, column = 0, rowCount = 1, columnCount = 1. rowCount and columnCount must be greater than or equal to 1.

You can obtain a range object in several ways. The following sections list the different objects and associated methods that return a Range object.

EwaControl

The following table lists the EwaControl events that return a Range object (through the RangeEventArgs object).

Table 1. Ewa.EwaControl Events that return a Range object

Event

Return Type

Method Execution

activeCellChanged

RangeEventArgs (returns a Range using Ewa.RangeEventArgs.getRange())

Synchronous

activeSelectionChanged

RangeEventArgs (returns a Range using Ewa.RangeEventArgs.getRange())

Synchronous

enteredCellEditing

RangeEventArgs (returns a Range using Ewa.RangeEventArgs.getRange())

Synchronous

Workbook

The following table lists the Workbook methods that return a Range object.

Table 2. Workbook methods that return a Range object

Method

Return Type

Method Execution

Ewa.Workbook.getActiveCell()

Range

Synchronous

Ewa.Workbook.getActiveSelection()

Range

Synchronous

Ewa.Workbook.getRange(parentName, firstRow, firstColumn, rowCount, columnCount)

Range

Synchronous

Ewa.Workbook.getRangeA1Async(addressA1, callback, userContext)

AsyncResult (returns a Range using Ewa.AsyncResult.getReturnValue())

Asynchronous

Sheet

The following table lists the Sheet methods that return a Range object.

Table 3. Sheet methods that return a Range object

Method

Return Type

Method Execution

Ewa.Sheet.getRange(firstRow, firstColumn, rowCount, columnCount)

Range

Synchronous

Ewa.Sheet.getRangeA1Async(addressA1, callback, userContext)

AsyncResult (returns a Range using Ewa.AsyncResult.getReturnValue())

Asynchronous

NamedItem

The following table lists the NamedItem methods that return a Range object.

Table 4. NamedItem methods that return a Range object

Method

Return Type

Method Execution

Ewa.NamedItem.getRefersToRangeAsync(callback, userContext)

AsyncResult (returns a Range using Ewa.AsyncResult.getReturnValue())

Asynchronous

Example

To see examples that show how to get a Range object, use the links in the tables in this topic.

See Also

Concepts

Ewa.Range Methods