Range (Aspose.Cells for Java)

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

All Implemented Interfaces:: java.lang.Iterable

public class Range
extends java.lang.Object
implements java.lang.Iterable

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

Remarks

The Range class denotes a region of Excel spreadsheet. With this, you can format and set value of the range. And you can simply copy range of Excel too.

Example

The following example shows how to create a range and set value the range of Excel.

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         // Get the first Worksheet Cells.
         Cells cells = workbook.getWorksheets().get(0).getCells();
         // Create a range (A1:D3).
         Range range = cells.createRange("A1", "D3");
         // Set value to the range.
         range.setValue("Hello");
         //Save the Excel file
         workbook.save("book1.xlsm");

Method Summary

Methods
Modifier and Type	Method and Description
`Hyperlink`	`addHyperlink(java.lang.String address, java.lang.String textToDisplay, java.lang.String screenTip)` Adds a hyperlink to a specified cell or a range of cells.
`void`	`applyStyle(Style style, StyleFlag flag)` Applies formats for a whole range.
`void`	`autoFill(Range target)` Automaticall fill the target range.
`void`	`autoFill(Range target, int autoFillType)` Automaticall fill the target range.
`void`	`clear()` Clears this range.
`void`	`clearComments()` Clears the comments of this range.
`void`	`clearContents()` Clears the contents of this range.
`void`	`clearFormats()` Clears the formats of this range.
`void`	`clearHyperlinks(boolean clearFormat)` Only removes hyperlinks.
`void`	`copy(Range range)` Copies data (including formulas), formatting, drawing objects etc.
`void`	`copy(Range range, PasteOptions options)` Copying the range with paste special options.
`void`	`copyData(Range range)` Copies cell data (including formulas) from a source range.
`void`	`copyStyle(Range range)` Copies style settings from a source range.
`void`	`copyValue(Range range)` Copies cell value from a source range.
`Cell`	`get(int rowOffset, int columnOffset)` Gets `Cell` object in this range.
`java.lang.String`	`getAddress()` Gets address of the range.
`Cell`	`getCellOrNull(int rowOffset, int columnOffset)` Gets `Cell` object or null in this range.
`int`	`getColumnCount()` Gets the count of columns in the range.
`double`	`getColumnWidth()` Sets or gets the column width of this range
`Range`	`getCurrentRegion()` Returns a Range object that represents the current region.
`Range`	`getEntireColumn()` Gets a Range object that represents the entire column (or columns) that contains the specified range.
`Range`	`getEntireRow()` Gets a Range object that represents the entire row (or rows) that contains the specified range.
`int`	`getFirstColumn()` Gets the index of the first column of the range.
`int`	`getFirstRow()` Gets the index of the first row of the range.
`double`	`getHeight()` Gets the width of a range in points.
`Hyperlink[]`	`getHyperlinks()` Gets all hyperlink in the range.
`double`	`getLeft()` Gets the distance, in points, from the left edge of column A to the left edge of the range.
`java.lang.String`	`getName()` Gets the name of the range.
`Range`	`getOffset(int rowOffset, int columnOffset)` Gets `Range` range by offset.
`java.lang.String`	`getRefersTo()` Gets the range's refers to.
`int`	`getRowCount()` Gets the count of rows in the range.
`double`	`getRowHeight()` Sets or gets the height of rows in this range
`double`	`getTop()` Gets the distance, in points, from the top edge of row 1 to the top edge of the range.
`java.lang.Object`	`getValue()` Gets the value of the range.
`double`	`getWidth()` Gets the width of a range in points.
`Worksheet`	`getWorksheet()` Gets the `getWorksheet()`object which contains this range.
`Range`	`intersect(Range range)` Returns a `Range` object that represents the rectangular intersection of two ranges.
`boolean`	`isBlank()` Indicates whether the range contains values.
`boolean`	`isIntersect(Range range)` Indicates whether the range is intersect.
`java.util.Iterator`	`iterator()` Gets the enumerator for cells in this Range.
`void`	`merge()` Combines a range of cells into a single cell.
`void`	`moveTo(int destRow, int destColumn)` Move the current range to the dest range.
`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.
`void`	`setColumnWidth(double value)` Sets or gets the column width of this range
`void`	`setInsideBorders(int borderEdge, int lineStyle, CellsColor borderColor)` Set inside borders of the range.
`void`	`setName(java.lang.String value)` Sets the name of the range.
`void`	`setOutlineBorder(int borderEdge, int borderStyle, CellsColor borderColor)` Sets outline border around a range of cells.
`void`	`setOutlineBorder(int borderEdge, int borderStyle, Color borderColor)` Sets outline border around a range of cells.
`void`	`setOutlineBorders(int[] borderStyles, Color[] borderColors)` Sets out line borders around a range of cells.
`void`	`setOutlineBorders(int borderStyle, CellsColor borderColor)` Sets the outline borders around a range of cells with same border style and color.
`void`	`setOutlineBorders(int borderStyle, Color borderColor)` Sets the outline borders around a range of cells with same border style and color.
`void`	`setRowHeight(double value)` Sets or gets the height of rows in this range
`void`	`setStyle(Style style)` Sets the style of the range.
`void`	`setStyle(Style style, boolean explicitFlag)` Apply the cell style.
`void`	`setValue(java.lang.Object value)` Sets the value of the range.
`byte[]`	`toHtml(HtmlSaveOptions saveOptions)` Convert the range to html .
`byte[]`	`toImage(ImageOrPrintOptions options)` Converts the range to image.
`java.lang.String`	`toJson(JsonSaveOptions options)` Convert the range to JSON value.
`java.lang.String`	`toString()` Returns a string represents the current Range object.
`void`	`transpose()` Transpose (rotate) data from rows to columns or vice versa.
`java.util.ArrayList`	`union(Range range)` Deprecated. Use Range.UnionRanges() instead.
`Range[]`	`unionRang(Range range)` Deprecated. Use Range.UnionRanges() instead.
`UnionRange`	`unionRanges(Range[] ranges)` Returns the union result of two ranges.
`void`	`unMerge()` Unmerges merged cells of this range.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - autoFill
```
public void autoFill(Range target)
```
    Automaticall fill the target range.
    Example
```
 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         // Get the first Worksheet Cells.
         Cells cells = workbook.getWorksheets().get(0).getCells();
         cells.get("A1").putValue(1);
         cells.get("A2").putValue(2);
         Range source = cells.createRange("A1:A2");
         Range target = cells.createRange("A3:A10");
         //fill 3,4,5....10 to the range A3:A10
         source.autoFill(target);
         //Save the Excel file
         workbook.save("book1.xlsm");
 
```
    Parameters:
    target - the target range.
  - autoFill
```
public void autoFill(Range target,
            int autoFillType)
```
    Automaticall fill the target range.
    
    Parameters:
    target - The targed range.
    autoFillType - AutoFillType. The auto fill type.
  - getCurrentRegion
```
public Range getCurrentRegion()
```
    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.
  - getHyperlinks
```
public Hyperlink[] getHyperlinks()
```
    Gets all hyperlink in the range.
  - addHyperlink
```
public Hyperlink addHyperlink(java.lang.String address,
                     java.lang.String textToDisplay,
                     java.lang.String screenTip)
```
    Adds a hyperlink to a specified cell or a range of cells.
    
    Parameters:
    address - Address of the hyperlink.
    textToDisplay - The text to be displayed for the specified hyperlink.
    screenTip - The screenTip text for the specified hyperlink.
    
    Returns:
    Hyperlink object.
  - iterator
```
public java.util.Iterator iterator()
```
    Gets the enumerator for cells in this Range.
    Remarks
    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).
    Example
```
 
         Workbook workbook = new Workbook("template.xlsx");
                Cells cells = workbook.getWorksheets().get(0).getCells();
 
                Iterator en = cells.createRange("B2:C3").iterator();
                while (en.hasNext())
                {
                    Cell cell = (Cell)en.next();
                    System.out.println(cell.getName() + ": " + cell.getValue());
                }
 
```
    Specified by:
    
    iterator in interface java.lang.Iterable
    
    Returns:
    The cells enumerator
  - isIntersect
```
public boolean isIntersect(Range range)
```
    Indicates whether the range is intersect.
    Remarks
    If the two ranges area not in the same worksheet ,return false.
    
    Parameters:
    range - The range.
    
    Returns:
    Whether the range is intersect.
  - intersect
```
public Range intersect(Range range)
```
    Returns a Range object that represents the rectangular intersection of two ranges.
    Remarks
    If the two ranges are not intersected, returns null.
    Example
```
 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         // Get the first Worksheet Cells.
         Cells cells = workbook.getWorksheets().get(0).getCells();
         Range range1 = cells.createRange("A1:A5");
         Range range2 = cells.createRange("A3:A10");
         //Get intersected range of the two ranges.
         Range intersectRange = range1.intersect(range2);
         //Save the Excel file
         workbook.save("book1.xlsm");
 
```
    Parameters:
    range - The intersecting range.
    
    Returns:
    Returns a Range object
  - unionRang
```
public Range[] unionRang(Range range)
```
    Deprecated. Use Range.UnionRanges() instead.
    
    Returns the union result of two ranges.
    Remarks
    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.
    
    Parameters:
    range - The range
    
    Returns:
    The union of two ranges.
  - unionRanges
```
public UnionRange unionRanges(Range[] ranges)
```
    Returns the union result of two ranges.
    
    Parameters:
    ranges - The range
    
    Returns:
    The union of two ranges.
  - union
```
public java.util.ArrayList union(Range range)
```
    Deprecated. Use Range.UnionRanges() instead.
    
    Returns the union of two ranges.
    Remarks
    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.
    
    Parameters:
    range - The range
    
    Returns:
    The union of two ranges.
  - getRowCount
```
public int getRowCount()
```
    Gets the count of rows in the range.
  - getColumnCount
```
public int getColumnCount()
```
    Gets the count of columns in the range.
  - getName
```
public java.lang.String getName()
```
    Gets the name of the range.
    Remarks
    Named range is supported. For example,
    range.Name = "Sheet1!MyRange";
  - setName
```
public void setName(java.lang.String value)
```
    Sets the name of the range.
    Remarks
    Named range is supported. For example,
    range.Name = "Sheet1!MyRange";
  - getRefersTo
```
public java.lang.String getRefersTo()
```
    Gets the range's refers to.
  - getAddress
```
public java.lang.String getAddress()
```
    Gets address of the range.
  - isBlank
```
public boolean isBlank()
```
    Indicates whether the range contains values.
    
    Returns:
  - getLeft
```
public double getLeft()
```
    Gets the distance, in points, from the left edge of column A to the left edge of the range.
  - getTop
```
public double getTop()
```
    Gets the distance, in points, from the top edge of row 1 to the top edge of the range.
  - getWidth
```
public double getWidth()
```
    Gets the width of a range in points.
  - getHeight
```
public double getHeight()
```
    Gets the width of a range in points.
  - getFirstRow
```
public int getFirstRow()
```
    Gets the index of the first row of the range.
  - getFirstColumn
```
public int getFirstColumn()
```
    Gets the index of the first column of the range.
  - merge
```
public void merge()
```
    Combines a range of cells into a single cell.
    Remarks
    Reference the merged cell via the address of the upper-left cell in the range.
  - unMerge
```
public void unMerge()
```
    Unmerges merged cells of this range.
  - putValue
```
public 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
  - getValue
```
public java.lang.Object getValue()
```
    Gets the value of the range.
    Remarks
    If the range contains multiple cells, the returned/applied object should be Object[][].
  - setValue
```
public void setValue(java.lang.Object value)
```
    Sets the value of the range.
    Remarks
    If the range contains multiple cells, the returned/applied object should be Object[][].
  - setStyle
```
public void setStyle(Style style,
            boolean explicitFlag)
```
    Apply the cell style.
    
    Parameters:
    style - The cell style.
    explicitFlag - True, only overwriting formatting which is explicitly set.
  - applyStyle
```
public void applyStyle(Style style,
              StyleFlag flag)
```
    Applies formats for a whole range.
    Remarks
    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.
  - setStyle
```
public void setStyle(Style style)
```
    Sets the style of the range.
    
    Parameters:
    style - The Style object.
  - setOutlineBorders
```
public void setOutlineBorders(int borderStyle,
                     CellsColor borderColor)
```
    Sets the outline borders around a range of cells with same border style and color.
    
    Parameters:
    borderStyle - CellBorderType. Border style.
    borderColor - Border color.
  - setOutlineBorders
```
public void setOutlineBorders(int borderStyle,
                     Color borderColor)
```
    Sets the outline borders around a range of cells with same border style and color.
    
    Parameters:
    borderStyle - CellBorderType. Border style.
    borderColor - Border color.
  - setOutlineBorders
```
public void setOutlineBorders(int[] borderStyles,
                     Color[] borderColors)
```
    Sets out line borders around a range of cells.
    Remarks
    Both the length of borderStyles and borderStyles must be 4. The order of borderStyles and borderStyles must be top,bottom,left,right
    
    Parameters:
    borderStyles - CellBorderType. Border styles.
    borderColors - Border colors.
  - setOutlineBorder
```
public void setOutlineBorder(int borderEdge,
                    int borderStyle,
                    CellsColor borderColor)
```
    Sets outline border around a range of cells.
    
    Parameters:
    borderEdge - BorderType. Border edge.
    borderStyle - CellBorderType. Border style.
    borderColor - Border color.
  - setOutlineBorder
```
public void setOutlineBorder(int borderEdge,
                    int borderStyle,
                    Color borderColor)
```
    Sets outline border around a range of cells.
    
    Parameters:
    borderEdge - BorderType. Border edge.
    borderStyle - CellBorderType. Border style.
    borderColor - Border color.
  - setInsideBorders
```
public void setInsideBorders(int borderEdge,
                    int lineStyle,
                    CellsColor borderColor)
```
    Set inside borders of the range.
    
    Parameters:
    borderEdge - BorderType. Inside borde type, only can be BorderType.VERTICAL and BorderType.HORIZONTAL.
    lineStyle - CellBorderType. The border style.
    borderColor - The color of the border.
  - getColumnWidth
```
public double getColumnWidth()
```
    Sets or gets the column width of this range
  - setColumnWidth
```
public void setColumnWidth(double value)
```
    Sets or gets the column width of this range
  - getRowHeight
```
public double getRowHeight()
```
    Sets or gets the height of rows in this range
  - setRowHeight
```
public void setRowHeight(double value)
```
    Sets or gets the height of rows in this range
  - moveTo
```
public 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.
  - copyData
```
public void copyData(Range range)
```
    Copies cell data (including formulas) from a source range.
    
    Parameters:
    range - Source Range object.
  - copyValue
```
public void copyValue(Range range)
```
    Copies cell value from a source range.
    
    Parameters:
    range - Source Range object.
  - copyStyle
```
public void copyStyle(Range range)
```
    Copies style settings from a source range.
    
    Parameters:
    range - Source Range object.
  - copy
```
public void copy(Range range,
        PasteOptions options)
```
    Copying the range with paste special options.
    
    Parameters:
    range - The source range.
    options - The paste special options.
  - transpose
```
public void transpose()
```
    Transpose (rotate) data from rows to columns or vice versa.
  - copy
```
public void copy(Range range)
```
    Copies data (including formulas), formatting, drawing objects etc. from a source range.
    Example
```
 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         // Get the first Worksheet Cells.
         Cells cells = workbook.getWorksheets().get(0).getCells();
         Range range1 = cells.createRange("A1:A5");
         Range range2 = cells.createRange("A6:A10");
         //Copy the range.
         range1.copy(range2);
         //Save the Excel file
         workbook.save("book1.xlsm");
 
```
    Parameters:
    range - Source Range object.
  - get
```
public Cell get(int rowOffset,
       int 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.
  - getCellOrNull
```
public Cell getCellOrNull(int rowOffset,
                 int columnOffset)
```
    Gets Cell object or null in this range.
    
    Parameters:
    rowOffset - Row offset in this range, zero based.
    columnOffset - Column offset in this range, zero based.
    
    Returns:
    Cell object.
  - getOffset
```
public Range getOffset(int rowOffset,
              int columnOffset)
```
    Gets Range range by offset.
    
    Parameters:
    rowOffset - Row offset in this range, zero based.
    columnOffset - Column offset in this range, zero based.
    
    Returns:
  - getEntireColumn
```
public Range getEntireColumn()
```
    Gets a Range object that represents the entire column (or columns) that contains the specified range.
  - getEntireRow
```
public Range getEntireRow()
```
    Gets a Range object that represents the entire row (or rows) that contains the specified range.
  - getWorksheet
```
public Worksheet getWorksheet()
```
    Gets the getWorksheet()object which contains this range.
  - toString
```
public java.lang.String toString()
```
    Returns a string represents the current Range object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
  - toImage
```
public byte[] toImage(ImageOrPrintOptions options)
```
    Converts the range to image.
    
    Parameters:
    options - The options for converting this range to image
    
    Returns:
  - toJson
```
public java.lang.String toJson(JsonSaveOptions options)
```
    Convert the range to JSON value.
    
    Parameters:
    options - The options of converting
    
    Returns:
  - toHtml
```
public byte[] toHtml(HtmlSaveOptions saveOptions)
```
    Convert the range to html .
    
    Parameters:
    saveOptions - Options for coverting range to html.
    
    Returns:
  - clear
```
public void clear()
```
    Clears this range.
  - clearContents
```
public void clearContents()
```
    Clears the contents of this range.
  - clearFormats
```
public void clearFormats()
```
    Clears the formats of this range.
  - clearComments
```
public void clearComments()
```
    Clears the comments of this range.
  - clearHyperlinks
```
public void clearHyperlinks(boolean clearFormat)
```
    Only removes hyperlinks.
    
    Parameters:
    clearFormat - Indicates whether to clear the format of hyperlinks.

Class Range

Method Summary

Methods inherited from class java.lang.Object

Method Detail

autoFill

autoFill

getCurrentRegion

getHyperlinks

addHyperlink

iterator

isIntersect

intersect

unionRang

unionRanges

union

getRowCount

getColumnCount

getName

setName

getRefersTo

getAddress

isBlank

getLeft

getTop

getWidth

getHeight

getFirstRow

getFirstColumn

merge

unMerge

putValue

getValue

setValue

setStyle

applyStyle

setStyle

setOutlineBorders

setOutlineBorders

setOutlineBorders

setOutlineBorder

setOutlineBorder

setInsideBorders

getColumnWidth

setColumnWidth

getRowHeight

setRowHeight

moveTo

copyData

copyValue

copyStyle

copy

transpose

copy

get

getCellOrNull

getOffset

getEntireColumn

getEntireRow

getWorksheet

toString

toImage

toJson

toHtml

clear

clearContents

clearFormats

clearComments

clearHyperlinks