com.aspose.cells
Class Range

java.lang.Object
    com.aspose.cells.Range

Direct Known Subclasses:

RangeImp

public abstract class Range 
extends java.lang.Object

public abstract int getRowCount()

Gets the count of rows in the range.

public abstract int getColumnCount()

Gets the count of columns in the range.

public abstract java.lang.String getName() / public abstract void setName(java.lang.String value)

Gets or sets the name of the range.

Named range is supported. For example,

range.Name = "Sheet1!MyRange";

public abstract java.lang.String getRefersTo()

Gets the range's refers to.

public abstract int getFirstRow()

Gets the index of the first row of the range.

public abstract int getFirstColumn()

Gets the index of the first column of the range.

public abstract java.lang.Object getValue() / public abstract void setValue(java.lang.Object value)

Gets and sets the value of the range.

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

public abstract double getColumnWidth() / public abstract void setColumnWidth(double value)

Sets or gets the column width of this range

public abstract double getRowHeight() / public abstract void setRowHeight(double value)

Sets or gets the height of rows in this range

public abstract Worksheet getWorksheet()

Gets the Worksheetobject which contains this range.

public abstract Cell get(int rowIndex, int columnIndex)

Gets Cell object in this range.

Parameters:

rowIndex - Row index in this range, zero based.

columnIndex - Column index in this range, zero based.

Returns:

Cell object.

public abstract java.util.Iterator iterator()

Gets the cells enumerator

Returns:

The cells enumerator

public abstract boolean isIntersect(Range range)

Indicates whether the range is intersect.

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

Parameters:

range - The range.

Returns:

Whether the range is intersect.

public abstract Range intersect(Range range)

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

If the two ranges are not intersected, returns null.

Parameters:

range - The intersecting range.

Returns:

a Range object

public abstract java.util.ArrayList union(Range range)

Returns the union of two ranges.

Parameters:

range - The range

Returns:

The union of two ranges.

public abstract void 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.

public abstract void unMerge()

Unmerges merged cells of this range.

public abstract void putValue(java.lang.String stringValue, boolean isConverted, boolean 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 - Input value

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

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

public abstract void applyStyle(Style style, StyleFlag 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 - The style object which will be applied.

flag - Flags which indicates applied formatting properties.

public abstract void setStyle(Style style)

Sets the style of the range.

Parameters:

style - The Style object.

public abstract void setOutlineBorders(int borderStyle, Color borderColor)

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

Parameters:

borderStyle - A CellBorderType value. Border style.

borderColor - Border color.

public abstract void setOutlineBorders(int[] borderStyles, Color[] 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 - Border styles.

borderColors - Border colors.

public abstract void setOutlineBorder(int borderEdge, int borderStyle, Color borderColor)

Sets outline border around a range of cells.

Parameters:

borderEdge - A BorderType value. Border edge.

borderStyle - A CellBorderType value. Border style.

borderColor - Border color.

public abstract void moveTo(int destRow, int destColumn)

Move the current range to the dest range.

Parameters:

destRow - The start row of the dest range.

destColumn - The start column of the dest range.

public abstract void copyData(Range range)
                           throws java.lang.Exception

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

Parameters:

range - Source Range object.

public abstract void copyValue(Range range)
                            throws java.lang.Exception

Copies cell value from a source range.

Parameters:

range - Source Range object.

public abstract void copyStyle(Range range)

Copies style settings from a source range.

Parameters:

range - Source Range object.

public abstract void copy(Range range, PasteOptions options)
                       throws java.lang.Exception

Copying the range with paste special options.

Parameters:

range - The soure range.

options - The paste special options.

public abstract void copy(Range range)
                       throws java.lang.Exception

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

Parameters:

range - Source Range object.

public abstract Cell getCellOrNull(int rowIndex, int columnIndex)

Gets Cell object or null in this range.

Parameters:

rowIndex - Row index in this range, zero based.

columnIndex - Column index in this range, zero based.

Returns:

Cell object.