aspose.cells

Class ReferredArea

Represents a referred area by the formula.

Property Getters/Setters Summary
functiongetEndColumn()
The end column of the area.
functiongetEndRow()
The end row of the area.
functiongetExternalFileName()
Get the external file name if this is an external reference.
functionisArea()
Indicates whether this is an area.
functionisExternalLink()
Indicates whether this is an external link.
functiongetSheetName()
Indicates which sheet this reference is in.
functiongetStartColumn()
The start column of the area.
functiongetStartRow()
The start row of the area.
 
Method Summary
functiongetValue(rowOffset, colOffset)
Gets cell value with given offset from the top-left of this area.
functiongetValues()
Gets cell values in this area.
functiontoString()
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.
        Returns: