public interface IRange
| Modifier and Type | Method and Description |
|---|---|
void |
activate()
Activates a single cell, which must be inside the current selection.
|
IComment |
addComment(java.lang.String text)
Adds comments to the current range.
|
ICommentThreaded |
addCommentThreaded(java.lang.String text)
Adds a threaded comment to the range.
|
ICommentThreaded |
addCommentThreaded(java.lang.String text,
java.lang.String author)
Adds a threaded comment to the range.
|
void |
autoFilter()
Filters a list using the AutoFilter.
Add a filter with no condition if there's no filter in the sheet. Or show all the data in the first column of the filter. |
void |
autoFilter(int field)
Filters a list using the AutoFilter.
|
void |
autoFilter(int field,
java.lang.Object criteria1)
Filters a list using the AutoFilter.
|
void |
autoFilter(int field,
java.lang.Object criteria1,
AutoFilterOperator op)
Filters a list using the AutoFilter.
|
void |
autoFilter(int field,
java.lang.Object criteria1,
AutoFilterOperator op,
java.lang.Object criteria2)
Filters a list using the AutoFilter.
|
void |
autoFilter(int field,
java.lang.Object criteria1,
AutoFilterOperator op,
java.lang.Object criteria2,
boolean visibleDropDown)
Filters a list using the AutoFilter.
|
void |
autoFit()
Changes the width of the columns in the range or the height of the rows in
the range to achieve the best fit.
|
void |
autoFit(boolean considerMergedCell)
Changes the width of the columns in the range or the height of the rows in
the range to achieve the best fit.
|
void |
calculate()
Calculates formulas of the range as needed.
|
ITextRun |
characters(int startIndex,
int length)
Returns a ITextRun object that represents a range of characters within the cell text.
|
void |
clear()
Clears formulas, values, and all formatting from the current range.
|
void |
clearComments()
Clears the comments from the current range
|
void |
clearCommentsThreaded()
Clears the threaded comments from the current range.
|
void |
clearContents()
Clears formulas and values from the current range.
|
void |
clearFormats()
Clears all formatting from the current range.
|
void |
clearHyperlinks()
Clears all hyperLinks from the current range.
|
void |
clearOutline()
Clears the outline for the specified range.
|
void |
copy(IRange destination)
Copies the range to the specified range
|
void |
copy(IRange destination,
java.util.EnumSet<PasteType> pasteType)
Deprecated.
This method is no longer acceptable to compute time between versions.
Use |
void |
copy(IRange destination,
PasteOption pasteOption)
Copies the range to the specified range.
|
void |
cut(IRange destination)
Cuts the range to the specified range.
|
void |
delete()
Deletes a cell or a range of cells from the worksheet and shifts other cells
to replace deleted cells.
|
void |
delete(DeleteShiftDirection shiftDirection)
Deletes a cell or a range of cells from the worksheet and shifts other cells
to replace deleted cells.
|
void |
dirty()
Designates all the formulas of the range to be recalculated when the next
calculation occurs.
|
IRange |
find(java.lang.Object what)
Finds specific information in a range, starts from the upper-left corner.
|
IRange |
find(java.lang.Object what,
FindOptions options)
Finds specific information in a range, starts from the upper-left corner.
|
IRange |
find(java.lang.Object what,
IRange after)
Finds specific information in a range.
|
IRange |
find(java.lang.Object what,
IRange after,
FindOptions options)
Finds specific information in a range.
|
void |
fromJson(java.lang.String json)
Generates the range data from the json string.
|
java.lang.String |
generateGetPivotDataFunction()
Generate the corresponding function "GETPIVOTDATA" for the cells in the pivot table.
|
java.lang.String |
generateGetPivotDataFunction(IRange destination)
Generate the corresponding function "GETPIVOTDATA" for the cells in the pivot table.
|
IRange |
get(int index)
Returns a new instance of
IRange by index which represents a cell. |
IRange |
get(int rowOffset,
int columnOffset)
Returns a new instance of
IRange which is offset from this range. |
boolean |
getAddIndent()
Gets the property which controls indentation of text when horizontal or
vertical alignment is set to distributed.
|
java.lang.String |
getAddress()
Returns a String value that represents the range reference.
|
java.lang.String |
getAddress(boolean rowAbsolute,
boolean columnAbsolute)
Returns a String value that represents the range reference.
|
java.lang.String |
getAddress(boolean rowAbsolute,
boolean columnAbsolute,
ReferenceStyle referenceStyle)
Returns a String value that represents the range reference.
|
java.lang.String |
getAddress(boolean rowAbsolute,
boolean columnAbsolute,
ReferenceStyle referenceStyle,
IRange relativeTo)
Returns a String value that represents the range reference.
|
IAreas |
getAreas()
Returns an instance of
IAreas which represents an array of ranges
where each range returned by areas represents one cell or range. |
java.lang.String |
getBindingPath()
Gets the binding path of the current cell or column.
|
IBorders |
getBorders()
Returns an instance of
IBorders which represents the cell borders of
the cell or range represented by this IRange. |
ICellPadding |
getCellPadding()
Gets the cell padding for range.
|
IRange |
getCells()
Returns the
IRange object that represents the cells in the specified
range. |
BaseCellType |
getCellType()
Gets the cell type for specified range in the sheet.
|
int |
getColumn()
Returns the zero based column number of the last column of the first range.
|
int |
getColumnCount()
Returns the column count of the first range.
|
IRange |
getColumns()
Returns the
IRange object that represents the columns in the
specified range. |
double |
getColumnWidth()
Gets the width of the individual columns represented in this range in
characters.
|
double |
getColumnWidthInPixel()
Gets the width of the individual columns represented in this range in pixels.
|
IComment |
getComment()
Returns an instance of
IComment which may be used to get and set
Comment properties of the cells. |
ICommentThreaded |
getCommentThreaded() |
int |
getCount()
Returns the number of objects in the collection.
|
IRange |
getCurrentArray()
Gets whether the specified cell is part of an array, returns an
IRange object that represents the entire array. |
java.util.List<IRange> |
getDependents()
Gets the dependent ranges of the left top cell of the range.
|
java.util.List<IRange> |
getDependents(boolean includeIndirect)
Gets the dependent ranges of all the cells of the range.
|
IDisplayFormat |
getDisplayFormat()
Gets a DisplayFormat object that represents the display settings for the
specified range.
|
IRange |
getEntireColumn()
Returns a new instance of
IRange which represents the same range of
cells, but expanded to include all rows. |
IRange |
getEntireMergeArea()
Returns an
IRange representing the area of the current range which is
iteratively grown as needed until it includes no partial merged cells. |
IRange |
getEntireRow()
Returns a new instance of
IRange which represents the same range of
cells, but expanded to include all columns. |
IFont |
getFont()
Returns an instance of
IFont which may be used to get and set font
properties of the cells represented by this IRange. |
IFormatConditions |
getFormatConditions()
Returns a FormatConditions collection that represents all the conditional
formats for the specified range.
|
java.lang.String |
getFormula()
Gets the formula of the cells represented by this range in A1-style notation.
|
java.lang.String |
getFormula2()
Gets the formula of the cells represented by this range in A1-style array notation.
|
java.lang.String |
getFormula2Local()
Gets the localized formula of the cells represented by this range in A1-style array notation.
|
java.lang.String |
getFormula2R1C1()
Gets the formula of the cells represented by this range in R1C1-style array notation.
|
java.lang.String |
getFormula2R1C1Local()
Gets the localized formula of the cells represented by this range in R1C1-style array notation.
|
java.lang.String |
getFormulaArray()
Gets the array formula of a range.
|
java.lang.String |
getFormulaArrayR1C1()
Gets the array formula of a range using ReferenceStyle.R1C1.
|
boolean |
getFormulaHidden()
Gets or Sets whether the formula will be hidden when the worksheet is
protected
|
java.lang.String |
getFormulaLocal()
Gets the localized formula of the cells represented by this range in A1-style notation.
|
java.lang.String |
getFormulaR1C1()
Gets the formula of the cells represented by this range in R1C1-style notation.
|
java.lang.String |
getFormulaR1C1Local()
Gets the localized formula of the cells represented by this range in R1C1-style notation.
|
boolean |
getHasArray()
Determines if the specified cell is part of an array formula.
|
boolean |
getHasFormula()
Returns true if the cell or range contains any formulas; otherwise, false is
returned.
|
boolean |
getHasValidation()
Returns true if any of the cells represented by this range have data
validation associated with them.
|
double |
getHeight()
Gets the height, in points, of the range.
|
double |
getHeightInPixel()
Gets the height, in pixels, of the range.
|
boolean |
getHidden()
Gets the property which specifies whether rows or columns should be hidden.
|
HorizontalAlignment |
getHorizontalAlignment()
Gets the
HorizontalAlignment of a cell or range. |
IHyperlinks |
getHyperlinks()
Returns an instance of
IValidation which may be used to get and set
HyperLinks properties. |
int |
getIndentLevel()
Gets the indent level of the specified cell(s).
|
IInterior |
getInterior()
Returns the
IInterior which represents the interior (background)
color and pattern of the specified cell(s). |
ILabelOptions |
getLabelOptions()
Gets the setting for watermark.
|
int |
getLastColumn()
Returns the zero based column number of the first column of this IRange.
|
int |
getLastRow()
Returns the zero based row number of the last row of the first range.
|
boolean |
getLocked()
Gets the property which specifies whether cells should be locked.
|
IRange |
getMergeArea()
Returns an
IRange representing the merged range containing the
specified cell. |
boolean |
getMergeCells()
Gets the property which specifies whether cells are merged.
|
java.lang.String |
getNumberFormat()
Gets the number format of the cells in the range.
|
int |
getOrientation()
Gets the text orientation of a cell or range, which may be from -90 to 90
degrees.
|
int |
getOutlineLevel()
Gets the current outline level of the specified row or column.
|
java.util.List<IRange> |
getPrecedents()
Gets the precedent ranges of the left top cell of the range.
|
java.util.List<IRange> |
getPrecedents(boolean includeInDirect)
Gets the precedent ranges of all the cells of the range.
|
ReadingOrder |
getReadingOrder()
Gets or Sets the reading order for the specified object.
|
IRichText |
getRichText()
Gets the rich text object associate with the top-left cell of this range.
|
int |
getRow()
Returns the zero based row number of the first row.
|
int |
getRowCount()
Returns the row count of the first range.
|
double |
getRowHeight()
Gets the height of the individual rows represented by this range in points.
|
double |
getRowHeightInPixel()
Gets the height of the individual rows represented by this range in pixels.
|
IRange |
getRows()
Returns the
IRange object that represents the rows in the specified
range. |
boolean |
getShowDetail()
Gets whether to show the detail (True if the outline is expanded for the
specified range, so that the detail of the column or row is visible).
|
boolean |
getShrinkToFit()
Gets the property which specifies whether cells will be drawn in a smaller
font if needed to display the contents of the cell.
|
ISparklineGroups |
getSparklineGroups()
Returns an instance of
ISparklineGroups which may be used to get and
set SparklineGroups properties of the cells |
IStyle |
getStyle()
Gets the named style
IStyle associated with the cells represented by
this IRange. |
boolean |
getSummary()
Determines if the range is an outlining summary row or column.
|
java.lang.Object |
getTag()
Gets the tag value of the specified range in the sheet.
|
java.lang.String |
getText()
Gets the value of the cell represented by this IRange as a formatted string.
|
boolean |
getUseStandardHeight()
Determines if the row height of the
IRange object equals the standard
height of the sheet. |
boolean |
getUseStandardWidth()
Determines if the column width of the
IRange object equals the
standard width of the sheet. |
IValidation |
getValidation()
Returns an instance of
IValidation which may be used to get and set
validation properties of the cells represented by this IRange. |
boolean |
getValidationIsSame()
Returns true if the validation options of all cells represented by this
IRange are the same; otherwise, false is returned. |
java.lang.Object |
getValue()
Gets the value of the specified range as a string, double, boolean,
Date, Object[][] or null; |
VerticalAlignment |
getVerticalAlignment()
Gets the
VerticalAlignment of a cell or range. |
java.lang.String |
getWatermark()
Gets the watermark for range.
|
double |
getWidth()
Gets the width, in points, of the range.
|
double |
getWidthInPixel()
Gets the width, in pixels, of the range.
|
IWorksheet |
getWorksheet()
Returns the parent
IWorksheet of this range. |
boolean |
getWrapText()
Get the flag which indicates whether word wrap is enabled in a cell.
|
void |
group()
Increments the OutlineLevel of the specified rows or columns.
|
void |
insert()
Inserts a cell or a range of cells into the worksheet and shifts other cells
away to make space.
|
void |
insert(InsertShiftDirection shiftDirection)
Inserts a cell or a range of cells into the worksheet and shifts other cells
away to make space.
|
boolean |
isRichText()
Indicates whether the cell string value is a rich text.
|
void |
merge()
Merges the cells in the represented range into a single merged cell.
|
void |
merge(boolean isAcross)
Merges the cells in the represented range into a single merged cell.
|
void |
removeSubtotal()
Removes subtotals from a list.
|
int |
replace(java.lang.Object what,
java.lang.Object replacement)
Search in formulas and replace.
|
int |
replace(java.lang.Object what,
java.lang.Object replacement,
ReplaceOptions options)
Search in formulas and replace.
|
void |
select()
Selects the object.
|
void |
setAddIndent(boolean value)
Sets the property which controls indentation of text when horizontal or
vertical alignment is set to distributed.
|
void |
setBindingPath(java.lang.String value)
Sets the binding path of the current cell or column.
|
void |
setCellPadding(ICellPadding cellPadding)
Sets the cell padding for range.
|
void |
setCellType(BaseCellType cellType)
Sets the cell type for specified range in the sheet.
|
void |
setColumnWidth(double value)
Sets the width of the individual columns represented in this range in
characters.
|
void |
setColumnWidthInPixel(double value)
Sets the width of the individual columns represented in this range in pixels.
|
void |
setFormula(java.lang.String value)
Sets the formula of the cells represented by this range in A1-style notation.
|
void |
setFormula2(java.lang.String value)
Sets the formula of the cells represented by this range in A1-style array notation.
|
void |
setFormula2Local(java.lang.String value)
Sets the localized formula of the cells represented by this range in A1-style array notation.
|
void |
setFormula2R1C1(java.lang.String value)
Sets the formula of the cells represented by this range in R1C1-style array notation.
|
void |
setFormula2R1C1Local(java.lang.String value)
Sets the localized formula of the cells represented by this range in R1C1-style array notation.
|
void |
setFormulaArray(java.lang.String value)
Sets the array formula of a range.
|
void |
setFormulaArrayR1C1(java.lang.String value)
Sets the array formula of a range using ReferenceStyle.R1C1.
|
void |
setFormulaHidden(boolean value)
Sets whether the formula will be hidden when the worksheet is protected
|
void |
setFormulaLocal(java.lang.String value)
Sets the localized formula of the cells represented by this range in A1-style notation.
|
void |
setFormulaR1C1(java.lang.String value)
Sets the formula of the cells represented by this range in R1C1-style notation.
|
void |
setFormulaR1C1Local(java.lang.String value)
Sets the localized formula of the cells represented by this range in R1C1-style notation.
|
void |
setHidden(boolean value)
Sets the property which specifies whether rows or columns should be hidden.
|
void |
setHorizontalAlignment(HorizontalAlignment value)
Sets the
HorizontalAlignment of a cell or range. |
void |
setIndentLevel(int value)
Sets the indent level of the specified cell(s).
|
void |
setLocked(boolean value)
Sets the property which specifies whether cells should be locked.
|
void |
setMergeCells(boolean value)
Sets the property which specifies whether cells are merged.
|
void |
setNumberFormat(java.lang.String value)
Sets the number format of the cells in the range.
|
void |
setOrientation(int value)
Sets the text orientation of a cell or range, which may be from -90 to 90
degrees.
|
void |
setOutlineLevel(int value)
Sets the current outline level of the specified row or column.
|
void |
setReadingOrder(ReadingOrder value)
Sets the reading order for the specified object.
|
void |
setRowHeight(double value)
Sets the height of the individual rows represented by this range in points.
|
void |
setRowHeightInPixel(double value)
Sets the height of the individual rows represented by this range in pixels.
|
void |
setShowDetail(boolean value)
Sets whether to show the detail (True if the outline is expanded for the
specified range, so that the detail of the column or row is visible).
|
void |
setShrinkToFit(boolean value)
Sets the property which specifies whether cells will be drawn in a smaller
font if needed to display the contents of the cell.
|
void |
setStyle(IStyle value)
Sets the named style
IStyle associated with the cells represented by
this IRange. |
void |
setTag(java.lang.Object value)
Sets the tag value of the specified range in the sheet.
|
void |
setUseStandardHeight(boolean value)
Determines if the row height of the
IRange object equals the standard
height of the sheet. |
void |
setUseStandardWidth(boolean value)
Determines if the column width of the
IRange object equals the
standard width of the sheet. |
void |
setValue(java.lang.Object value)
Sets the value of the specified cell as a string, double, int, boolean,
Date, Calendar, Object[][] or null. |
void |
setVerticalAlignment(VerticalAlignment value)
Sets the
VerticalAlignment of a cell or range. |
void |
setWatermark(java.lang.String watermark)
Sets the watermark for range.
|
void |
setWrapText(boolean value)
Sets the flag which indicates whether word wrap is enabled in a cell.
|
void |
sort(IRange key,
SortOrder order,
SortOrientation orientation)
Sorts the cells represented by this range according to the specified options.
|
void |
sort(IRange key,
SortOrder order,
SortOrientation orientation,
boolean caseSensitive)
Sorts the cells represented by this range according to the specified options.
|
void |
sort(SortOrientation orientation,
boolean caseSensitive,
IValueSortField... keys)
Sorts the cells represented by this range according to the specified options.
|
IRange |
specialCells(SpecialCellType type)
Gets a IRange object that represents all the cells that match the specified type and value.
|
IRange |
specialCells(SpecialCellType type,
SpecialCellsValue value)
Gets a IRange object that represents all the cells that match the specified type and value.
|
void |
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList)
Creates subtotals for the range.
|
void |
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace)
Creates subtotals for the range.
|
void |
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace,
boolean pageBreaks)
Creates subtotals for the range.
|
void |
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace,
boolean pageBreaks,
SummaryRow summaryRowLocation)
Creates subtotals for the range.
|
void |
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
SummaryRow summaryRowLocation)
Creates subtotals for the range.
|
void |
toImage(java.io.OutputStream stream,
ImageType imageType)
Saves the range to the specified image file.
|
void |
toImage(java.lang.String imageFile)
Saves the range to the specified image file.
|
java.lang.String |
toJson()
Generates a json string from the range.
|
void |
ungroup()
Decrements the OutlineLevel of the specified rows or columns.
|
void |
unmerge()
Converts merged cells in the represented range to normal cells.
|
IRange getColumns()
IRange object that represents the columns in the
specified range.IRange getCells()
IRange object that represents the cells in the specified
range.int getRow()
int getLastRow()
int getRowCount()
int getColumn()
int getLastColumn()
int getColumnCount()
int getCount()
IFont getFont()
IFont which may be used to get and set font
properties of the cells represented by this IRange.IBorders getBorders()
IBorders which represents the cell borders of
the cell or range represented by this IRange.IInterior getInterior()
IInterior which represents the interior (background)
color and pattern of the specified cell(s).java.lang.String getNumberFormat()
void setNumberFormat(java.lang.String value)
boolean getAddIndent()
void setAddIndent(boolean value)
int getIndentLevel()
void setIndentLevel(int value)
boolean getHidden()
void setHidden(boolean value)
boolean getLocked()
void setLocked(boolean value)
int getOrientation()
void setOrientation(int value)
boolean getShrinkToFit()
void setShrinkToFit(boolean value)
boolean getWrapText()
void setWrapText(boolean value)
HorizontalAlignment getHorizontalAlignment()
HorizontalAlignment of a cell or range.void setHorizontalAlignment(HorizontalAlignment value)
HorizontalAlignment of a cell or range.VerticalAlignment getVerticalAlignment()
VerticalAlignment of a cell or range.void setVerticalAlignment(VerticalAlignment value)
VerticalAlignment of a cell or range.IDisplayFormat getDisplayFormat()
boolean getFormulaHidden()
void setFormulaHidden(boolean value)
ReadingOrder getReadingOrder()
void setReadingOrder(ReadingOrder value)
IStyle getStyle()
IStyle associated with the cells represented by
this IRange.void setStyle(IStyle value)
IStyle associated with the cells represented by
this IRange.IValidation getValidation()
IValidation which may be used to get and set
validation properties of the cells represented by this IRange.IHyperlinks getHyperlinks()
IValidation which may be used to get and set
HyperLinks properties.IComment getComment()
IComment which may be used to get and set
Comment properties of the cells.ISparklineGroups getSparklineGroups()
ISparklineGroups which may be used to get and
set SparklineGroups properties of the cellsIWorksheet getWorksheet()
IWorksheet of this range.IRange getEntireRow()
IRange which represents the same range of
cells, but expanded to include all columns.IRange getEntireColumn()
IRange which represents the same range of
cells, but expanded to include all rows.IRange getEntireMergeArea()
IRange representing the area of the current range which is
iteratively grown as needed until it includes no partial merged cells.IRange getMergeArea()
IRange representing the merged range containing the
specified cell. If the specified cell isn't in a merged range, this property
returns the specified cell.java.lang.String getFormula()
void setFormula(java.lang.String value)
java.lang.String getFormulaLocal()
void setFormulaLocal(java.lang.String value)
java.lang.String getFormulaR1C1()
void setFormulaR1C1(java.lang.String value)
java.lang.String getFormulaR1C1Local()
void setFormulaR1C1Local(java.lang.String value)
java.lang.String getFormula2()
void setFormula2(java.lang.String value)
java.lang.String getFormula2Local()
void setFormula2Local(java.lang.String value)
java.lang.String getFormula2R1C1()
void setFormula2R1C1(java.lang.String value)
java.lang.String getFormula2R1C1Local()
void setFormula2R1C1Local(java.lang.String value)
java.lang.String getFormulaArray()
void setFormulaArray(java.lang.String value)
java.lang.String getFormulaArrayR1C1()
void setFormulaArrayR1C1(java.lang.String value)
IRange getCurrentArray()
IRange object that represents the entire array.boolean getHasFormula()
boolean getHasArray()
java.lang.Object getValue()
Date, Object[][] or null;void setValue(java.lang.Object value)
Date, Calendar, Object[][] or null.java.lang.Object getTag()
void setTag(java.lang.Object value)
BaseCellType getCellType()
void setCellType(BaseCellType cellType)
java.lang.String getBindingPath()
void setBindingPath(java.lang.String value)
java.lang.String getText()
IAreas getAreas()
IAreas which represents an array of ranges
where each range returned by areas represents one cell or range.IRange get(int rowOffset, int columnOffset)
IRange which is offset from this range.rowOffset - The row offset.columnOffset - The column offset.IRange get(int index)
IRange by index which represents a cell.index - boolean getMergeCells()
void setMergeCells(boolean value)
void merge()
void merge(boolean isAcross)
isAcross - Optional Object. True to merge cells in each row of the
specified range as separate merged cells. The default value
is False.void unmerge()
void insert()
void insert(InsertShiftDirection shiftDirection)
shiftDirection - Specifies which way to shift the cells.void delete()
void delete(DeleteShiftDirection shiftDirection)
shiftDirection - Specifies which way to shift the cells.void clear()
void clearContents()
void clearFormats()
void clearHyperlinks()
void clearComments()
void clearCommentsThreaded()
IComment addComment(java.lang.String text)
text - The text you want to add.void sort(SortOrientation orientation, boolean caseSensitive, IValueSortField... keys)
orientation - The orientation.caseSensitive - if set to true, case sensitive.keys - The IValueSortField array.void sort(IRange key, SortOrder order, SortOrientation orientation, boolean caseSensitive)
key - The key of the sort column.order - The sort order, ascending or dscendingorientation - The orientation.caseSensitive - if set to true, case sensitive.void sort(IRange key, SortOrder order, SortOrientation orientation)
key - The key of the sort column.order - The sort order, ascending or dscendingorientation - The orientation.void autoFilter(int field,
java.lang.Object criteria1,
AutoFilterOperator op,
java.lang.Object criteria2,
boolean visibleDropDown)
field - Optional Object. The integer offset of the field on
which you want to base the filter (from the left of
the list; the leftmost field is field zero).criteria1 - Optional Object. The criteria (a string; for example,
"101"). Use "=" to find blank fields, or use
"]]>" to find nonblank fields. If this
argument is omitted, the criteria is All. If Operator
is xlTop10Items, Criteria1 specifies the number of
items (for example, "10").op - Optional AutoFilterOperatorcriteria2 - Optional Object. The second criteria (a string). Used
with Criteria1 and Operator to construct compound
criteria.visibleDropDown - Optional Object. True to display the AutoFilter
drop-down arrow for the filtered field; False to hide
the AutoFilter drop-down arrow for the filtered field.
True by default.void autoFilter(int field)
field - Optional Object. The integer offset of the field on which you
want to base the filter (from the left of the list; the leftmost
field is field zero).void autoFilter()
void autoFilter(int field,
java.lang.Object criteria1)
field - Optional Object. The integer offset of the field on which
you want to base the filter (from the left of the list; the
leftmost field is field zero).criteria1 - Optional Object. The criteria (a string; for example,
"101"). Use "=" to find blank fields, or use
"]]>" to find nonblank fields. If this argument
is omitted, the criteria is All. If Operator is
xlTop10Items, Criteria1 specifies the number of items (for
example, "10").void autoFilter(int field,
java.lang.Object criteria1,
AutoFilterOperator op)
field - Optional Object. The integer offset of the field on which
you want to base the filter (from the left of the list; the
leftmost field is field zero).criteria1 - Optional Object. The criteria (a string; for example,
"101"). Use "=" to find blank fields, or use
"]]>" to find nonblank fields. If this argument
is omitted, the criteria is All. If Operator is
xlTop10Items, Criteria1 specifies the number of items (for
example, "10").op - Optional AutoFilterOperatorvoid autoFilter(int field,
java.lang.Object criteria1,
AutoFilterOperator op,
java.lang.Object criteria2)
field - Optional Object. The integer offset of the field on which
you want to base the filter (from the left of the list; the
leftmost field is field zero).criteria1 - Optional Object. The criteria (a string; for example,
"101"). Use "=" to find blank fields, or use
"]]>" to find nonblank fields. If this argument
is omitted, the criteria is All. If Operator is
xlTop10Items, Criteria1 specifies the number of items (for
example, "10").op - Optional AutoFilterOperatorcriteria2 - Optional Object. The second criteria (a string). Used with
Criteria1 and Operator to construct compound criteria.double getWidth()
double getWidthInPixel()
double getColumnWidth()
void setColumnWidth(double value)
double getColumnWidthInPixel()
void setColumnWidthInPixel(double value)
double getHeight()
double getHeightInPixel()
double getRowHeight()
void setRowHeight(double value)
double getRowHeightInPixel()
void setRowHeightInPixel(double value)
IFormatConditions getFormatConditions()
void clearOutline()
void group()
void ungroup()
int getOutlineLevel()
void setOutlineLevel(int value)
boolean getShowDetail()
The following statements are true: 1.The range must be in a single summary row or column. 2.This property returns False if any of the children of the row or column are hidden. 3.Setting this property to True is equivalent to unhiding all the children of the summary row or column. 4.Setting this property to False is equivalent to hiding all the children of the summary row or column.
void setShowDetail(boolean value)
The following statements are true: 1.The range must be in a single summary row or column. 2.This property returns False if any of the children of the row or column are hidden. 3.Setting this property to True is equivalent to unhiding all the children of the summary row or column. 4.Setting this property to False is equivalent to hiding all the children of the summary row or column.
boolean getSummary()
void activate()
void select()
void copy(IRange destination)
@Deprecated void copy(IRange destination, java.util.EnumSet<PasteType> pasteType)
Use copy(IRange, PasteOption) instead.
destination - Specifies the new range to which the specified range will
be pasted. It can be the range of the same or another
workbook.pasteType - Specifies the part of the range to be pasted.void copy(IRange destination, PasteOption pasteOption)
destination - Specifies the new range to which the specified range will
be pasted. It can be the range of the same or another
workbook.pasteOption - Specifies the part of the range to be pasted and
whether to include hidden range.void cut(IRange destination)
destination - Specifies the new range to which the specified range will
be pasted. It can be the range of the same or another
workbook.boolean getHasValidation()
boolean getValidationIsSame()
IRange are the same; otherwise, false is returned.boolean getUseStandardHeight()
IRange object equals the standard
height of the sheet.void setUseStandardHeight(boolean value)
IRange object equals the standard
height of the sheet.boolean getUseStandardWidth()
IRange object equals the
standard width of the sheet.void setUseStandardWidth(boolean value)
IRange object equals the
standard width of the sheet.void calculate()
void dirty()
boolean isRichText()
IRichText getRichText()
ITextRun characters(int startIndex, int length)
IRange find(java.lang.Object what, IRange after, FindOptions options)
what - The data to search for. Can be a String, double, Date,
Calendar, boolean or int.after - The cell after which you want the search to begin. This
corresponds to the position of the active cell when a search
is done from the user interface. Notice that After must be a
single cell in the range. Remember that the search begins
after this cell; the specified cell isn't searched until the
method wraps back around to this cell. If you do not specify
this argument, the search starts at the cell in the upper-left
corner of the range when FindOptions.SearchDirection is
SearchDirection.Next, or at the cell in the bottom-right
corner of the range when FindOptions.SearchDirection is
SearchDirection.Previous.options - The find optionsIRange find(java.lang.Object what, IRange after)
what - The data to search for. Can be a String, double, Date,
LocalDateTime, Calendar, boolean or int.after - The cell after which you want the search to begin. This
corresponds to the position of the active cell when a search is
done from the user interface. Notice that After must be a single
cell in the range. Remember that the search begins after this
cell; the specified cell isn't searched until the method wraps
back around to this cell. If you do not specify this argument,
the search starts at the cell in the upper-left corner of the
range when FindOptions.SearchDirection is SearchDirection.Next,
or at the cell in the bottom-right corner of the range when
FindOptions.SearchDirection is SearchDirection.Previous.IRange find(java.lang.Object what)
what - The data to search for. Can be a String, double, Date,
LocalDateTime, Calendar, boolean or int.IRange find(java.lang.Object what, FindOptions options)
what - The data to search for. Can be a String, double, Date,
LocalDateTime, Calendar, boolean or int.options - The find optionsint replace(java.lang.Object what,
java.lang.Object replacement)
what - The string you want to search for.replacement - The replacement string.int replace(java.lang.Object what,
java.lang.Object replacement,
ReplaceOptions options)
what - The string you want to search for.replacement - The replacement string.options - The replace options.void autoFit()
void autoFit(boolean considerMergedCell)
considerMergedCell - Indicates whether to consider merged cells in a single row.void subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList)
groupBy - The field to group by, as a one-based integer offset.subtotalFunction - The subtotal function.totalList - An array of 1-based field offsets, indicating the fields to which the subtotals are added.void subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace)
groupBy - The field to group by, as a one-based integer offset.subtotalFunction - The subtotal function.totalList - An array of 1-based field offsets, indicating the fields to which the subtotals are added.replace - True to replace existing subtotals. The default value is True.void subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace,
boolean pageBreaks)
groupBy - The field to group by, as a one-based integer offset.subtotalFunction - The subtotal function.totalList - An array of 1-based field offsets, indicating the fields to which the subtotals are added.replace - True to replace existing subtotals. The default value is True.pageBreaks - True to add page breaks after each group. The default value is False.void subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
SummaryRow summaryRowLocation)
groupBy - The field to group by, as a one-based integer offset.subtotalFunction - The subtotal function.totalList - An array of 1-based field offsets, indicating the fields to which the subtotals are added.summaryRowLocation - Places the summary data relative to the subtotal. The default value is Below.void subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace,
boolean pageBreaks,
SummaryRow summaryRowLocation)
groupBy - The field to group by, as a one-based integer offset.subtotalFunction - The subtotal function.totalList - An array of 1-based field offsets, indicating the fields to which the subtotals are added.replace - True to replace existing subtotals. The default value is True.pageBreaks - True to add page breaks after each group. The default value is False.summaryRowLocation - Places the summary data relative to the subtotal. The default value is Below.void removeSubtotal()
java.util.List<IRange> getPrecedents()
java.util.List<IRange> getPrecedents(boolean includeInDirect)
includeInDirect - java.util.List<IRange> getDependents()
java.util.List<IRange> getDependents(boolean includeIndirect)
includeIndirect - Include the indirect dependent cells.void toImage(java.lang.String imageFile)
imageFile - The output image file.void toImage(java.io.OutputStream stream,
ImageType imageType)
stream - The output image stream.imageType - Specifies the type of image to create.java.lang.String getAddress()
java.lang.String getAddress(boolean rowAbsolute,
boolean columnAbsolute)
columnAbsolute - True to return the column part of the reference as an absolute reference.
The default value is true.rowAbsolute - True to return the row part of the reference as an absolute reference.
The default value is true.java.lang.String getAddress(boolean rowAbsolute,
boolean columnAbsolute,
ReferenceStyle referenceStyle)
columnAbsolute - True to return the column part of the reference as an absolute reference.
The default value is true.rowAbsolute - True to return the row part of the reference as an absolute reference.
The default value is true.referenceStyle - The reference style. The default value is A1.java.lang.String getAddress(boolean rowAbsolute,
boolean columnAbsolute,
ReferenceStyle referenceStyle,
IRange relativeTo)
columnAbsolute - True to return the column part of the reference as an absolute reference.
The default value is true.rowAbsolute - True to return the row part of the reference as an absolute reference.
The default value is true.referenceStyle - The reference style. The default value is A1.relativeTo - If RowAbsolute and ColumnAbsolute are false,
and ReferenceStyle is R1C1,
defines a starting point for the relative reference.
The default reference is $A$1.IRange specialCells(SpecialCellType type)
IRange specialCells(SpecialCellType type, SpecialCellsValue value)
ICellPadding getCellPadding()
ICellPadding object
SpreadJS only.void setCellPadding(ICellPadding cellPadding)
cellPadding - SpreadJS only.java.lang.String getWatermark()
void setWatermark(java.lang.String watermark)
watermark - SpreadJS only.ILabelOptions getLabelOptions()
ILabelOptions object
SpreadJS only.void fromJson(java.lang.String json)
json - the json string that contains range info.java.lang.String toJson()
ICommentThreaded addCommentThreaded(java.lang.String text)
text - The string is content of the threaded comment.ICommentThreaded addCommentThreaded(java.lang.String text, java.lang.String author)
text - The string is content of the threaded comment.author - Author name of the threaded comment.ICommentThreaded getCommentThreaded()
java.lang.String generateGetPivotDataFunction(IRange destination)
destination - Indicates for which area the "GETPIVOTDATA" function is generated.java.lang.String generateGetPivotDataFunction()