aspose.cells

Class UnionRange

Represents union range.

Property Getters/Setters Summary
functiongetCellCount()
Gets all cell count in the range.
functiongetColumnCount()
Gets the count of rows in the range.
functiongetFirstColumn()
Gets the index of the first column of the range.
functiongetFirstRow()
Gets the index of the first row of the range.
functionhasRange()
Indicates whether this has range.
functiongetHyperlinks()
Gets all hyperlink in the range.
functiongetName()
function
setName(value)
           Gets or sets the name of the range.
functiongetRangeCount()
Gets the count of the ranges.
functiongetRanges()
Gets all union ranges.
functiongetRefersTo()
Gets the range's refers to.
functiongetRowCount()
Gets the count of rows in the range.
functiongetValue()
function
setValue(value)
           Gets and sets the values of the range.
 
Method Summary
functionapplyStyle(style, flag)
Applies formats for a whole range.
functioncopy(range, options)
Copying the range with paste special options.
functionintersect(ranges)
Intersects another range.
functionintersect(unionRange)
Intersects another range.
functionintersect(range)
Intersects another range.
functioniterator()
Gets the enumerator for cells in this Range.
functionmerge()
Combines a range of cells into a single cell.
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.
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.
functionunion(ranges)
Union the ranges.
functionunion(unionRange)
Union another range.
functionunion(range)
Union another range.
functionunMerge()
Unmerges merged cells of this range.
 

    • Property Getters/Setters Detail

      • getFirstRow : Number 

        function getFirstRow()
        
        Gets the index of the first row of the range. Only effects when it only contains one range.
      • getFirstColumn : Number 

        function getFirstColumn()
        
        Gets the index of the first column of the range. Only effects when it only contains one range.
      • getRowCount : Number 

        function getRowCount()
        
        Gets the count of rows in the range. Only effects when it only contains one range.
      • getColumnCount : Number 

        function getColumnCount()
        
        Gets the count of rows in the range. Only effects when it only contains one range.
      • getValue/setValue : Object 

        function getValue() / function setValue(value)
        
        Gets and sets the values of 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.
      • hasRange : boolean 

        function hasRange()
        
        Indicates whether this has range.
      • getHyperlinks : Hyperlink[] 

        function getHyperlinks()
        
        Gets all hyperlink in the range.
      • getCellCount : Number 

        function getCellCount()
        
        Gets all cell count in the range.
      • getRangeCount : Number 

        function getRangeCount()
        
        Gets the count of the ranges.
      • getRanges : Range[] 

        function getRanges()
        
        Gets all union ranges.
    • Method Detail

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

        function setStyle(style)
        Sets the style of the range.
        Parameters:
        style: Style - The Style object.
      • 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.
      • copy

        function copy(range, options)
        Copying the range with paste special options.
        Parameters:
        range: UnionRange - The source range.
        options: PasteOptions - The paste special options.
      • 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
      • 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 borderStyles and borderStyles must be top,bottom,left,right
        Parameters:
        borderStyles: Number Array - Border styles.
        borderColors: Color[] - Border colors.
      • 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.
      • intersect

        function intersect(range)
        Intersects another range. If the two union ranges are not intersected, returns null.
        Parameters:
        range: String - The range.
      • intersect

        function intersect(unionRange)
        Intersects another range. If the two union ranges are not intersected, returns null.
        Parameters:
        unionRange: UnionRange - The range.
      • intersect

        function intersect(ranges)
        Intersects another range. If the two union ranges are not intersected, returns null.
        Parameters:
        ranges: Range[] - The range.
      • union

        function union(range)
        Union another range.
        Parameters:
        range: String - The range.
        Returns:
      • union

        function union(unionRange)
        Union another range.
        Parameters:
        unionRange: UnionRange - The range.
        Returns:
      • union

        function union(ranges)
        Union the ranges.
        Parameters:
        ranges: Range[] - The ranges.
        Returns: