com.aspose.cells

Class ReferredArea

java.lang.Object

com.aspose.cells.ReferredArea

public class ReferredArea
extends java.lang.Object

Represents a referred area by the formula.

Method Summary

Methods

Modifier and Type	Method and Description
int	getEndColumn() The end column of the area.
int	getEndRow() The end row of the area.
java.lang.String	getExternalFileName() Get the external file name if this is an external reference.
java.lang.String	getSheetName() Indicates which sheet this reference is in.
java.lang.String[]	getSheetNames() Names of all the worksheets this instance references to.
int	getStartColumn() The start column of the area.
int	getStartRow() The start row of the area.
java.lang.Object	getValue(int rowOffset, int colOffset) Gets cell value with given offset from the top-left of this area.
java.lang.Object	getValue(int rowOffset, int colOffset, boolean calculateFormulas) Gets cell value with given offset from the top-left of this area.
java.lang.Object	getValues() Gets cell values in this area.
java.lang.Object	getValues(boolean calculateFormulas) Gets cell values in this area.
boolean	isArea() Indicates whether this is an area.
boolean	isEntireColumn() Indicates whether this area contains all rows(entire column).
boolean	isEntireRow() Indicates whether this area contains all columns(entire row).
boolean	isExternalLink() Indicates whether this is an external link.
java.lang.String	toString() Returns the reference address of this area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isExternalLink

public boolean isExternalLink()

Indicates whether this is an external link.

getExternalFileName

public java.lang.String getExternalFileName()

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

getSheetName

public java.lang.String getSheetName()

Indicates which sheet this reference is in.

Remarks

If it references to multiple worksheets, the returned value is just like the range expression in the formula. For example "Sheet1:Sheet3" for the reference in formula "=SUM(Sheet1:Sheet3!$A$1:$B$2)".

getSheetNames

public java.lang.String[] getSheetNames()

Names of all the worksheets this instance references to.

isEntireRow

public boolean isEntireRow()

Indicates whether this area contains all columns(entire row).

isEntireColumn

public boolean isEntireColumn()

Indicates whether this area contains all rows(entire column).

isArea

public boolean isArea()

Indicates whether this is an area.

Remarks

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

getEndColumn

public int getEndColumn()

The end column of the area.

getStartColumn

public int getStartColumn()

The start column of the area.

getEndRow

public int getEndRow()

The end row of the area.

getStartRow

public int getStartRow()

The start row of the area.

getValues

public java.lang.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.

getValues

public java.lang.Object getValues(boolean calculateFormulas)

Gets cell values in this area.

Parameters:

calculateFormulas - In this range, if there are some formulas that have not been calculated, this flag denotes whether those formulas should be calculated recursively

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

public java.lang.Object getValue(int rowOffset,
                        int colOffset)

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

Parameters:

rowOffset - row offset from the start row of this area

colOffset - 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.

getValue

public java.lang.Object getValue(int rowOffset,
                        int colOffset,
                        boolean calculateFormulas)

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

Parameters:

rowOffset - row offset from the start row of this area

colOffset - column offset from the start row of this area

calculateFormulas - Whether calculate it recursively if the specified reference is formula

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

public java.lang.String toString()

Returns the reference address of this area. Generally it is the address of the reference which may be used in formula, such as "Sheet1!A1:C3".

Overrides:

toString in class java.lang.Object

Returns:

the reference address of this area.