aspose.cells

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.

• isEntireRow : boolean 

  function isEntireRow()
  

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

• isEntireColumn : boolean 

  function isEntireColumn()
  

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

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

• getValues

  function getValues(calculateFormulas)

  Gets cell values in this area.

  Parameters:

  calculateFormulas: boolean - 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

  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.

• getValue

  function getValue(rowOffset, colOffset, calculateFormulas)

  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

  calculateFormulas: boolean - 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

  function 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".

  Returns:

  the reference address of this area.