asposecells.api
Class ReferredArea

Represents a referred area by the formula.

Property Getters/Setters Summary
methodgetEndColumn()
           The end column of the area.
methodgetEndRow()
           The end row of the area.
methodgetExternalFileName()
           Get the external file name if this is an external reference.
methodisArea()
           Indicates whether this is an area.
methodisExternalLink()
           Indicates whether this is an external link.
methodgetSheetName()
           Indicates which sheet this reference is in.
methodgetStartColumn()
           The start column of the area.
methodgetStartRow()
           The start row of the area.
 
Method Summary
methodgetValue(rowOffset, colOffset)
           Gets cell value with given offset from the top-left of this area.
methodgetValues()
           Gets cell values in this area.
methodtoString()
           Returns the simple string representation of this area.
 

Property Getters/Setters Detail

isExternalLink : boolean 

boolean isExternalLink()
Indicates whether this is an external link.

getExternalFileName : String 

String getExternalFileName()
Get the external file name if this is an external reference.

getSheetName : String 

String getSheetName()
Indicates which sheet this reference is in.

isArea : boolean 

boolean isArea()
Indicates whether this is an area. If this is not an area, only StartRow and StartColumn effect.

getEndColumn : int 

int getEndColumn()
The end column of the area.

getStartColumn : int 

int getStartColumn()
The start column of the area.

getEndRow : int 

int getEndRow()
The end row of the area.

getStartRow : int 

int getStartRow()
The start row of the area.

Method Detail

getValues

Object 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

Object getValue(rowOffset, colOffset)
Gets cell value with given offset from the top-left of this area.
Parameters:
rowOffset: int - row offset from the start row of this area
colOffset: int - 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

String toString()
Returns the simple string representation of this area.
Returns:

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