ixlsrange-ag凯发旗舰厅

com.spire.xls.core
interface ixlsrange

all superinterfaces:

java.lang.iterable

all known subinterfaces:

icombinedrange, imigrantrange

all known implementing classes:

cellrange, xlsname, xlsrange, xlsrangescollection

public interface ixlsrange
extends java.lang.iterable

represents a cell, row, column, selection of cells containing one or more contiguous blocks of cells, or a 3-d range.

getrangeaddress

java.lang.string getrangeaddress()

returns the range reference in the language of the macro. read-only string.

getrangeaddresslocal

java.lang.string getrangeaddresslocal()

returns the range reference for the specified range in the language of the user. read-only string.

getrangeglobaladdress

java.lang.string getrangeglobaladdress()

returns range address in format "'sheet1'!$a$1".

getranger1c1address

java.lang.string getranger1c1address()

returns the range reference using r1c1 notation. read-only string.

getranger1c1addresslocal

java.lang.string getranger1c1addresslocal()

returns the range reference using r1c1 notation. read-only string.

getbooleanvalue

boolean getbooleanvalue()

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

setbooleanvalue

void setbooleanvalue(boolean value)

sets boolean value that is contained by this range.

parameters:

value -

getborders

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

getcelllist

java.util.arraylist<cellrange> getcelllist()

returns a range object that represents the cells in the specified range. read-only.

getcolumn

int getcolumn()

returns the number of the first column in the first area in the specified range. read-only.

getcolumngrouplevel

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.

getcolumnwidth

double getcolumnwidth()

returns or sets the width of all columns in the specified range. read/write double.

getcount

int getcount()

returns the number of objects in the collection. read-only.

getdatetimevalue

java.util.date getdatetimevalue()

gets / sets datetime contained by this cell. read-write datetime.

getnumbertext

java.lang.string getnumbertext()

returns cell value after number format application. read-only.

getendcell

ixlsrange getendcell()

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

getentirecolumn

ixlsrange getentirecolumn()

returns a range object that represents the entire column (or columns) that contains the specified range. read-only.

getentirerow

ixlsrange getentirerow()

returns a range object that represents the entire row (or rows) that contains the specified range. read-only.

geterrorvalue

java.lang.string geterrorvalue()

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

getformula

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.

getformulaarray

java.lang.string getformulaarray()

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

getformulaarrayr1c1

java.lang.string getformulaarrayr1c1()

returns or sets the formula array for the range, using r1c1-style notation.

isformulahidden

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.

getinnerformuladatetime

com.spire.ms.system.datetime getinnerformuladatetime()

get / set formula datetime value contained by this cell. datetime.minvalue if not all cells of the range have same datetime value.

getformular1c1

java.lang.string getformular1c1()

returns or sets the formula for the range, using r1c1-style notation.

getformulaboolvalue

boolean getformulaboolvalue()

returns the calculated value of the formula as a boolean.

getformulaerrorvalue

java.lang.string getformulaerrorvalue()

returns the calculated value of the formula as a string.

hasdatavalidation

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.

hasboolean

boolean hasboolean()

indicates whether range contains bool value. read-only.

hasdatetime

boolean hasdatetime()

indicates whether range contains datetime value. read-only.

hasformula

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.

hasformulaarray

boolean hasformulaarray()

indicates whether range contains array-entered formula. read-only.

hasformuladatetime

boolean hasformuladatetime()

indicates if current range has formula value formatted as datetime. read-only.

hasformulanumbervalue

boolean hasformulanumbervalue()

indicates if the current range has formula number value. read-only.

hasformulastringvalue

boolean hasformulastringvalue()

indicates if the current range has formula string value. read-only.

hasnumber

boolean hasnumber()

indicates whether the range contains number. read-only.

hasrichtext

boolean hasrichtext()

indicates whether cell contains formatted rich text string.

hasstring

boolean hasstring()

indicates whether the range contains string. read-only.

hasstyle

boolean hasstyle()

indicates whether range has default style. false means default style. read-only.

gethorizontalalignment

horizontalaligntype gethorizontalalignment()

returns or sets the horizontal alignment for the specified object. read/write horizontalaligntype.

getindentlevel

int getindentlevel()

returns or sets the indent level for the cell or range. can be an integer from 0 to 15. read/write integer.

isblank

boolean isblank()

indicates whether the range is blank. read-only.

haserror

boolean haserror()

indicates whether range contains error value.

isgroupedbycolumn

boolean isgroupedbycolumn()

indicates whether this range is grouped by column. read-only.

isgroupedbyrow

boolean isgroupedbyrow()

indicates whether this range is grouped by row. read-only.

isinitialized

boolean isinitialized()

indicates whether cell is initialized. read-only.

getlastcolumn

int getlastcolumn()

returns last column of the range. read-only.

getlastrow

int getlastrow()

returns last row of the range. read-only.

getnumbervalue

double getnumbervalue()

gets / sets double value of the range.

getnumberformat

java.lang.string getnumberformat()

format of current cell. analog of style.numberformat property.

getrow

int getrow()

returns the number of the first row of the first area in the range. read-only long.

getrowgrouplevel

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.

getrowheight

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.

getrows

ixlsrange[] getrows()

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

getcolumns

ixlsrange[] getcolumns()

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

getstyle

istyle getstyle()

returns a style object that represents the style of the specified range. read/write istyle.

getcellstylename

java.lang.string getcellstylename()

returns name of the style object that represents the style of the specified range. read/write string.

gettext

java.lang.string gettext()

gets / sets string value of the range.

gettimespanvalue

com.spire.ms.system.timespan gettimespanvalue()

gets / sets time value of the range.

getvalue

java.lang.string getvalue()

returns or sets the value of the specified range. read/write variant.

setvalue

void setvalue(java.lang.string value)

sets the value of the specified range.

parameters:

value -

getenvalutedvalue

java.lang.string getenvalutedvalue()

returns the calculated value of a formula using the most current inputs.

getvalue2

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.

returns:

setobjectvalue

void setobjectvalue(java.lang.object value)

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.

parameters:

value -

getverticalalignment

verticalaligntype getverticalalignment()

returns or sets the vertical alignment of the specified object. read/write verticalaligntype.

setverticalalignment

void setverticalalignment(verticalaligntype value)

sets the vertical alignment of the specified object.

parameters:

value -

getworksheet

iworksheet getworksheet()

returns a worksheet object that represents the worksheet containing the specified range. read-only.

get

ixlsrange get(int row,
              int column)

gets / sets cell by row and column index. row and column indexes are one-based.

set

void set(int row,
         int column,
         ixlsrange value)

sets cell by row and column index. row and column indexes are one-based.

parameters:

row -

column -

value -

get

ixlsrange get(int row,
              int column,
              int lastrow,
              int lastcolumn)

get cell range. row and column indexes are one-based. read-only.

get

ixlsrange get(java.lang.string name)

get cell range. read-only.

get

ixlsrange get(java.lang.string name,
              boolean isr1c1notation)

gets cell range. read-only.

getconditionalformats

conditionalformats getconditionalformats()

collection of conditional formats.

getdatavalidation

validation getdatavalidation()

data validation for the range.

getformulastringvalue

java.lang.string getformulastringvalue()

gets / sets string value evaluated by formula.

setformulastringvalue

void setformulastringvalue(java.lang.string value)

sets string value evaluated by formula.

parameters:

value -

getformulanumbervalue

double getformulanumbervalue()

gets / sets number value evaluated by formula.

setformulanumbervalue

void setformulanumbervalue(double value)

sets number value evaluated by formula.

parameters:

value -

hasformulaboolvalue

boolean hasformulaboolvalue()

indicates if current range has formula bool value. read only.

hasformulaerrorvalue

boolean hasformulaerrorvalue()

indicates if current range has formula error value. read only.

getcomment

icommentshape getcomment()

comment assigned to the range. read-only.

getrichtext

irichtextstring getrichtext()

string with rich text formatting. read-only.

gethtmlstring

java.lang.string gethtmlstring()

gets the html string which contains data and some formattings in this cell.

returns:

sethtmlstring

void sethtmlstring(java.lang.string value)

sets the html string which contains data and some formattings in this cell.

parameters:

value -

hasmerged

boolean hasmerged()

indicates whether this range is part of merged range. read-only.

getmergearea

ixlsrange getmergearea()

returns a range object that represents the merged range containing the specified cell. if the specified cell isn�t in a merged range, this property returns null. read-only.

iswraptext

boolean iswraptext()

true if microsoft excel wraps the text in the object. read/write boolean.

iswraptext

void iswraptext(boolean value)

true if microsoft excel wraps the text in the object. read/write boolean.

parameters:

value -

hasexternalformula

boolean hasexternalformula()

indicates is current range has external formula. read-only.

getignoreerroroptions

java.util.enumset<ignoreerrortype> getignoreerroroptions()

represents ignore error options.

returns:

setignoreerroroptions

void setignoreerroroptions(java.util.enumset<ignoreerrortype> value)

represents ignore error options.

parameters:

value -

isstringspreserved

java.lang.boolean isstringspreserved()

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

isstringspreserved

void isstringspreserved(java.lang.boolean value)

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

parameters:

value -

getbuiltinstyle

builtinstyles getbuiltinstyle()

gets/sets built in style.

setbuiltinstyle

void setbuiltinstyle(builtinstyles value)

sets built in style.

parameters:

value -

activate

ixlsrange activate(boolean scroll)

activates a single cell, which must be inside the current selection. to select a range of cells, use the select method.

parameters:

scroll - true to scroll to the cell

returns:

/ //icellrange activate(); /** activates a single cell, scroll to it and activates the corresponding sheet. to select a range of cells, use the select method.

merge

void merge()

merge

void merge(boolean clearcells)

creates a merged cell from the specified range object.

parameters:

clearcells - indicates whether to clear unnecessary cells.

unmerge

void unmerge()

separates a merged area into individual cells.

freezepanes

void freezepanes()

freezes pane at the current range.

clearcontents

void clearcontents()

clear the contents of the range.

clear

void clear(excelclearoptions option)

clears the cell content, formats, comments based on clear option.

parameters:

option -

intersect

ixlsrange intersect(ixlsrange range)

returns intersection of this range with the specified one.

parameters:

range - the range with which to intersect.

returns:

range intersection; if there is no intersection, null is returned.

merge

ixlsrange merge(ixlsrange range)

returns merge of this range with the specified one.

parameters:

range - the range to merge with.

returns:

merged ranges or null if wasn't able to merge ranges.

autofitrows

void autofitrows()

autofits all rows in the range.

autofitcolumns

void autofitcolumns()

autofits all columns in the range.

addcomment

icommentshape addcomment()

adds comment to the range.

returns:

range's comment.

borderaround

void borderaround()

sets around border for current range.

borderaround

void borderaround(linestyletype borderline)

sets around border for current range.

parameters:

borderline - represents border line.

borderaround

void borderaround(linestyletype borderline,
                  java.awt.color bordercolor)

sets around border for current range.

parameters:

borderline - represents border line.

bordercolor - represents border color.

borderaround

void borderaround(linestyletype borderline,
                  excelcolors bordercolor)

sets around border for current range.

parameters:

borderline - represents border line.

bordercolor - represents border color as excelcolors.

borderinside

void borderinside()

sets inside border for current range.

borderinside

void borderinside(linestyletype borderline)

sets inside border for current range.

parameters:

borderline - represents border line.

borderinside

void borderinside(linestyletype borderline,
                  java.awt.color bordercolor)

sets inside border for current range.

parameters:

borderline - represents border line.

bordercolor - represents border color.

borderinside

void borderinside(linestyletype borderline,
                  excelcolors bordercolor)

sets inside border for current range.

parameters:

borderline - represents border line.

bordercolor - represents border color as excelcolors.

bordernone

void bordernone()

sets none border for current range.

collapsegroup

void collapsegroup(groupbytype groupby)

collapses current group.

parameters:

groupby - this parameter specifies whether the grouping should be performed by rows or by columns.

expandgroup

void expandgroup(groupbytype groupby)

expands current group.

parameters:

groupby - this parameter specifies whether the grouping should be performed by rows or by columns.

expandgroup

void expandgroup(groupbytype groupby,
                 expandcollapseflags flags)

expands current group.

parameters:

groupby - this parameter specifies whether the grouping should be performed by rows or by columns.

flags - additional option flags.