ReferredArea

aspose.cells
Class ReferredArea

Represents a referred area by the formula.

Property Getters/Setters Summary
`function`	`getEndColumn()`
	The end column of the area.
`function`	`getEndRow()`
	The end row of the area.
`function`	`getExternalFileName()`
	Get the external file name if this is an external reference.
`function`	`isArea()`
	Indicates whether this is an area.
`function`	`isExternalLink()`
	Indicates whether this is an external link.
`function`	`getSheetName()`
	Indicates which sheet this reference is in.
`function`	`getStartColumn()`
	The start column of the area.
`function`	`getStartRow()`
	The start row of the area.

Method Summary
`function`	`getValue(rowOffset, colOffset)`
`function`	Gets cell value with given offset from the top-left of this area.
`function`	`getValues()`
`function`	Gets cell values in this area.
`function`	`toString()`
`function`	Returns the simple string representation of this area.

Property Getters/Setters Detail

isExternalLink : boolean
function isExternalLink()

Indicates whether this is an external link.

getExternalFileName : String
function getExternalFileName()

Get the external file name if this is an external reference.

getSheetName : String
function getSheetName()

Indicates which sheet this reference is in.

isArea : boolean
function isArea()

Indicates whether this is an area.

If this is not an area, only StartRow and StartColumn effect.

getEndColumn : Number
function getEndColumn()

The end column of the area.

getStartColumn : Number
function getStartColumn()

The start column of the area.

getEndRow : Number
function getEndRow()

The end row of the area.

getStartRow : Number
function getStartRow()

The start row of the area.

Method Detail

getValues
function getValues()

Gets cell values in this area.

Returns:: If this area is invalid, "#REF!" will be returned; If this area is one single cell, then return the cell value object; Otherwise return one 2D array for all values in this area.

getValue
function getValue(rowOffset, colOffset)

Gets cell value with given offset from the top-left of this area.

Parameters:: rowOffset: Number - row offset from the start row of this area; colOffset: Number - column offset from the start row of this area

Returns:: "#REF!" if this area is invalid; "#N/A" if given offset out of this area; Otherwise return the cell value at given position.

toString
function toString()

Returns the simple string representation of this area.

See Also:
Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.