asposecells.api

Classes

Constants

asposecells.api

Class CellArea

Represent an area of cells.

Example:

# Create Cell Area
ca = CellArea()
ca.StartRow = 0
ca.EndRow = 0
ca.StartColumn = 0
ca.EndColumn = 0

Field Summary
`int`	`StartRow`
`int`	Gets or set the start row of this area.
`int`	`EndRow`
`int`	Gets or set the end row of this area.
`int`	`StartColumn`
`int`	Gets or set the start column of this area.
`int`	`EndColumn`
`int`	Gets or set the end column of this area.

Constructor Summary
`CellArea()`

Method Summary
`method`	`compareTo(obj)`
`method`	Compare two CellArea objects according to their top-left corner.
`static method`	`createCellArea(startRow, startColumn, endRow, endColumn)`
`static method`	Creates a cell area.
`static method`	`createCellArea(startCellName, endCellName)`
`static method`	Creates a cell area.
`method`	`toString()`
`method`	Returns a string represents the current cell area object.

- Field Detail
  - StartRow
```
int StartRow
```
    Gets or set the start row of this area.
  - EndRow
```
int EndRow
```
    Gets or set the end row of this area.
  - StartColumn
```
int StartColumn
```
    Gets or set the start column of this area.
  - EndColumn
```
int EndColumn
```
    Gets or set the end column of this area.
- Constructor Detail
  - CellArea
```
CellArea()
```
- Method Detail
  - compareTo
```
int 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
```
String toString()
```
    Returns a string represents the current cell area object.
    Returns:
  - createCellArea
```
static CellArea createCellArea(startRow, startColumn, endRow, endColumn)
```
    Creates a cell area.
    Parameters:
    startRow: int - The start row.
    startColumn: int - The start column.
    endRow: int - The end row.
    endColumn: int - The end column.
    Returns:
    Return a CellArea.
  - createCellArea
```
static CellArea 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.