Range

Range class

Encapsulates the object that represents a range of cells within a spreadsheet.

Properties

Name	Type	Description
CurrentRegion	Range	Returns a Range object that represents the current region. The current region is a range bounded by any combination of b
Hyperlinks	Hyperlink[]	Gets all hyperlink in the range.
RowCount	int	Gets the count of rows in the range.
ColumnCount	int	Gets the count of columns in the range.
Name	String	Gets or sets the name of the range. Named range is supported. For example, range.Name = “Sheet1!MyRange”;
RefersTo	String	Gets the range’s refers to.
Address	String	Gets address of the range.
Left	float	Gets the distance, in points, from the left edge of column A to the left edge of the range.
Top	float	Gets the distance, in points, from the top edge of row 1 to the top edge of the range.
Width	float	Gets the width of a range in points.
Height	float	Gets the width of a range in points.
FirstRow	int	Gets the index of the first row of the range.
FirstColumn	int	Gets the index of the first column of the range.
Value	Object	Gets and sets the value of the range. If the range contains multiple cells, the returned/applied object should be Object
ColumnWidth	float	Sets or gets the column width of this range
RowHeight	float	Sets or gets the height of rows in this range
EntireColumn	Range	Gets a Range object that represents the entire column (or columns) that contains the specified range.
EntireRow	Range	Gets a Range object that represents the entire row (or rows) that contains the specified range.
Worksheet	Worksheet	Gets the Worksheet object which contains this range.
Item (int, int)	Cell	Gets Cell object in this range.

Methods

Name	Description
autoFill	Automaticall fill the target range.
addHyperlink	Adds a hyperlink to a specified cell or a range of cells.
iterator	Gets the enumerator for cells in this Range.

When traversing elements by the returned Enumerator, the cells collection | | isIntersect | Indicates whether the range is intersect.

If the two ranges area not in the same worksheet ,return false. | | intersect | Returns a Range object that represents the rectangular intersection of two ranges.

If the two ranges are not intersecte | | unionRang | Returns the union result of two ranges.

NOTE: This method is now obsolete. Instead, please use Range.UnionRanges() meth | | unionRanges | Returns the union result of two ranges. | | union | Returns the union of two ranges.

NOTE: This method is now obsolete. Instead, please use Range.UnionRanges() method. Thi | | isBlank | Indicates whether the range contains values. | | merge | Combines a range of cells into a single cell.

Reference the merged cell via the address of the upper-left cell in the r | | unMerge | Unmerges merged cells of this range. | | putValue | Puts a value into the range, if appropriate the value will be converted to other data type and cell’s number format will | | setStyle | Apply the cell style. | | applyStyle | Applies formats for a whole range.

Each cell in this range will contains a Style object. So this is a memory-consuming | | setOutlineBorders | Sets the outline borders around a range of cells with same border style and color. | | setOutlineBorder | Sets outline border around a range of cells. | | setInsideBorders | Set inside borders of the range. | | moveTo | Move the current range to the dest range. | | copyData | Copies cell data (including formulas) from a source range. | | copyValue | Copies cell value from a source range. | | copyStyle | Copies style settings from a source range. | | copy | Copying the range with paste special options. | | transpose | Transpose (rotate) data from rows to columns or vice versa. | | getCellOrNull | Gets Cell object or null in this range. | | getOffset | Gets Range range by offset. | | toString | Returns a string represents the current Range object. | | toImage | Converts the range to image. | | toJson | Convert the range to JSON value. | | toHtml | Convert the range to html . | | clear | | | clearContents | | | clearFormats | | | clearComments | | | clearHyperlinks | |

Range.CurrentRegion property

Returns a Range object that represents the current region. The current region is a range bounded by any combination of blank rows and blank columns.

Type: Range

Range.Hyperlinks property

Gets all hyperlink in the range.

Type: Hyperlink[]

Range.RowCount property

Gets the count of rows in the range.

Type: int

Range.ColumnCount property

Gets the count of columns in the range.

Type: int

Range.Name property

Gets or sets the name of the range. Named range is supported. For example, range.Name = “Sheet1!MyRange”;

Type: String

Range.RefersTo property

Gets the range’s refers to.

Type: String

Range.Address property

Gets address of the range.

Type: String

Range.Left property

Gets the distance, in points, from the left edge of column A to the left edge of the range.

Type: float

Range.Top property

Gets the distance, in points, from the top edge of row 1 to the top edge of the range.

Type: float

Range.Width property

Gets the width of a range in points.

Type: float

Range.Height property

Gets the width of a range in points.

Type: float

Range.FirstRow property

Gets the index of the first row of the range.

Type: int

Range.FirstColumn property

Gets the index of the first column of the range.

Type: int

Range.Value property

Gets and sets the value of the range. If the range contains multiple cells, the returned/applied object should be Object[][].

Type: Object

Range.ColumnWidth property

Sets or gets the column width of this range

Type: float

Range.RowHeight property

Sets or gets the height of rows in this range

Type: float

Range.EntireColumn property

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

Type: Range

Range.EntireRow property

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

Type: Range

Range.Worksheet property

Gets the Worksheet object which contains this range.

Type: Worksheet

Range.Item (int, int) property

Gets Cell object in this range.

Type: Cell

autoFill(target) (1 of 2)

Automaticall fill the target range.

Parameter	Type	Description
target	Range	the target range.

---

autoFill(target, autoFillType) (2 of 2)

Automaticall fill the target range.

Parameter	Type	Description
target	Range	The targed range.
autoFillType	int	A AutoFillType value. The auto fill type.

addHyperlink(address, textToDisplay, screenTip)

Adds a hyperlink to a specified cell or a range of cells.

Parameter	Type	Description
address	String	Address of the hyperlink.
textToDisplay	String	The text to be displayed for the specified hyperlink.
screenTip	String	The screenTip text for the specified hyperlink.

Returns: Hyperlink object.

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

isIntersect(range)

Indicates whether the range is intersect.

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

Parameter	Type	Description
range	Range	The range.

Returns: Whether the range is intersect.

intersect(range)

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

If the two ranges are not intersected, returns null.

Parameter	Type	Description
range	Range	The intersecting range.

Returns: Returns a Range object

unionRang(range)

Returns the union result of two ranges.

NOTE: This method is now obsolete. Instead, please use Range.UnionRanges() method. This method will be removed 12 months later since May 2024. Aspose apologizes for any inconvenience you may have experienced.

Parameter	Type	Description
range	Range	The range

Returns: The union of two ranges.

unionRanges(ranges)

Returns the union result of two ranges.

Parameter	Type	Description
ranges	Range[]	The range

Returns: The union of two ranges.

union(range)

Returns the union of two ranges.

NOTE: This method is now obsolete. Instead, please use Range.UnionRanges() method. This method will be removed 12 months later since November 2023. Aspose apologizes for any inconvenience you may have experienced.

Parameter	Type	Description
range	Range	The range

Returns: The union of two ranges.

isBlank()

Indicates whether the range contains values.

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.

unMerge()

Unmerges merged cells of this range.

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.

Parameter	Type	Description
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

setStyle(style, explicitFlag) (1 of 2)

Apply the cell style.

Parameter	Type	Description
style	Style	The cell style.
explicitFlag	boolean	True, only overwriting formatting which is explicitly set.

---

setStyle(style) (2 of 2)

Sets the style of the range.

Parameter	Type	Description
style	Style	The Style object.

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.

Parameter	Type	Description
style	Style	The style object which will be applied.
flag	StyleFlag	Flags which indicates applied formatting properties.

setOutlineBorders(borderStyle, borderColor) (1 of 3)

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

Parameter	Type	Description
borderStyle	int	A CellBorderType value. Border style.
borderColor	CellsColor	Border color.

---

setOutlineBorders(borderStyle, borderColor) (2 of 3)

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

Parameter	Type	Description
borderStyle	int	A CellBorderType value. Border style.
borderColor	Color	Border color.

---

setOutlineBorders(borderStyles, borderColors) (3 of 3)

Sets out line borders around a range of cells.

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

Parameter	Type	Description
borderStyles	Number Array	Border styles.
borderColors	Color[]	Border colors.

setOutlineBorder(borderEdge, borderStyle, borderColor) (1 of 2)

Sets outline border around a range of cells.

Parameter	Type	Description
borderEdge	int	A BorderType value. Border edge.
borderStyle	int	A CellBorderType value. Border style.
borderColor	CellsColor	Border color.

---

setOutlineBorder(borderEdge, borderStyle, borderColor) (2 of 2)

Sets outline border around a range of cells.

Parameter	Type	Description
borderEdge	int	A BorderType value. Border edge.
borderStyle	int	A CellBorderType value. Border style.
borderColor	Color	Border color.

setInsideBorders(borderEdge, lineStyle, borderColor)

Set inside borders of the range.

Parameter	Type	Description
borderEdge	int	A BorderType value. Inside borde type, only can be BorderType.VERTICAL and BorderType.HORIZONTAL .
lineStyle	int	A CellBorderType value. The border style.
borderColor	CellsColor	The color of the border.

moveTo(destRow, destColumn)

Move the current range to the dest range.

Parameter	Type	Description
destRow	int	The start row of the dest range.
destColumn	int	The start column of the dest range.

copyData(range)

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

Parameter	Type	Description
range	Range	Source Range object.

copyValue(range)

Copies cell value from a source range.

Parameter	Type	Description
range	Range	Source Range object.

copyStyle(range)

Copies style settings from a source range.

Parameter	Type	Description
range	Range	Source Range object.

copy(range, options) (1 of 2)

Copying the range with paste special options.

Parameter	Type	Description
range	Range	The source range.
options	PasteOptions	The paste special options.

---

copy(range) (2 of 2)

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

Parameter	Type	Description
range	Range	Source Range object.

transpose()

Transpose (rotate) data from rows to columns or vice versa.

getCellOrNull(rowOffset, columnOffset)

Gets Cell object or null in this range.

Parameter	Type	Description
rowOffset	int	Row offset in this range, zero based.
columnOffset	int	Column offset in this range, zero based.

Returns: Cell object.

getOffset(rowOffset, columnOffset)

Gets Range range by offset.

Parameter	Type	Description
rowOffset	int	Row offset in this range, zero based.
columnOffset	int	Column offset in this range, zero based.

toString()

Returns a string represents the current Range object.

toImage(options)

Converts the range to image.

Parameter	Type	Description
options	ImageOrPrintOptions	The options for converting this range to image

toJson(options)

Convert the range to JSON value.

Parameter	Type	Description
options	JsonSaveOptions	The options of converting

toHtml(saveOptions)

Convert the range to html .

Parameter	Type	Description
saveOptions	HtmlSaveOptions	Options for coverting range to html.

clear()

clearContents()

clearFormats()

clearComments()

clearHyperlinks(clearFormat)