|
|||||||||
prev class next class | frames no frames | ||||||||
summary: nested | field | constr | method | detail: field | constr | method |
java.lang.objectcom.spire.xls.core.spreadsheet.xlsobject
com.spire.xls.core.spreadsheet.xlsworksheetbase
com.spire.xls.core.spreadsheet.xlsworksheet
com.spire.xls.worksheet
public class worksheet
represents the worksheet.
nested class summary |
---|
nested classes/interfaces inherited from class com.spire.xls.core.spreadsheet.xlsworksheet |
---|
xlsworksheet.trangevaluetype |
method summary | |
---|---|
void |
applystyle(cellstyle style)
apply style to whole sheet. |
void |
copy(cellrange sourcerange,
cellrange destrange)
copys data from a source range to a destination range. |
void |
copy(cellrange sourcerange,
cellrange destrange,
boolean copystyle)
copys data from a source range to a destination range. |
void |
copy(cellrange sourcerange,
cellrange destrange,
boolean copystyle,
boolean updatereference,
boolean ignoresize)
copys data from a source range to a destination range. |
void |
copy(cellrange sourcerange,
cellrange destrange,
boolean copystyle,
boolean updatereference,
boolean ignoresize,
boolean copyshape)
|
void |
copy(cellrange sourcerange,
cellrange destrange,
java.util.enumset<copyrangeoptions> copyoptions)
copys data from a source range to a destination range. |
void |
copy(cellrange sourcerange,
worksheet worksheet,
int destrow,
int destcolumn)
copy data from source range to destination worksheet. |
void |
copy(cellrange sourcerange,
worksheet worksheet,
int destrow,
int destcolumn,
boolean copystyle)
copy data from source range to destination worksheet. |
void |
copy(cellrange sourcerange,
worksheet worksheet,
int destrow,
int destcolumn,
boolean copystyle,
boolean updatererence)
copy data from source range to destination worksheet. |
void |
copyfrom(worksheet worksheet)
copy data from specified worksheet. |
datatable |
exportdatatable(cellrange range,
boolean exportcolumnnames)
exports worksheet data into a datatable. |
datatable |
exportdatatable(cellrange range,
boolean exportcolumnnames,
boolean computedformulavalue)
exports worksheet data into a datatable. |
datatable |
exportdatatable(int firstrow,
int firstcolumn,
int maxrows,
int maxcolumns,
boolean exportcolumnnames)
exports worksheet data into a datatable |
cellrange[] |
findall(java.lang.string findvalue,
java.util.enumset<findtype> flags,
java.util.enumset<excelfindoptions> findoptions)
finds the all cells with specified string value. |
cellrange[] |
findallbool(boolean boolvalue)
finds the cell with the input bool. |
cellrange[] |
findalldatetime(java.util.date datevalue)
finds the cell with the input date time. |
cellrange[] |
findallnumber(double doublevalue,
boolean formulavalue)
finds the cell with the input number. |
cellrange[] |
findallstring(java.lang.string stringvalue,
boolean formula,
boolean formulavalue)
finds the cell with the input string. |
cellrange |
findbool(boolean boolvalue)
finds the cell with the input bool. |
cellrange |
finddatetime(java.util.date datevalue)
finds the cell with the input date. |
cellrange |
findstring(java.lang.string stringvalue,
boolean formula,
boolean formulavalue)
finds the cell with the input string. |
void |
freezepanes(int rowindex,
int columnindex)
freezes panes at the specified cell in the worksheet. |
cellrange |
getallocatedrange()
returns a range object that represents the used range on the specified worksheet. |
autofilterscollection |
getautofilters()
returns auto filters collection of worksheet. |
workbook |
getbook()
|
cellrange |
getcellrange(int row,
int column)
gets cell range. |
cellrange |
getcellrange(int row,
int column,
int lastrow,
int lastcolumn)
gets cell range. |
cellrange |
getcellrange(java.lang.string name)
gets cell range. |
cellrange[] |
getcells()
returns all used cells in the worksheet. |
worksheetchartscollection |
getcharts()
returns charts collection. |
cellrange[] |
getcolumns()
rrepresents all used columns on the specified worksheet. |
commentscollection |
getcomments()
returns comments collection for this worksheet. |
cellstyle |
getdefaultcolumnstyle(int columnindex)
returns default column style. |
cellstyle |
getdefaultrowstyle(int rowindex)
returns default row style. |
hpagebreakscollection |
gethpagebreaks()
returns an hpagebreaks collection that represents the horizontal |
hyperlinkscollection |
gethyperlinks()
collection of all worksheet's hyperlinks. |
cellrange |
getintersectranges(cellrange range1,
cellrange range2)
intersects two ranges. |
cellrange[] |
getmergedcells()
returns all merged ranges. |
pagesetup |
getpagesetup()
returns a page setup object that contains all the page setup settings for the specified object. |
workbook |
getparentbook()
|
picturescollection |
getpictures()
pictures collection. |
cellrange |
getprintrange()
print area of worksheet. |
cellrange |
getrange()
returns a range object that represents the used range on the specified worksheet. |
cellrange[] |
getrows()
represents all the rows on the specified worksheet. |
vpagebreakscollection |
getvpagebreaks()
returns a vpagebreaks collection that represents the vertical page breaks on the sheet. |
cellrange |
merge(cellrange range1,
cellrange range2)
combines a range of cells into a single cell. |
void |
move(cellrange sourcerange,
cellrange destrange)
move data from source range to destination range. |
void |
move(cellrange sourcerange,
cellrange destrange,
boolean updatereference,
boolean copystyle)
|
void |
removemergedcells(cellrange range)
remove merged cells from specified range. |
void |
removepicture(int index)
remove picture from this worksheet. |
void |
removepicture(ipictureshape picture)
remove picture from this worksheet. |
void |
removepicture(java.lang.string picturename)
remove picture from this worksheet. |
void |
removerange(cellrange range)
removes range from list. |
void |
removerange(int rowindex,
int columnindex)
removes range from list. |
void |
setactivecell(cellrange range)
sets active cell |
void |
setdefaultcolumnstyle(int columnindex,
cellstyle defaultstyle)
sets default style for column. |
void |
setdefaultcolumnstyle(int firstcolumnindex,
int lastcolumnindex,
cellstyle defaultstyle)
sets default style for column. |
void |
setdefaultrowstyle(int rowindex,
cellstyle defaultstyle)
sets default style for row. |
void |
setdefaultrowstyle(int firstrowindex,
int lastrowindex,
cellstyle defaultstyle)
sets default style for row. |
methods inherited from class com.spire.xls.core.spreadsheet.xlsobject |
---|
dispose |
methods inherited from interface com.spire.xls.core.iworksheet |
---|
copytoclipboard, getcodename, getgridlinecolor, getindex, getleftvisiblecolumn, gettopvisiblerow, protect, savetoimage, savetoimage, savetoimage, savetostream, seterror, setgridlinecolor, setleftvisiblecolumn, settopvisiblerow, setvalue, unprotect |
method detail |
---|
public cellrange getallocatedrange()
getallocatedrange
in interface iworksheet
getallocatedrange
in class xlsworksheet
public cellrange getcellrange(int row, int column, int lastrow, int lastcolumn)
row
- column
- lastrow
- lastcolumn
-
public cellrange getcellrange(int row, int column)
row
- column
-
public cellrange getcellrange(java.lang.string name)
name
- cell name
public cellrange[] getmergedcells()
getmergedcells
in interface iworksheet
getmergedcells
in class xlsworksheet
public cellrange[] findall(java.lang.string findvalue, java.util.enumset<findtype> flags, java.util.enumset<excelfindoptions> findoptions)
findvalue
- value to search.flags
- type of value to search.findoptions
- way to search.
public cellrange[] findallnumber(double doublevalue, boolean formulavalue)
doublevalue
- double value to search for.formulavalue
- indicates if includes formula value.
public cellrange[] findallstring(java.lang.string stringvalue, boolean formula, boolean formulavalue)
stringvalue
- string value to search for.formula
- indicates if includes formula.formulavalue
- indicates if includes formula value.
public cellrange[] findalldatetime(java.util.date datevalue)
datevalue
- date value to search for.
public cellrange[] findallbool(boolean boolvalue)
boolvalue
- bool value to search for.
public cellrange findbool(boolean boolvalue)
boolvalue
- bool value to search for.
public cellrange findstring(java.lang.string stringvalue, boolean formula, boolean formulavalue)
stringvalue
- string value to search for.formula
- indicates whether includes formula.formulavalue
- indicates whether includes formula value.
public cellrange finddatetime(java.util.date datevalue)
datevalue
- date value to search for.
public void copyfrom(worksheet worksheet)
worksheet
- worksheet objectpublic void copy(cellrange sourcerange, cellrange destrange)
sourcerange
- source range.destrange
- destination range.public void copy(cellrange sourcerange, cellrange destrange, boolean copystyle)
sourcerange
- source range.destrange
- destination range.copystyle
- indicates whether copys styles.public void copy(cellrange sourcerange, cellrange destrange, boolean copystyle, boolean updatereference, boolean ignoresize)
sourcerange
- source range.destrange
- destination rangecopystyle
- indicates whether copy styles.updatereference
- indicates whether update reference ranges.ignoresize
- indicates whether check range sizes.public void copy(cellrange sourcerange, worksheet worksheet, int destrow, int destcolumn)
sourcerange
- source range.worksheet
- destination worksheetdestrow
- row index of destination worksheet.destcolumn
- column index of destination worksheet.public void copy(cellrange sourcerange, worksheet worksheet, int destrow, int destcolumn, boolean copystyle)
sourcerange
- source rangeworksheet
- destination worksheet.destrow
- row index of destination worksheet.destcolumn
- column index of destination worksheet.copystyle
- indicates whehter copy styles.public void copy(cellrange sourcerange, worksheet worksheet, int destrow, int destcolumn, boolean copystyle, boolean updatererence)
sourcerange
- source rangeworksheet
- destination worksheet.destrow
- row index of destination worksheet.destcolumn
- column index of destination worksheet.copystyle
- indicates whehter copy styles.updatererence
- indicates whether update reference range.public void copy(cellrange sourcerange, cellrange destrange, boolean copystyle, boolean updatereference, boolean ignoresize, boolean copyshape)
sourcerange
- source range.destrange
- destination rangecopystyle
- indicates whether copy styles.updatereference
- indicates whether update reference ranges.ignoresize
- indicates whether check range sizes.copyshape
- indicates whether copy shape.public void copy(cellrange sourcerange, cellrange destrange, java.util.enumset<copyrangeoptions> copyoptions)
sourcerange
- source range.destrange
- destination range.copyoptions
- copy options.public void move(cellrange sourcerange, cellrange destrange)
sourcerange
- source range.destrange
- destination range.public void move(cellrange sourcerange, cellrange destrange, boolean updatereference, boolean copystyle)
public datatable exportdatatable(cellrange range, boolean exportcolumnnames)
range
- range to export.exportcolumnnames
- indicates if export column name.
public datatable exportdatatable(cellrange range, boolean exportcolumnnames, boolean computedformulavalue)
range
- range to export.exportcolumnnames
- indicates if export column name.computedformulavalue
- indicates wheter compute formula value.
public datatable exportdatatable(int firstrow, int firstcolumn, int maxrows, int maxcolumns, boolean exportcolumnnames)
firstrow
- row of first cell.firstcolumn
- column of first cell.maxrows
- maximun rows to export.maxcolumns
- maximun columns to export.exportcolumnnames
- indicates if export column name.
public cellrange getintersectranges(cellrange range1, cellrange range2)
range1
- first range.range2
- second range.
public cellrange merge(cellrange range1, cellrange range2)
range1
- first range.range2
- second range.
public void setdefaultcolumnstyle(int columnindex, cellstyle defaultstyle)
columnindex
- column index.defaultstyle
- default style.public void setdefaultcolumnstyle(int firstcolumnindex, int lastcolumnindex, cellstyle defaultstyle)
firstcolumnindex
- first column index.lastcolumnindex
- last column index.defaultstyle
- default style.public void setdefaultrowstyle(int rowindex, cellstyle defaultstyle)
rowindex
- row index.defaultstyle
- default style.public void setdefaultrowstyle(int firstrowindex, int lastrowindex, cellstyle defaultstyle)
firstrowindex
- first row index.lastrowindex
- last row index.defaultstyle
- default style.public cellstyle getdefaultcolumnstyle(int columnindex)
getdefaultcolumnstyle
in interface iworksheet
getdefaultcolumnstyle
in class xlsworksheet
columnindex
- column index.
public cellstyle getdefaultrowstyle(int rowindex)
getdefaultrowstyle
in interface iworksheet
getdefaultrowstyle
in class xlsworksheet
rowindex
- row index.
public void removemergedcells(cellrange range)
range
- specified range.public void removerange(cellrange range)
range
- specified range.public void removerange(int rowindex, int columnindex)
rowindex
- row index.columnindex
- column index.public void removepicture(int index)
index
- picture idpublic void removepicture(java.lang.string picturename)
picturename
- picture namepublic void removepicture(ipictureshape picture)
picture
- a pictureshapepublic void applystyle(cellstyle style)
applystyle
in class xlsworksheet
style
- style to applypublic void freezepanes(int rowindex, int columnindex)
rowindex
- row index.columnindex
- column index.public void setactivecell(cellrange range)
range
- cell to activate.public cellrange[] getcells()
getcells
in interface iworksheet
getcells
in class xlsworksheet
public cellrange[] getcolumns()
getcolumns
in interface iworksheet
getcolumns
in class xlsworksheet
public pagesetup getpagesetup()
getpagesetup
in interface iworksheet
getpagesetup
in class xlsworksheet
public autofilterscollection getautofilters()
getautofilters
in interface iworksheet
getautofilters
in class xlsworksheet
public worksheetchartscollection getcharts()
getcharts
in class xlsworksheetbase
public commentscollection getcomments()
getcomments
in interface iworksheet
getcomments
in class xlsworksheetbase
public hpagebreakscollection gethpagebreaks()
gethpagebreaks
in interface iworksheet
gethpagebreaks
in class xlsworksheet
public hyperlinkscollection gethyperlinks()
gethyperlinks
in interface iworksheet
gethyperlinks
in class xlsworksheet
public picturescollection getpictures()
getpictures
in class xlsworksheetbase
public cellrange getprintrange()
public vpagebreakscollection getvpagebreaks()
getvpagebreaks
in interface iworksheet
getvpagebreaks
in class xlsworksheet
public cellrange getrange()
getrange
in interface iworksheet
getrange
in class xlsworksheet
public cellrange[] getrows()
getrows
in interface iworksheet
getrows
in class xlsworksheet
public workbook getbook()
public workbook getparentbook()
|
|||||||||
prev class next class | frames no frames | ||||||||
summary: nested | field | constr | method | detail: field | constr | method |