xlsworksheetbase-ag凯发旗舰厅

com.spire.xls.core.spreadsheet
class xlsworksheetbase

java.lang.object
  com.spire.xls.core.spreadsheet.xlsobject
      com.spire.xls.core.spreadsheet.xlsworksheetbase

direct known subclasses:

xlschart, xlsworksheet

public abstract class xlsworksheetbase
extends xlsobject

xlsworksheetbase

public xlsworksheetbase(java.lang.object parent)

setchanged

public void setchanged()

this method should be called after any changes in the worksheet. sets saved property of the parent workbook to false.

getname

public java.lang.string getname()

returns or sets the name of the object. read string.

setname

public void setname(java.lang.string name)

sets the name of the object. write string.

getcodename

public java.lang.string getcodename()

name used by macros to access workbook items.

getzoom

public int getzoom()

zoom factor of document.

setzoom

public void setzoom(int value)

zoom factor of document.

getvisibility

public worksheetvisibility getvisibility()

controls end user visibility of worksheet.

setvisibility

public void setvisibility(worksheetvisibility value)

controls end user visibility of worksheet.

getworkbook

public iworkbook getworkbook()

get parent workbook of current worksheet.

getcharts

public ichartshapes getcharts()

returns charts collection. read-only.

getcheckboxes

public icheckboxes getcheckboxes()

returns inner checkboxes collection. read-only.

getbuttonshapes

public ibuttonshapes getbuttonshapes()

getlabelshapes

public  getlabelshapes()

getlines

public ilines getlines()

getlistboxes

public  getlistboxes()

getcomboboxes

public icomboboxes getcomboboxes()

returns collection with all comboboxes inside this worksheet. read-only.

getgroupboxes

public  getgroupboxes()

getovalshapes

public iovalshapes getovalshapes()

getrectangleshapes

public irectangleshapes getrectangleshapes()

getscrollbarshapes

public iscrollbarshapes getscrollbarshapes()

getspinnershapes

public ispinnershapes getspinnershapes()

getarcshapes

public iarcshapes getarcshapes()

getcomments

public icomments getcomments()

returns comments collection for this worksheet. read-only.

getgridlinecolor

public excelcolors getgridlinecolor()

grid line color.

setgridlinecolor

public void setgridlinecolor(excelcolors value)

grid line color.

haspictures

public boolean haspictures()

indicates whether tabsheet contains any picture. read-only.

hasvmlshapes

public boolean hasvmlshapes()

indicates whether worksheet has vml shapes. read-only.

getheaderfootershapes

public xlsheaderfootershapecollection getheaderfootershapes()

header / footer shapes collection.

getdefaultgridlinecolor

public boolean getdefaultgridlinecolor()

indicates whether gridline color has default value.

getfirstrow

public int getfirstrow()

gets index of the first row of the worksheet.

setfirstrow

public void setfirstrow(int value)

gets / sets index of the first row of the worksheet.

getfirstcolumn

public int getfirstcolumn()

gets index of the first column of the worksheet.

setfirstcolumn

public void setfirstcolumn(int value)

gets or sets index of the first column of the worksheet.

getlastrow

public int getlastrow()

gets one-based index of the last row of the worksheet.

getlastcolumn

public int getlastcolumn()

gets index of the last column of the worksheet.

ispasswordprotected

public boolean ispasswordprotected()

true if the worksheet has been protected with password.

getindex

public int getindex()

returns the index number of the object within the collection of objects.

setindex

public void setindex(int value)

returns the index number of the object within the collection of objects.

getleftvisiblecolumn

public int getleftvisiblecolumn()

gets/sets left visible column of the worksheet.

setleftvisiblecolumn

public void setleftvisiblecolumn(int value)

gets/sets left visible column of the worksheet.

getrealindex

public int getrealindex()

index of the worksheet in the workbook (not necessary in worksheets collection)

setrealindex

public void setrealindex(int value)

index of the worksheet in the workbook (not necessary in worksheets collection)

getsheetid

public int getsheetid()

returns sheetid for this sheet. read-only.

isrighttoleft

public boolean isrighttoleft()

indicates whether worksheet is displayed right to left.

isrighttoleft

public void isrighttoleft(boolean value)

indicates whether worksheet is displayed right to left.

getparentworkbook

public xlsworkbook getparentworkbook()

returns parent workbook. read-only.

getpictures

public ipictures getpictures()

pictures collection. read-only.

getradiobuttons

public iradiobuttons getradiobuttons()

returns inner radiobutton collection. read-only.

gettextboxes

public itextboxes gettextboxes()

returns inner textboxes collection. read-only.

isselected

public boolean isselected()

indicates whether tab of this sheet is selected. read-only.

getprotectcontents

public boolean getprotectcontents()

indicates is current sheet is protected.

getprotectdrawingobjects

public boolean getprotectdrawingobjects()

true if objects are protected. read only.

getprotection

public int getprotection()

gets protected options. read-only. for sets protection options use "protect" method.

getprotectscenarios

public boolean getprotectscenarios()

true if the scenarios of the current sheet are protected. read only.

gettabcolor

public java.awt.color gettabcolor()

tab color.

settabcolor

public void settabcolor(java.awt.color tabcolor)

sets tab color.

gettabcolorobject

public ocolor gettabcolorobject()

tab color.

gettabknowncolor

public excelcolors gettabknowncolor()

tab excel color.

settabknowncolor

public void settabknowncolor(excelcolors value)

tab excel color.

gettopvisiblerow

public int gettopvisiblerow()

gets/sets top visible row of the worksheet.

settopvisiblerow

public void settopvisiblerow(int value)

gets/sets top visible row of the worksheet.

gettypedcheckboxes

public checkboxcollection gettypedcheckboxes()

returns inner checkboxes collection. read-only.

gettypedcomboboxes

public comboboxcollection gettypedcomboboxes()

returns inner comboboxes collection. read-only.

gettypedlines

public linecollection gettypedlines()

returns inner lines collection. read-only.

gettypedrects

public rectanglecollection gettypedrects()

returns inner rects collection. read-only.

gettypedarcs

public arcshapecollection gettypedarcs()

returns inner arcs collection. read-only.

gettypedovals

public ovalshapecollection gettypedovals()

returns inner ovals collection. read-only.

gettypedbuttons

public buttonshapecollection gettypedbuttons()

returns inner buttons collection. read-only.

gettypedgroupboxes

public  gettypedgroupboxes()

returns inner gourpboxes collection. read-only.

gettypedlabels

public  gettypedlabels()

returns inner labels collection. read-only.

gettypedlistboxes

public  gettypedlistboxes()

returns inner listboxes collection. read-only.

gettypedscollbars

public scrollbarcollection gettypedscollbars()

returns inner scollbars collection. read-only.

gettypedspinners

public spinnershapecollection gettypedspinners()

returns inner spinners collection. read-only.

gettypedradiobuttons

public radiobuttoncollection gettypedradiobuttons()

returns inner radiobutton collection. read-only.

gettypedtextboxes

public textboxcollection gettypedtextboxes()

returns inner textboxes collection. read-only.

getprstgeomshapes

public prstgeomshapecollection getprstgeomshapes()

returns prst geom shapes. read-only.

gettypedpictures

public picturescollection gettypedpictures()

returns inner pictures collection. read-only.

getunknownvmlshapes

public boolean getunknownvmlshapes()

indicates whether worksheet contains some unknown vml shapes.

setunknownvmlshapes

public void setunknownvmlshapes(boolean value)

indicates whether worksheet contains some unknown vml shapes.

getvmlshapescount

public int getvmlshapescount()

returns number of known vml shapes. read-only.

activate

public void activate()

makes the current sheet the active sheet. equivalent to clicking the sheet's tab in ms excel.

select

public void select()

selects current tab sheet.

selecttab

public void selecttab()

adds sheet tab to the selected tab.

unselect

public void unselect()

unselects current tab sheet if possible.

unselect

public void unselect(boolean check)

unselects current tab sheet if possible.

parameters:

check - indicates whether to allow unselect last sheet.

protect

public void protect(java.lang.string password,
                    java.util.enumset<sheetprotectiontype> options)

protects worksheet with password.

parameters:

password - protection password. password should be less than 15 symbols.

protect

public void protect(java.lang.string password)

protects worksheet with password.protect the sheet except select lock/unlock cells.

parameters:

password - protection password. password should be less than 15 symbols.

unprotect

public void unprotect()

unprotects this wokrsheet.

unprotect

public void unprotect(java.lang.string password)

unprotects this worksheet using specified password.

parameters:

password - password to unprotect.

getshapes

public ishapes getshapes()

shapes collection.