com.spire.xls.core.spreadsheet.collections
Class XlsRangesCollection

java.lang.Object
  com.spire.ms.System.Collections.CollectionBase
      com.spire.xls.core.spreadsheet.collections.CollectionExtended
          com.spire.xls.core.spreadsheet.collections.XlsRangesCollection

All Implemented Interfaces:

com.spire.ms.System.Collections.ICollection, com.spire.ms.System.Collections.IEnumerable, ICombinedRange, IXLSRange, IXLSRanges, java.lang.Iterable

public class XlsRangesCollection
extends CollectionExtended
implements IXLSRanges, ICombinedRange

Summary description for RangesCollection.

Constructor Summary

XlsRangesCollection(java.lang.Object parent)
Creates new instance of RangesCollection.

Method Summary

IXLSRange	activate(boolean scroll) Activages a single cell, scroll to it and activates the respective sheet To select a range of cells, use the Select method.
ICommentShape	addComment() Adds comment to the range.
void	autoFitColumns() Autofits all columns.
void	autoFitRows() Autofits all rows.
void	borderAround() Sets around border for current range.
void	borderAround(LineStyleType borderLine) Sets around border for current range.
void	borderAround(LineStyleType borderLine, java.awt.Color borderColor) Sets around border for current range.
void	borderAround(LineStyleType borderLine, ExcelColors borderColor) Sets around border for current range.
void	borderInside() Sets inside border for current range.
void	borderInside(LineStyleType borderLine) Sets inside border for current range.
void	borderInside(LineStyleType borderLine, java.awt.Color borderColor) Sets inside border for current range.
void	borderInside(LineStyleType borderLine, ExcelColors borderColor) Sets inside border for current range.
void	borderNone() Sets none border for current range.
void	clearConditionalFormats() Clears conditional formats.
void	collapseGroup(GroupByType groupBy) Collapses current group.
IXLSRange	deepClone(java.lang.Object parent, java.util.HashMap hashNewNames, XlsWorkbook book) Clones current IXLSRange.
void	expandGroup(GroupByType groupBy) Expands current group.
void	expandGroup(GroupByType groupBy, int flags) Expands current group.
void	freezePanes() Freezes pane at the current range.
IXLSRange	get(int index) Returns item by index from the collection.
IXLSRange	get(int row, int column) Gets / sets cell by row and index.
IXLSRange	get(int row, int column, int lastRow, int lastColumn) Get cell range.
IXLSRange	get(java.lang.String name) Get cell range.
IXLSRange	get(java.lang.String name, boolean IsR1C1Notation) Gets cell range.
boolean	getBooleanValue() Gets / sets boolean value that is contained by this range.
IBorders	getBorders() Returns a Borders collection that represents the borders of a style or a range of cells (including a range defined as part of a conditional format).
BuiltInStyles	getBuiltInStyle() Gets/sets built in style.
int	getCellsCount() Number of cells in the range.
java.lang.String	getCellStyleName() Returns name of the Style object that represents the style of the specified range.
int	getColumn() Returns the number of the first column in the first area in the specified range.
int	getColumnGroupLevel() Column group level.
IXLSRange[]	getColumns() For a Range object, returns an array of Range objects that represent the columns in the specified range.
double	getColumnWidth() Returns or sets the width of all columns in the specified range.
ICommentShape	getComment() Comment assigned to the range.
ConditionalFormats	getConditionalFormats() Collection of conditional formats.
int	getCount() Returns the number of objects in the collection.
Validation	getDataValidation() Data validation for the range.
java.util.Date	getDateTimeValue() Gets DateTime contained by this cell.
IXLSRange	getEndCell() Returns a Range object that represents the cell at the end of the region that contains the source range.
IXLSRange	getEntireColumn() Returns a Range object that represents the entire column (or columns) that contains the specified range.
IXLSRange	getEntireRow() Returns a Range object that represents the entire row (or rows) that contains the specified range.
java.lang.String	getErrorValue() Gets / sets error value that is contained by this range.
java.lang.String	getFormula() Returns or sets the object's formula in A1-style notation and in the language of the macro.
java.lang.String	getFormulaArray() Represents array-entered formula.
java.lang.String	getFormulaArrayR1C1() Returns or sets the array-entered formula in R1C1-style notation and in the language of the macro.
boolean	getFormulaBoolValue() Returns the calculated value of the formula as a boolean.
java.util.Date	getFormulaDateTime() Get formula DateTime value contained by this cell.
java.lang.String	getFormulaErrorValue() Returns the calculated value of the formula as a string.
double	getFormulaNumberValue() Gets / sets number value evaluated by formula.
java.lang.String	getFormulaR1C1() Returns or sets the object's formula in R1C1-style notation and in the language of the macro.
java.lang.String	getFormulaStringValue() Gets / sets string value evaluated by formula.
HorizontalAlignType	getHorizontalAlignment() Returns or sets the horizontal alignment for the specified object.
IHyperLinks	getHyperlinks() Returns hyperlinks for this ranges collection.
java.util.EnumSet<IgnoreErrorType>	getIgnoreErrorOptions() Represents ignore error options.
int	getIndentLevel() Returns or sets the indent level for the cell or range.
int	getLastColumn() Returns last column of the range.
int	getLastRow() Returns last row of the range.
IXLSRange	getMergeArea() Returns a Range object that represents the merged range containing the specified cell.
java.lang.String	getNewRangeLocation(java.util.HashMap names, java.lang.String[] sheetName) Gets new address of range.
java.lang.String	getNumberFormat() Format of current cell.
java.lang.String	getNumberText() Returns cell value after number format application.
double	getNumberValue() Gets / sets double value of the range.
java.lang.String	getRangeAddress() Returns the range reference in the language of the macro.
java.lang.String	getRangeAddressLocal() Returns the range reference for the specified range in the language of the user.
java.lang.String	getRangeGlobalAddress() Returns the range reference in the language of the macro.
java.lang.String	getRangeGlobalAddress2007() Gets address global in the format required by Excel 2007.
java.lang.String	getRangeR1C1Address() Returns the range reference in the language of the macro using R1C1-style reference.
java.lang.String	getRangeR1C1AddressLocal() Returns the range reference for the specified range in the language of the user using R1C1 style reference .
java.awt.Rectangle[]	getRectangles() Returns array that contains information about range.
int	getRectanglesCount() Returns number of rectangles returned by GetRectangles method.
IRichTextString	getRichText() String with rich text formatting.
int	getRow() Returns the number of the first row of the first area in the range.
int	getRowGroupLevel() Row group level.
double	getRowHeight() Returns the height of all the rows in the range specified, measured in points.
IXLSRange[]	getRows() For a Range object, returns an array of Range objects that represent the rows in the specified range.
IStyle	getStyle() Returns a Style object that represents the style of the specified range.
java.lang.String	getText() Gets / sets string value of the range.
com.spire.ms.System.TimeSpan	getTimeSpanValue() Gets / sets time value of the range.
java.lang.String	getValue() Returns or sets the value of the specified range.
java.lang.Object	getValue2() Returns or sets the cell value.
VerticalAlignType	getVerticalAlignment() Returns or sets the vertical alignment of the specified object.
IWorksheet	getWorksheet() Returns a Worksheet object that represents the worksheet containing the specified range.
java.lang.String	getWorksheetName() Gets name of the parent worksheet.
boolean	hasBoolean() Indicates whether range contains bool value.
boolean	hasDataValidation() Indicates whether specified range object has data validation.
boolean	hasDateTime() Indicates whether range contains DateTime value.
boolean	hasError() Indicates whether range contains error value.
boolean	hasExternalFormula() Indicates is current range has external formula.
boolean	hasFormula() True if all cells in the range contain formulas; False if at least one of the cells in the range doesn't contain a formula.
boolean	hasFormulaArray() Indicates whether range contains array-entered formula.
boolean	hasFormulaBoolValue() Indicates if current range has formula bool value.
boolean	hasFormulaDateTime() Indicates if current range has formula value formatted as DateTime.
boolean	hasFormulaErrorValue() Indicates if current range has formula error value.
boolean	hasMerged() Indicates whether this range is part of merged range.
boolean	hasNumber() Indicates whether the range contains number.
boolean	hasRichText() Indicates whether cell contains formatted rich text string.
boolean	hasString() Indicates whether the range contains String.
boolean	hasStyle() Indicates whether range has default style.
IXLSRange	intersect(IXLSRange range) Returns intersection of this range with the specified one.
boolean	isBlank() Indicates whether the range is blank.
boolean	isFormulaHidden() True if the formula will be hidden when the worksheet is protected.
boolean	isGroupedByColumn() Indicates whether this range is grouped by column.
boolean	isGroupedByRow() Indicates whether this range is grouped by row.
boolean	isInitialized() Indicates whether cell is initialized.
java.lang.Boolean	isStringsPreserved() Indicates whether all values in the range are preserved as strings.
boolean	isWrapText() True if Microsoft Excel wraps the text in the object.
void	merge() Creates a merged cell from the specified Range object.
void	merge(boolean clearCells) Creates a merged cell from the specified Range object.
IXLSRange	merge(IXLSRange range) Returns merge of this range with the specified one.
void	remove(IXLSRange range) Removes range from the collection.
void	setDateTimeValue(java.util.Date data) Gets DateTime contained by this cell.
void	setFormulaDateTime(java.util.Date data) Set formula DateTime value contained by this cell.
void	unMerge() Separates a merged area into individual cells.

Methods inherited from interface com.spire.xls.core.IXLSRange

clear, clearContents, getCellList, getEnvalutedValue, getInnerFormulaDateTime, hasFormulaNumberValue, hasFormulaStringValue, isStringsPreserved, isWrapText, set, setBooleanValue, setBuiltInStyle, setFormulaNumberValue, setFormulaStringValue, setIgnoreErrorOptions, setObjectValue, setValue, setVerticalAlignment

Constructor Detail

XlsRangesCollection

public XlsRangesCollection(java.lang.Object parent)

Creates new instance of RangesCollection.

Parameters:

parent - Parent object.

Method Detail

getRangeAddress

public java.lang.String getRangeAddress()

Returns the range reference in the language of the macro. Read-only String.

Specified by:

getRangeAddress in interface IXLSRange

getRangeAddressLocal

public java.lang.String getRangeAddressLocal()

Returns the range reference for the specified range in the language of the user. Read-only String.

Specified by:

getRangeAddressLocal in interface IXLSRange

getRangeGlobalAddress

public java.lang.String getRangeGlobalAddress()

Returns the range reference in the language of the macro. Read-only String.

Specified by:

getRangeGlobalAddress in interface IXLSRange

getRangeR1C1Address

public java.lang.String getRangeR1C1Address()

Returns the range reference in the language of the macro using R1C1-style reference. Read-only String.

Specified by:

getRangeR1C1Address in interface IXLSRange

getRangeR1C1AddressLocal

public java.lang.String getRangeR1C1AddressLocal()

Returns the range reference for the specified range in the language of the user using R1C1 style reference . Read-only String.

Specified by:

getRangeR1C1AddressLocal in interface IXLSRange

getBooleanValue

public boolean getBooleanValue()

Gets / sets boolean value that is contained by this range.

Specified by:

getBooleanValue in interface IXLSRange

getBorders

public IBorders getBorders()

Returns a Borders collection that represents the borders of a style or a range of cells (including a range defined as part of a conditional format).

Specified by:

getBorders in interface IXLSRange

getColumn

public int getColumn()

Returns the number of the first column in the first area in the specified range. Read-only.

Specified by:

getColumn in interface IXLSRange

getColumnGroupLevel

public int getColumnGroupLevel()

Column group level. Read-only. -1 - Not all columns in the range have same group level. 0 - No grouping, 1 - 7 - Group level.

Specified by:

getColumnGroupLevel in interface IXLSRange

getColumnWidth

public double getColumnWidth()

Returns or sets the width of all columns in the specified range. Read/write Double.

Specified by:

getColumnWidth in interface IXLSRange

getCount

public int getCount()

Returns the number of objects in the collection. Read-only. !!!Autoporter warning: Namesake explicit interface implementation property that can't be autoported! If you want to autoport it, the explicit property should just call the actual property.

Specified by:

getCount in interface IXLSRange

getDateTimeValue

public java.util.Date getDateTimeValue()

Gets DateTime contained by this cell. Read-write DateTime.

Specified by:

getDateTimeValue in interface IXLSRange

setDateTimeValue

public void setDateTimeValue(java.util.Date data)

Gets DateTime contained by this cell. Read-write DateTime.

getNumberText

public java.lang.String getNumberText()

Returns cell value after number format application. Read-only.

Specified by:

getNumberText in interface IXLSRange

getEndCell

public IXLSRange getEndCell()

Returns a Range object that represents the cell at the end of the region that contains the source range.

Specified by:

getEndCell in interface IXLSRange

getEntireColumn

public IXLSRange getEntireColumn()

Returns a Range object that represents the entire column (or columns) that contains the specified range. Read-only.

Specified by:

getEntireColumn in interface IXLSRange

getEntireRow

public IXLSRange getEntireRow()

Returns a Range object that represents the entire row (or rows) that contains the specified range. Read-only.

Specified by:

getEntireRow in interface IXLSRange

getErrorValue

public java.lang.String getErrorValue()

Gets / sets error value that is contained by this range.

Specified by:

getErrorValue in interface IXLSRange

getFormula

public java.lang.String getFormula()

Returns or sets the object's formula in A1-style notation and in the language of the macro. Read/write Variant.

Specified by:

getFormula in interface IXLSRange

getFormulaR1C1

public java.lang.String getFormulaR1C1()

Returns or sets the object's formula in R1C1-style notation and in the language of the macro. Read/write Variant.

Specified by:

getFormulaR1C1 in interface IXLSRange

getFormulaArray

public java.lang.String getFormulaArray()

Represents array-entered formula. Visit http: *www.cpearson.com/excel/array.htm for more information.

Specified by:

getFormulaArray in interface IXLSRange

getFormulaArrayR1C1

public java.lang.String getFormulaArrayR1C1()

Returns or sets the array-entered formula in R1C1-style notation and in the language of the macro. Read/write Variant.

Specified by:

getFormulaArrayR1C1 in interface IXLSRange

isFormulaHidden

public boolean isFormulaHidden()

True if the formula will be hidden when the worksheet is protected. False if at least part of formula in the range is not hidden.

Specified by:

isFormulaHidden in interface IXLSRange

getFormulaDateTime

public java.util.Date getFormulaDateTime()

Get formula DateTime value contained by this cell. DateTime.MinValue if not all cells of the range have same DateTime value.

setFormulaDateTime

public void setFormulaDateTime(java.util.Date data)

Set formula DateTime value contained by this cell. DateTime.MinValue if not all cells of the range have same DateTime value.

hasDataValidation

public boolean hasDataValidation()

Indicates whether specified range object has data validation. If Range is not single cell, then returns true only if all cells have data validation. Read-only.

Specified by:

hasDataValidation in interface IXLSRange

hasBoolean

public boolean hasBoolean()

Indicates whether range contains bool value. Read-only.

Specified by:

hasBoolean in interface IXLSRange

hasDateTime

public boolean hasDateTime()

Indicates whether range contains DateTime value. Read-only.

Specified by:

hasDateTime in interface IXLSRange

hasFormulaBoolValue

public boolean hasFormulaBoolValue()

Indicates if current range has formula bool value. Read only.

Specified by:

hasFormulaBoolValue in interface IXLSRange

hasFormulaErrorValue

public boolean hasFormulaErrorValue()

Indicates if current range has formula error value. Read only.

Specified by:

hasFormulaErrorValue in interface IXLSRange

hasFormulaDateTime

public boolean hasFormulaDateTime()

Indicates if current range has formula value formatted as DateTime. Read-only.

Specified by:

hasFormulaDateTime in interface IXLSRange

hasFormula

public boolean hasFormula()

True if all cells in the range contain formulas; False if at least one of the cells in the range doesn't contain a formula. Read-only Boolean.

Specified by:

hasFormula in interface IXLSRange

hasFormulaArray

public boolean hasFormulaArray()

Indicates whether range contains array-entered formula. Read-only.

Specified by:

hasFormulaArray in interface IXLSRange

hasNumber

public boolean hasNumber()

Indicates whether the range contains number. Read-only.

Specified by:

hasNumber in interface IXLSRange

hasRichText

public boolean hasRichText()

Indicates whether cell contains formatted rich text string.

Specified by:

hasRichText in interface IXLSRange

hasString

public boolean hasString()

Indicates whether the range contains String. Read-only.

Specified by:

hasString in interface IXLSRange

hasStyle

public boolean hasStyle()

Indicates whether range has default style. False means default style. Read-only.

Specified by:

hasStyle in interface IXLSRange

getHorizontalAlignment

public HorizontalAlignType getHorizontalAlignment()

Returns or sets the horizontal alignment for the specified object. Read/write HorizontalAlignType.

Specified by:

getHorizontalAlignment in interface IXLSRange

getHyperlinks

public IHyperLinks getHyperlinks()

Returns hyperlinks for this ranges collection.

getIndentLevel

public int getIndentLevel()

Returns or sets the indent level for the cell or range. Can be an integer from 0 to 15. Read/write Integer.

Specified by:

getIndentLevel in interface IXLSRange

isBlank

public boolean isBlank()

Indicates whether the range is blank. Read-only.

Specified by:

isBlank in interface IXLSRange

hasError

public boolean hasError()

Indicates whether range contains error value.

Specified by:

hasError in interface IXLSRange

isGroupedByColumn

public boolean isGroupedByColumn()

Indicates whether this range is grouped by column. Read-only.

Specified by:

isGroupedByColumn in interface IXLSRange

isGroupedByRow

public boolean isGroupedByRow()

Indicates whether this range is grouped by row. Read-only.

Specified by:

isGroupedByRow in interface IXLSRange

isInitialized

public boolean isInitialized()

Indicates whether cell is initialized. Read-only.

Specified by:

isInitialized in interface IXLSRange

getLastColumn

public int getLastColumn()

Returns last column of the range. Read-only.

Specified by:

getLastColumn in interface IXLSRange

getLastRow

public int getLastRow()

Returns last row of the range. Read-only.

Specified by:

getLastRow in interface IXLSRange

getNumberValue

public double getNumberValue()

Gets / sets double value of the range.

Specified by:

getNumberValue in interface IXLSRange

getNumberFormat

public java.lang.String getNumberFormat()

Format of current cell. Analog of Style.NumberFormat property.

Specified by:

getNumberFormat in interface IXLSRange

getRow

public int getRow()

Returns the number of the first row of the first area in the range. Read-only Long.

Specified by:

getRow in interface IXLSRange

getRowGroupLevel

public int getRowGroupLevel()

Row group level. Read-only. -1 - Not all rows in the range have same group level. 0 - No grouping, 1 - 7 - Group level.

Specified by:

getRowGroupLevel in interface IXLSRange

getRowHeight

public double getRowHeight()

Returns the height of all the rows in the range specified, measured in points. Returns Double.MinValue if the rows in the specified range aren't all the same height. Read / write Double.

Specified by:

getRowHeight in interface IXLSRange

getRows

public IXLSRange[] getRows()

For a Range object, returns an array of Range objects that represent the rows in the specified range.

Specified by:

getRows in interface IXLSRange

getColumns

public IXLSRange[] getColumns()

For a Range object, returns an array of Range objects that represent the columns in the specified range.

Specified by:

getColumns in interface IXLSRange

getStyle

public IStyle getStyle()

Returns a Style object that represents the style of the specified range. Read/write IStyle.

Specified by:

getStyle in interface IXLSRange

getCellStyleName

public java.lang.String getCellStyleName()

Returns name of the Style object that represents the style of the specified range. Read/write String.

Specified by:

getCellStyleName in interface IXLSRange

getText

public java.lang.String getText()

Gets / sets string value of the range.

Specified by:

getText in interface IXLSRange

getTimeSpanValue

public com.spire.ms.System.TimeSpan getTimeSpanValue()

Gets / sets time value of the range.

Specified by:

getTimeSpanValue in interface IXLSRange

getValue

public java.lang.String getValue()

Returns or sets the value of the specified range. Read/write Variant.

Specified by:

getValue in interface IXLSRange

getValue2

public java.lang.Object getValue2()

Returns or sets the cell value. Read/write Variant. The only difference between this property and the Value property is that the Value2 property doesn't use the Currency and Date data types.

Specified by:

getValue2 in interface IXLSRange

Returns:

getVerticalAlignment

public VerticalAlignType getVerticalAlignment()

Returns or sets the vertical alignment of the specified object. Read/write VerticalAlignType.

Specified by:

getVerticalAlignment in interface IXLSRange

getWorksheet

public IWorksheet getWorksheet()

Returns a Worksheet object that represents the worksheet containing the specified range. Read-only.

Specified by:

getWorksheet in interface IXLSRange

get

public IXLSRange get(int row,
                     int column)

Gets / sets cell by row and index.

Specified by:

get in interface IXLSRange

get

public IXLSRange get(int row,
                     int column,
                     int lastRow,
                     int lastColumn)

Get cell range.

Specified by:

get in interface IXLSRange

get

public IXLSRange get(java.lang.String name)

Get cell range.

Specified by:

get in interface IXLSRange

get

public IXLSRange get(java.lang.String name,
                     boolean IsR1C1Notation)

Gets cell range. Read-only.

Specified by:

get in interface IXLSRange

getConditionalFormats

public ConditionalFormats getConditionalFormats()

Collection of conditional formats.

Specified by:

getConditionalFormats in interface IXLSRange

getDataValidation

public Validation getDataValidation()

Data validation for the range.

Specified by:

getDataValidation in interface IXLSRange

getFormulaStringValue

public java.lang.String getFormulaStringValue()

Description copied from interface: IXLSRange

Gets / sets string value evaluated by formula.

Specified by:

getFormulaStringValue in interface IXLSRange

getFormulaNumberValue

public double getFormulaNumberValue()

Description copied from interface: IXLSRange

Gets / sets number value evaluated by formula.

Specified by:

getFormulaNumberValue in interface IXLSRange

getFormulaBoolValue

public boolean getFormulaBoolValue()

Returns the calculated value of the formula as a boolean.

Specified by:

getFormulaBoolValue in interface IXLSRange

getFormulaErrorValue

public java.lang.String getFormulaErrorValue()

Returns the calculated value of the formula as a string.

Specified by:

getFormulaErrorValue in interface IXLSRange

getComment

public ICommentShape getComment()

Comment assigned to the range. Read-only.

Specified by:

getComment in interface IXLSRange

getRichText

public IRichTextString getRichText()

String with rich text formatting. Read-only.

Specified by:

getRichText in interface IXLSRange

hasMerged

public boolean hasMerged()

Indicates whether this range is part of merged range. Read-only.

Specified by:

hasMerged in interface IXLSRange

getMergeArea

public IXLSRange getMergeArea()

Returns a Range object that represents the merged range containing the specified cell. If the specified cell isn抰 in a merged range, this property returns NULL. Read-only.

Specified by:

getMergeArea in interface IXLSRange

isWrapText

public boolean isWrapText()

True if Microsoft Excel wraps the text in the object. Read/write Boolean.

Specified by:

isWrapText in interface IXLSRange

hasExternalFormula

public boolean hasExternalFormula()

Indicates is current range has external formula. Read-only.

Specified by:

hasExternalFormula in interface IXLSRange

getIgnoreErrorOptions

public java.util.EnumSet<IgnoreErrorType> getIgnoreErrorOptions()

Represents ignore error options. If not single cell returs concatenateed flags.

Specified by:

getIgnoreErrorOptions in interface IXLSRange

Returns:

isStringsPreserved

public java.lang.Boolean isStringsPreserved()

Indicates whether all values in the range are preserved as strings.

Specified by:

isStringsPreserved in interface IXLSRange

getBuiltInStyle

public BuiltInStyles getBuiltInStyle()

Gets/sets built in style.

Specified by:

getBuiltInStyle in interface IXLSRange

getRangeGlobalAddress2007

public java.lang.String getRangeGlobalAddress2007()

Gets address global in the format required by Excel 2007.

Specified by:

getRangeGlobalAddress2007 in interface ICombinedRange

activate

public IXLSRange activate(boolean scroll)

Activages a single cell, scroll to it and activates the respective sheet To select a range of cells, use the Select method.

Specified by:

activate in interface IXLSRange

Parameters:

scroll - True to scroll to the cell

Returns:

merge

public void merge()

Creates a merged cell from the specified Range object.

Specified by:

merge in interface IXLSRange

merge

public void merge(boolean clearCells)

Creates a merged cell from the specified Range object.

Specified by:

merge in interface IXLSRange

Parameters:

clearCells - Indicates whether to clear unnecessary cells.

unMerge

public void unMerge()

Separates a merged area into individual cells.

Specified by:

unMerge in interface IXLSRange

freezePanes

public void freezePanes()

Freezes pane at the current range.

Specified by:

freezePanes in interface IXLSRange

intersect

public IXLSRange intersect(IXLSRange range)

Returns intersection of this range with the specified one.

Specified by:

intersect in interface IXLSRange

Parameters:

range - The Range with which to intersect.

Returns:

Range intersection; if there is no intersection, NULL is returned.

merge

public IXLSRange merge(IXLSRange range)

Returns merge of this range with the specified one.

Specified by:

merge in interface IXLSRange

Parameters:

range - The Range to merge with.

Returns:

Merged ranges or NULL if wasn't able to merge ranges.

autoFitRows

public void autoFitRows()

Autofits all rows.

Specified by:

autoFitRows in interface IXLSRange

autoFitColumns

public void autoFitColumns()

Autofits all columns.

Specified by:

autoFitColumns in interface IXLSRange

addComment

public ICommentShape addComment()

Adds comment to the range.

Specified by:

addComment in interface IXLSRange

Returns:

Range's comment.

borderAround

public void borderAround()

Sets around border for current range.

Specified by:

borderAround in interface IXLSRange

borderAround

public void borderAround(LineStyleType borderLine)

Sets around border for current range.

Specified by:

borderAround in interface IXLSRange

Parameters:

borderLine - Represents border line.

borderAround

public void borderAround(LineStyleType borderLine,
                         java.awt.Color borderColor)

Sets around border for current range.

Specified by:

borderAround in interface IXLSRange

Parameters:

borderLine - Represents border line.

borderColor - Represents border color.

borderAround

public void borderAround(LineStyleType borderLine,
                         ExcelColors borderColor)

Sets around border for current range.

Specified by:

borderAround in interface IXLSRange

Parameters:

borderLine - Represents border line.

borderColor - Represents border color as ExcelColors.

borderInside

public void borderInside()

Sets inside border for current range.

Specified by:

borderInside in interface IXLSRange

borderInside

public void borderInside(LineStyleType borderLine)

Sets inside border for current range.

Specified by:

borderInside in interface IXLSRange

Parameters:

borderLine - Represents border line.

borderInside

public void borderInside(LineStyleType borderLine,
                         java.awt.Color borderColor)

Sets inside border for current range.

Specified by:

borderInside in interface IXLSRange

Parameters:

borderLine - Represents border line.

borderColor - Represents border color.

borderInside

public void borderInside(LineStyleType borderLine,
                         ExcelColors borderColor)

Sets inside border for current range.

Specified by:

borderInside in interface IXLSRange

Parameters:

borderLine - Represents border line.

borderColor - Represents border color as ExcelColors.

borderNone

public void borderNone()

Sets none border for current range.

Specified by:

borderNone in interface IXLSRange

collapseGroup

public void collapseGroup(GroupByType groupBy)

Collapses current group.

Specified by:

collapseGroup in interface IXLSRange

Parameters:

groupBy - This parameter specifies whether the grouping should be performed by rows or by columns.

expandGroup

public void expandGroup(GroupByType groupBy)

Expands current group.

Specified by:

expandGroup in interface IXLSRange

Parameters:

groupBy - This parameter specifies whether the grouping should be performed by rows or by columns.

expandGroup

public void expandGroup(GroupByType groupBy,
                        int flags)

Expands current group.

Specified by:

expandGroup in interface IXLSRange

Parameters:

groupBy - This parameter specifies whether the grouping should be performed by rows or by columns.

flags - Additional option flags.

getNewRangeLocation

public java.lang.String getNewRangeLocation(java.util.HashMap names,
                                            java.lang.String[] sheetName)

Gets new address of range.

Specified by:

getNewRangeLocation in interface ICombinedRange

Parameters:

names - HashTable with Worksheet names.

sheetName - String that sets as a worksheet name.

Returns:

Returns string with new name.

deepClone

public IXLSRange deepClone(java.lang.Object parent,
                           java.util.HashMap hashNewNames,
                           XlsWorkbook book)

Clones current IXLSRange.

Specified by:

deepClone in interface ICombinedRange

Parameters:

parent - Parent object.

hashNewNames - Hash table with new names.

book - Parent workbook.

Returns:

Returns clone of current instance.

getCellsCount

public int getCellsCount()

Number of cells in the range. Read-only.

Specified by:

getCellsCount in interface ICombinedRange

clearConditionalFormats

public void clearConditionalFormats()

Clears conditional formats.

Specified by:

clearConditionalFormats in interface ICombinedRange

getRectangles

public java.awt.Rectangle[] getRectangles()

Returns array that contains information about range.

Specified by:

getRectangles in interface ICombinedRange

Returns:

Rectangles that describes range

getRectanglesCount

public int getRectanglesCount()

Returns number of rectangles returned by GetRectangles method.

Specified by:

getRectanglesCount in interface ICombinedRange

Returns:

Number of rectangles returned by GetRectangles method.

getWorksheetName

public java.lang.String getWorksheetName()

Gets name of the parent worksheet.

Specified by:

getWorksheetName in interface ICombinedRange

remove

public void remove(IXLSRange range)

Removes range from the collection.

Specified by:

remove in interface IXLSRanges

Parameters:

range - Range to remove.

get

public IXLSRange get(int index)

Returns item by index from the collection.

Specified by:

get in interface IXLSRanges