All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aspose.cells.ReferredArea.html Maven / Gradle / Ivy

There is a newer version: 23.1
Show newest version





ReferredArea




com.aspose.cells
Class ReferredArea

java.lang.Object
    extended by com.aspose.cells.ReferredArea

public class ReferredArea 
extends java.lang.Object

Represents a referred area by the formula.


Property Getters/Setters Summary
intgetEndColumn()
           The end column of the area.
intgetEndRow()
           The end row of the area.
java.lang.StringgetExternalFileName()
           Get the external file name if this is an external reference.
booleanisArea()
           Indicates whether this is an area.
booleanisExternalLink()
           Indicates whether this is an external link.
java.lang.StringgetSheetName()
           Indicates which sheet this reference is in.
intgetStartColumn()
           The start column of the area.
intgetStartRow()
           The start row of the area.
 
Method Summary
java.lang.ObjectgetValue(int rowOffset, int colOffset)
           Gets cell value with given offset from the top-left of this area.
java.lang.ObjectgetValue(int rowOffset, int colOffset, boolean calculateFormulas)
           Gets cell value with given offset from the top-left of this area.
java.lang.ObjectgetValues()
           Gets cell values in this area.
java.lang.ObjectgetValues(boolean calculateFormulas)
           Gets cell values in this area.
java.lang.StringtoString()
           Returns the simple string representation of this area.
 

Property Getters/Setters 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.

isArea

public boolean isArea()
Indicates whether this is an area. 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.

Method Detail

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 simple string representation of this area.
Returns:

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





© 2015 - 2024 Weber Informatics LLC | Privacy Policy