|
|||||||||
prev class next class | frames no frames | ||||||||
summary: nested | field | constr | method | detail: field | constr | method |
java.lang.objectcom.spire.ms.system.collections.collectionbase
![]()
com.spire.xls.core.spreadsheet.collections.xlsrangescollection
public class xlsrangescollection
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,
expandcollapseflags 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. |
java.lang.string |
gethtmlstring()
gets the html string which contains data and some formattings in this cell. |
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 |
sethtmlstring(java.lang.string value)
sets the html string which contains data and some formattings in 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 |
---|
public xlsrangescollection(java.lang.object parent)
parent
- parent object.method detail |
---|
public java.lang.string getrangeaddress()
getrangeaddress
in interface ixlsrange
public java.lang.string getrangeaddresslocal()
getrangeaddresslocal
in interface ixlsrange
public java.lang.string getrangeglobaladdress()
getrangeglobaladdress
in interface ixlsrange
public java.lang.string getranger1c1address()
getranger1c1address
in interface ixlsrange
public java.lang.string getranger1c1addresslocal()
getranger1c1addresslocal
in interface ixlsrange
public boolean getbooleanvalue()
getbooleanvalue
in interface ixlsrange
public iborders getborders()
getborders
in interface ixlsrange
public int getcolumn()
getcolumn
in interface ixlsrange
public int getcolumngrouplevel()
getcolumngrouplevel
in interface ixlsrange
public double getcolumnwidth()
getcolumnwidth
in interface ixlsrange
public int getcount()
getcount
in interface ixlsrange
public java.util.date getdatetimevalue()
getdatetimevalue
in interface ixlsrange
public void setdatetimevalue(java.util.date data)
public java.lang.string getnumbertext()
getnumbertext
in interface ixlsrange
public ixlsrange getendcell()
getendcell
in interface ixlsrange
public ixlsrange getentirecolumn()
getentirecolumn
in interface ixlsrange
public ixlsrange getentirerow()
getentirerow
in interface ixlsrange
public java.lang.string geterrorvalue()
geterrorvalue
in interface ixlsrange
public java.lang.string getformula()
getformula
in interface ixlsrange
public java.lang.string getformular1c1()
getformular1c1
in interface ixlsrange
public java.lang.string getformulaarray()
getformulaarray
in interface ixlsrange
public java.lang.string getformulaarrayr1c1()
getformulaarrayr1c1
in interface ixlsrange
public boolean isformulahidden()
isformulahidden
in interface ixlsrange
public java.util.date getformuladatetime()
public void setformuladatetime(java.util.date data)
public boolean hasdatavalidation()
hasdatavalidation
in interface ixlsrange
public boolean hasboolean()
hasboolean
in interface ixlsrange
public boolean hasdatetime()
hasdatetime
in interface ixlsrange
public boolean hasformulaboolvalue()
hasformulaboolvalue
in interface ixlsrange
public boolean hasformulaerrorvalue()
hasformulaerrorvalue
in interface ixlsrange
public boolean hasformuladatetime()
hasformuladatetime
in interface ixlsrange
public boolean hasformula()
hasformula
in interface ixlsrange
public boolean hasformulaarray()
hasformulaarray
in interface ixlsrange
public boolean hasnumber()
hasnumber
in interface ixlsrange
public boolean hasrichtext()
hasrichtext
in interface ixlsrange
public boolean hasstring()
hasstring
in interface ixlsrange
public boolean hasstyle()
hasstyle
in interface ixlsrange
public horizontalaligntype gethorizontalalignment()
gethorizontalalignment
in interface ixlsrange
public ihyperlinks gethyperlinks()
public int getindentlevel()
getindentlevel
in interface ixlsrange
public boolean isblank()
isblank
in interface ixlsrange
public boolean haserror()
haserror
in interface ixlsrange
public boolean isgroupedbycolumn()
isgroupedbycolumn
in interface ixlsrange
public boolean isgroupedbyrow()
isgroupedbyrow
in interface ixlsrange
public boolean isinitialized()
isinitialized
in interface ixlsrange
public int getlastcolumn()
getlastcolumn
in interface ixlsrange
public int getlastrow()
getlastrow
in interface ixlsrange
public double getnumbervalue()
getnumbervalue
in interface ixlsrange
public java.lang.string getnumberformat()
getnumberformat
in interface ixlsrange
public int getrow()
getrow
in interface ixlsrange
public int getrowgrouplevel()
getrowgrouplevel
in interface ixlsrange
public double getrowheight()
getrowheight
in interface ixlsrange
public ixlsrange[] getrows()
getrows
in interface ixlsrange
public ixlsrange[] getcolumns()
getcolumns
in interface ixlsrange
public istyle getstyle()
getstyle
in interface ixlsrange
public java.lang.string getcellstylename()
getcellstylename
in interface ixlsrange
public java.lang.string gettext()
gettext
in interface ixlsrange
public com.spire.ms.system.timespan gettimespanvalue()
gettimespanvalue
in interface ixlsrange
public java.lang.string getvalue()
getvalue
in interface ixlsrange
public java.lang.object getvalue2()
getvalue2
in interface ixlsrange
public verticalaligntype getverticalalignment()
getverticalalignment
in interface ixlsrange
public iworksheet getworksheet()
getworksheet
in interface ixlsrange
public ixlsrange get(int row, int column)
get
in interface ixlsrange
public ixlsrange get(int row, int column, int lastrow, int lastcolumn)
get
in interface ixlsrange
public ixlsrange get(java.lang.string name)
get
in interface ixlsrange
public ixlsrange get(java.lang.string name, boolean isr1c1notation)
get
in interface ixlsrange
public conditionalformats getconditionalformats()
getconditionalformats
in interface ixlsrange
public validation getdatavalidation()
getdatavalidation
in interface ixlsrange
public java.lang.string getformulastringvalue()
ixlsrange
getformulastringvalue
in interface ixlsrange
public double getformulanumbervalue()
ixlsrange
getformulanumbervalue
in interface ixlsrange
public boolean getformulaboolvalue()
getformulaboolvalue
in interface ixlsrange
public java.lang.string getformulaerrorvalue()
getformulaerrorvalue
in interface ixlsrange
public java.lang.string gethtmlstring()
gethtmlstring
in interface ixlsrange
public void sethtmlstring(java.lang.string value)
sethtmlstring
in interface ixlsrange
value
- public icommentshape getcomment()
getcomment
in interface ixlsrange
public irichtextstring getrichtext()
getrichtext
in interface ixlsrange
public boolean hasmerged()
hasmerged
in interface ixlsrange
public ixlsrange getmergearea()
getmergearea
in interface ixlsrange
public boolean iswraptext()
iswraptext
in interface ixlsrange
public boolean hasexternalformula()
hasexternalformula
in interface ixlsrange
public java.util.enumset<ignoreerrortype> getignoreerroroptions()
getignoreerroroptions
in interface ixlsrange
public java.lang.boolean isstringspreserved()
isstringspreserved
in interface ixlsrange
public builtinstyles getbuiltinstyle()
getbuiltinstyle
in interface ixlsrange
public java.lang.string getrangeglobaladdress2007()
getrangeglobaladdress2007
in interface icombinedrange
public ixlsrange activate(boolean scroll)
activate
in interface ixlsrange
scroll
- true to scroll to the cell
public void merge()
merge
in interface ixlsrange
public void merge(boolean clearcells)
merge
in interface ixlsrange
clearcells
- indicates whether to clear unnecessary cells.public void unmerge()
unmerge
in interface ixlsrange
public void freezepanes()
freezepanes
in interface ixlsrange
public ixlsrange intersect(ixlsrange range)
intersect
in interface ixlsrange
range
- the range with which to intersect.
public ixlsrange merge(ixlsrange range)
merge
in interface ixlsrange
range
- the range to merge with.
public void autofitrows()
autofitrows
in interface ixlsrange
public void autofitcolumns()
autofitcolumns
in interface ixlsrange
public icommentshape addcomment()
addcomment
in interface ixlsrange
public void borderaround()
borderaround
in interface ixlsrange
public void borderaround(linestyletype borderline)
borderaround
in interface ixlsrange
borderline
- represents border line.public void borderaround(linestyletype borderline, java.awt.color bordercolor)
borderaround
in interface ixlsrange
borderline
- represents border line.bordercolor
- represents border color.public void borderaround(linestyletype borderline, excelcolors bordercolor)
borderaround
in interface ixlsrange
borderline
- represents border line.bordercolor
- represents border color as excelcolors.public void borderinside()
borderinside
in interface ixlsrange
public void borderinside(linestyletype borderline)
borderinside
in interface ixlsrange
borderline
- represents border line.public void borderinside(linestyletype borderline, java.awt.color bordercolor)
borderinside
in interface ixlsrange
borderline
- represents border line.bordercolor
- represents border color.public void borderinside(linestyletype borderline, excelcolors bordercolor)
borderinside
in interface ixlsrange
borderline
- represents border line.bordercolor
- represents border color as excelcolors.public void bordernone()
bordernone
in interface ixlsrange
public void collapsegroup(groupbytype groupby)
collapsegroup
in interface ixlsrange
groupby
- this parameter specifies whether the grouping should be performed by rows or by columns.
public void expandgroup(groupbytype groupby)
expandgroup
in interface ixlsrange
groupby
- this parameter specifies whether the grouping should be performed by rows or by columns.
public void expandgroup(groupbytype groupby, expandcollapseflags flags)
expandgroup
in interface ixlsrange
groupby
- this parameter specifies whether the grouping should be performed by rows or by columns.
flags
- additional option flags.public java.lang.string getnewrangelocation(java.util.hashmap names, java.lang.string[] sheetname)
getnewrangelocation
in interface icombinedrange
names
- hashtable with worksheet names.sheetname
- string that sets as a worksheet name.
public ixlsrange deepclone(java.lang.object parent, java.util.hashmap hashnewnames, xlsworkbook book)
deepclone
in interface icombinedrange
parent
- parent object.hashnewnames
- hash table with new names.book
- parent workbook.
public int getcellscount()
getcellscount
in interface icombinedrange
public void clearconditionalformats()
clearconditionalformats
in interface icombinedrange
public java.awt.rectangle[] getrectangles()
getrectangles
in interface icombinedrange
public int getrectanglescount()
getrectanglescount
in interface icombinedrange
public java.lang.string getworksheetname()
getworksheetname
in interface icombinedrange
public void remove(ixlsrange range)
remove
in interface ixlsranges
range
- range to remove.public ixlsrange get(int index)
get
in interface ixlsranges
|
|||||||||
prev class next class | frames no frames | ||||||||
summary: nested | field | constr | method | detail: field | constr | method |