com.aspose.cells

Class UnionRange

java.lang.Object

com.aspose.cells.UnionRange

All Implemented Interfaces:

java.lang.Iterable

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

Represents union range.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyStyle(Style style, StyleFlag flag) Applies formats for a whole range.
void	copy(UnionRange range, PasteOptions options) Copying the range with paste special options.
int	getCellCount() Gets all cell count in the range.
int	getColumnCount() Gets the count of rows in the 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.
Hyperlink[]	getHyperlinks() Gets all hyperlink in the range.
java.lang.String	getName() Gets the name of the range.
int	getRangeCount() Gets the count of the ranges.
Range[]	getRanges() Gets all union ranges.
java.lang.String	getRefersTo() Gets the range's refers to.
int	getRowCount() Gets the count of rows in the range.
java.lang.Object	getValue() Gets the values of the range.
boolean	hasRange() Indicates whether this has range.
UnionRange	intersect(Range[] ranges) Intersects another range.
UnionRange	intersect(java.lang.String range) Intersects another range.
UnionRange	intersect(UnionRange unionRange) Intersects another range.
java.util.Iterator	iterator() Gets the enumerator for cells in this Range.
void	merge() Combines a range of cells into a single cell.
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	setName(java.lang.String value) Sets the name of the range.
void	setOutlineBorders(int[] borderStyles, Color[] borderColors) Sets out line borders around a range of cells.
void	setOutlineBorders(int borderStyle, Color borderColor) Sets the outline borders around a range of cells with same border style and color.
void	setStyle(Style style) Sets the style of the range.
void	setValue(java.lang.Object value) Sets the values of the range.
UnionRange	union(Range[] ranges) Union the ranges.
UnionRange	union(java.lang.String range) Union another range.
UnionRange	union(UnionRange unionRange) Union another range.
void	unMerge() Unmerges merged cells of this range.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFirstRow

public int getFirstRow()

Gets the index of the first row of the range.

Remarks

Only effects when it only contains one range.

getFirstColumn

public int getFirstColumn()

Gets the index of the first column of the range.

Remarks

Only effects when it only contains one range.

getRowCount

public int getRowCount()

Gets the count of rows in the range.

Remarks

Only effects when it only contains one range.

getColumnCount

public int getColumnCount()

Gets the count of rows in the range.

Remarks

Only effects when it only contains one 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 values of the range.

setValue

public void setValue(java.lang.Object value)

Sets the values of 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.

hasRange

public boolean hasRange()

Indicates whether this has range.

getHyperlinks

public Hyperlink[] getHyperlinks()

Gets all hyperlink in the range.

setStyle

public void setStyle(Style style)

Sets the style of the range.

Parameters:

style - The Style object.

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.

copy

public void copy(UnionRange range,
        PasteOptions options)

Copying the range with paste special options.

Parameters:

range - The source range.

options - The paste special options.

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).

Specified by:

iterator in interface java.lang.Iterable

Returns:

The cells enumerator

getCellCount

public int getCellCount()

Gets all cell count in the range.

getRangeCount

public int getRangeCount()

Gets the count of the ranges.

getRanges

public Range[] getRanges()

Gets all union ranges.

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.

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.

intersect

public UnionRange intersect(java.lang.String range)

Intersects another range.

Remarks

If the two union ranges are not intersected, returns null.

Parameters:

range - The range.

intersect

public UnionRange intersect(UnionRange unionRange)

Intersects another range.

Remarks

If the two union ranges are not intersected, returns null.

Parameters:

unionRange - The range.

intersect

public UnionRange intersect(Range[] ranges)

Intersects another range.

Remarks

If the two union ranges are not intersected, returns null.

Parameters:

ranges - The range.

union

public UnionRange union(java.lang.String range)

Union another range.

Parameters:

range - The range.

Returns:

union

public UnionRange union(UnionRange unionRange)

Union another range.

Parameters:

unionRange - The range.

Returns:

union

public UnionRange union(Range[] ranges)

Union the ranges.

Parameters:

ranges - The ranges.

Returns: