aspose.cells

Class Range

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

Property Getters/Setters Summary
functiongetAddress()
Gets address of the range.
functiongetCellCount()
Gets all cell count in the range.
functiongetColumnCount()
Gets the count of columns in the range.
functiongetColumnWidth()
function
           Sets or gets the column width of this range
functiongetEntireColumn()
Gets a Range object that represents the entire column (or columns) that contains the specified range.
functiongetEntireRow()
Gets a Range object that represents the entire row (or rows) that contains the specified range.
functiongetFirstColumn()
Gets the index of the first column of the range.
functiongetFirstRow()
Gets the index of the first row of the range.
functiongetName()
function
setName(value)
           Gets or sets the name of the range.
functiongetRefersTo()
Gets the range's refers to.
functiongetRowCount()
Gets the count of rows in the range.
functiongetRowHeight()
function
           Sets or gets the height of rows in this range
functiongetValue()
function
setValue(value)
           Gets and sets the value of the range.
functiongetWorksheet()
Gets the Worksheetobject which contains this range.
functionget(rowOffset, columnOffset)
Gets Cell object in this range.
 
Method Summary
functionapplyStyle(style, flag)
Applies formats for a whole range.
functioncopy(range)
Copies data (including formulas), formatting, drawing objects etc. from a source range.
functioncopy(range, options)
Copying the range with paste special options.
functioncopyData(range)
Copies cell data (including formulas) from a source range.
functioncopyStyle(range)
Copies style settings from a source range.
functioncopyValue(range)
Copies cell value from a source range.
functiongetCellOrNull(rowOffset, columnOffset)
Gets Cell object or null in this range.
functiongetOffset(rowOffset, columnOffset)
Gets Range range by offset.
functionintersect(range)
Returns a Range object that represents the rectangular intersection of two ranges.
functionisIntersect(range)
Indicates whether the range is intersect.
functioniterator()
Gets the enumerator for cells in this Range.
functionmerge()
Combines a range of cells into a single cell.
functionmoveTo(destRow, destColumn)
Move the current range to the dest range.
functionputValue(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.
functionsetOutlineBorder(borderEdge, borderStyle, borderColor)
Sets outline border around a range of cells.
functionsetOutlineBorders(borderStyle, borderColor)
Sets the outline borders around a range of cells with same border style and color.
functionsetOutlineBorders(borderStyles, borderColors)
Sets out line borders around a range of cells.
functionsetStyle(style)
Sets the style of the range.
functiontoString()
Returns a string represents the current Range object.
functionunion(range)
Returns the union of two ranges.
functionunMerge()
Unmerges merged cells of this range.
 

    • Property Getters/Setters Detail

      • getRowCount : Number 

        function getRowCount()
        
        Gets the count of rows in the range.
      • getColumnCount : Number 

        function getColumnCount()
        
        Gets the count of columns in the range.
      • getCellCount : Number 

        function getCellCount()
        
        Gets all cell count in the range.
      • getName/setName : String 

        function getName() / function setName(value)
        
        Gets or sets the name of the range. Named range is supported. For example,

        range.Name = "Sheet1!MyRange";

      • getRefersTo : String 

        function getRefersTo()
        
        Gets the range's refers to.
      • getAddress : String 

        function getAddress()
        
        Gets address of the range.
      • getFirstRow : Number 

        function getFirstRow()
        
        Gets the index of the first row of the range.
      • getFirstColumn : Number 

        function getFirstColumn()
        
        Gets the index of the first column of the range.
      • getValue/setValue : Object 

        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.
      • getColumnWidth/setColumnWidth : Number 

        function getColumnWidth() / function setColumnWidth(value)
        
        Sets or gets the column width of this range
      • getRowHeight/setRowHeight : Number 

        function getRowHeight() / function setRowHeight(value)
        
        Sets or gets the height of rows in this range
      • getEntireColumn : Range 

        function getEntireColumn()
        
        Gets a Range object that represents the entire column (or columns) that contains the specified range.
      • getEntireRow : Range 

        function getEntireRow()
        
        Gets a Range object that represents the entire row (or rows) that contains the specified range.
      • getWorksheet : Worksheet 

        function getWorksheet()
        
        Gets the Worksheetobject which contains this range.
      • get : Cell 

        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.
    • Method Detail

      • iterator

        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
      • isIntersect

        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.
      • 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
      • union

        function union(range)
        Returns the union of two ranges.
        Parameters:
        range: Range - The range
        Returns:
        The union of two ranges.
      • merge

        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.
      • unMerge

        function unMerge()
        Unmerges merged cells of this range.
      • putValue

        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
      • applyStyle

        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.
      • setStyle

        function setStyle(style)
        Sets the style of the range.
        Parameters:
        style: Style - The Style object.
      • setOutlineBorders

        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.
      • setOutlineBorders

        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.
      • setOutlineBorder

        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.
      • moveTo

        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.
      • copyData

        function copyData(range)
        Copies cell data (including formulas) from a source range.
        Parameters:
        range: Range - Source Range object.
      • copyValue

        function copyValue(range)
        Copies cell value from a source range.
        Parameters:
        range: Range - Source Range object.
      • copyStyle

        function copyStyle(range)
        Copies style settings from a source range.
        Parameters:
        range: Range - Source Range object.
      • copy

        function copy(range, options)
        Copying the range with paste special options.
        Parameters:
        range: Range - The soure range.
        options: PasteOptions - The paste special options.
      • copy

        function copy(range)
        Copies data (including formulas), formatting, drawing objects etc. from a source range.
        Parameters:
        range: Range - Source Range object.
      • getCellOrNull

        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.
      • getOffset

        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:
      • toString

        function toString()
        Returns a string represents the current Range object.
        Returns: