aspose.cells

aspose.cells

Class CellArea

Represent an area of cells.

Example:

//Create Cell Area
$ca = new cells\CellArea();
$ca->StartRow = 0;
$ca->EndRow = 0;
$ca->StartColumn = 0;
$ca->EndColumn = 0;

Field Summary
NumberStartRow
Gets or set the start row of this area.
NumberEndRow
Gets or set the end row of this area.
NumberStartColumn
Gets or set the start column of this area.
NumberEndColumn
Gets or set the end column of this area.
 
Constructor Summary
CellArea()
 
Method Summary
functioncompareTo(obj)
Compare two CellArea objects according to their top-left corner.
static functioncreateCellArea(startRow, startColumn, endRow, endColumn)
Creates a cell area.
static functioncreateCellArea(startCellName, endCellName)
Creates a cell area.
functiontoString()
Returns a string represents the current cell area object.
 

    • Field Detail

      • StartRow

        Number StartRow
        Gets or set the start row of this area.

      • EndRow

        Number EndRow
        Gets or set the end row of this area.

      • StartColumn

        Number StartColumn
        Gets or set the start column of this area.

      • EndColumn

        Number EndColumn
        Gets or set the end column of this area.

    • Constructor Detail

      • CellArea

        function CellArea()

    • Method Detail

      • compareTo

        function compareTo(obj)
        Compare two CellArea objects according to their top-left corner.
        Parameters:
        obj: Object -
        Returns:
        If two corners are in different rows, then compare their row index. Otherwise compare their column index. If two corners are same, then 0 will be returned.

      • toString

        function toString()
        Returns a string represents the current cell area object.
        Returns:

      • createCellArea

        static function createCellArea(startRow, startColumn, endRow, endColumn)
        Creates a cell area.
        Parameters:
        startRow: Number - The start row.
        startColumn: Number - The start column.
        endRow: Number - The end row.
        endColumn: Number - The end column.
        Returns:
        Return a CellArea.

      • createCellArea

        static function createCellArea(startCellName, endCellName)
        Creates a cell area.
        Parameters:
        startCellName: String - The top-left cell of the range.
        endCellName: String - The bottom-right cell of the range.
        Returns:
        Return a CellArea.