aspose.cells
Class Range

function getHyperlinks()

Gets all hyperlink in the range.

function getRowCount()

Gets the count of rows in the range.

function getColumnCount()

Gets the count of columns in the range.

function getCellCount()

Gets all cell count in the range.

function getName() / function setName(value)

Gets or sets the name of the range.

Named range is supported. For example,

range.Name = "Sheet1!MyRange";

function getRefersTo()

Gets the range's refers to.

function getAddress()

Gets address of the range.

function getFirstRow()

Gets the index of the first row of the range.

function getFirstColumn()

Gets the index of the first column of the range.

function getValue() / function setValue(value)

Gets and sets the value of the range.

If the range contains multiple cells, return a two-dimension System.Array object. If applies object array to the range, it should be a two-dimension System.Array object.

function getColumnWidth() / function setColumnWidth(value)

Sets or gets the column width of this range

function getRowHeight() / function setRowHeight(value)

Sets or gets the height of rows in this range

function getEntireColumn()

Gets a Range object that represents the entire column (or columns) that contains the specified range.

function getEntireRow()

Gets a Range object that represents the entire row (or rows) that contains the specified range.

function getWorksheet()

Gets the Worksheetobject which contains this range.

function get(rowOffset, columnOffset)

Gets Cell object in this range.

Parameters:

rowOffset - Row offset in this range, zero based.

columnOffset - Column offset in this range, zero based.

Returns:

Cell object.

function iterator()

Gets the enumerator for cells in this Range.

When traversing elements by the returned Enumerator, the cells collection should not be modified(such as operations that will cause new Cell/Row be instantiated or existing Cell/Row be deleted). Otherwise the enumerator may not be able to traverse all cells correctly(some elements may be traversed repeatedly or skipped).

Returns:

The cells enumerator

function isIntersect(range)

Indicates whether the range is intersect.

If the two rangs area not in the same worksheet ,return false.

Parameters:

range: Range - The range.

Returns:

Whether the range is intersect.

function intersect(range)

Returns a Range object that represents the rectangular intersection of two ranges.

If the two ranges are not intersected, returns null.

Parameters:

range: Range - The intersecting range.

Returns:

a Range object

function union(range)

Returns the union of two ranges.

Parameters:

range: Range - The range

Returns:

The union of two ranges.

function merge()

Combines a range of cells into a single cell.

Reference the merged cell via the address of the upper-left cell in the range.

function unMerge()

Unmerges merged cells of this range.

function putValue(stringValue, isConverted, setStyle)

Puts a value into the range, if appropriate the value will be converted to other data type and cell's number format will be reset.

Parameters:

stringValue: String - Input value

isConverted: boolean - True: converted to other data type if appropriate.

setStyle: boolean - True: set the number format to cell's style when converting to other data type

function applyStyle(style, flag)

Applies formats for a whole range.

Each cell in this range will contains a Style object. So this is a memory-consuming method. Please use it carefully.

Parameters:

style: Style - The style object which will be applied.

flag: StyleFlag - Flags which indicates applied formatting properties.

function setStyle(style)

Sets the style of the range.

Parameters:

style: Style - The Style object.

function setOutlineBorders(borderStyle, borderColor)

Sets the outline borders around a range of cells with same border style and color.

Parameters:

borderStyle: Number - A CellBorderType value. Border style.

borderColor: Color - Border color.

function setOutlineBorders(borderStyles, borderColors)

Sets out line borders around a range of cells.

Both the length of borderStyles and borderStyles must be 4. The order of of borderStyles and borderStyles must be top,bottom,left,right

Parameters:

borderStyles: Number Array - Border styles.

borderColors: Color[] - Border colors.

function setOutlineBorder(borderEdge, borderStyle, borderColor)

Sets outline border around a range of cells.

Parameters:

borderEdge: Number - A BorderType value. Border edge.

borderStyle: Number - A CellBorderType value. Border style.

borderColor: Color - Border color.

function moveTo(destRow, destColumn)

Move the current range to the dest range.

Parameters:

destRow: Number - The start row of the dest range.

destColumn: Number - The start column of the dest range.

function copyData(range)

Copies cell data (including formulas) from a source range.

Parameters:

range: Range - Source Range object.

function copyValue(range)

Copies cell value from a source range.

Parameters:

range: Range - Source Range object.

function copyStyle(range)

Copies style settings from a source range.

Parameters:

range: Range - Source Range object.

function copy(range, options)

Copying the range with paste special options.

Parameters:

range: Range - The soure range.

options: PasteOptions - The paste special options.

function copy(range)

Copies data (including formulas), formatting, drawing objects etc. from a source range.

Parameters:

range: Range - Source Range object.

function getCellOrNull(rowOffset, columnOffset)

Gets Cell object or null in this range.

Parameters:

rowOffset: Number - Row offset in this range, zero based.

columnOffset: Number - Column offset in this range, zero based.

Returns:

Cell object.

function getOffset(rowOffset, columnOffset)

Gets Range range by offset.

Parameters:

rowOffset: Number - Row offset in this range, zero based.

columnOffset: Number - Column offset in this range, zero based.

Returns:

function toString()

Returns a string represents the current Range object.

Returns: