xlspagesetupbase-ag凯发旗舰厅

com.spire.xls.core.spreadsheet
class xlspagesetupbase

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

all implemented interfaces:

ipagesetupbase

direct known subclasses:

xlschartpagesetup, xlspagesetup

public class xlspagesetupbase
extends xlsobject
implements ipagesetupbase

summary description for pagesetupbaseimpl.

xlspagesetupbase

public xlspagesetupbase(java.lang.object parent)

getautofirstpagenumber

public boolean getautofirstpagenumber()

indicates whether firstpagenumber is set to auto or not.

specified by:

getautofirstpagenumber in interface ipagesetupbase

setautofirstpagenumber

public void setautofirstpagenumber(boolean value)

indicates whether firstpagenumber is set to auto or not.

specified by:

setautofirstpagenumber in interface ipagesetupbase

getblackandwhite

public boolean getblackandwhite()

true if elements of the document will be printed in black and white. read / write boolean.

specified by:

getblackandwhite in interface ipagesetupbase

setblackandwhite

public void setblackandwhite(boolean value)

true if elements of the document will be printed in black and white. read / write boolean.

specified by:

setblackandwhite in interface ipagesetupbase

getbottommargin

public double getbottommargin()

returns or sets the size of the bottom margin, in inches. read / write double.

specified by:

getbottommargin in interface ipagesetupbase

setbottommargin

public void setbottommargin(double bottommargin)

sets the size of the bottom margin, in inches. write double.

specified by:

setbottommargin in interface ipagesetupbase

getcenterfooter

public java.lang.string getcenterfooter()

returns or sets the center part of the footer. read / write string.

specified by:

getcenterfooter in interface ipagesetupbase

setcenterfooter

public void setcenterfooter(java.lang.string centerfooter)

sets the center part of the footer. write string.

specified by:

setcenterfooter in interface ipagesetupbase

getcenterfooterimage

public java.awt.image.bufferedimage getcenterfooterimage()

gets / set image for center part of the footer.

specified by:

getcenterfooterimage in interface ipagesetupbase

returns:

setcenterfooterimage

public void setcenterfooterimage(java.awt.image.bufferedimage image)

sets image for center part of the footer.

specified by:

setcenterfooterimage in interface ipagesetupbase

parameters:

image -

getcenterheader

public java.lang.string getcenterheader()

returns or sets the center part of the header. read / write string.

specified by:

getcenterheader in interface ipagesetupbase

setcenterheader

public void setcenterheader(java.lang.string value)

returns or sets the center part of the header. read / write string.

specified by:

setcenterheader in interface ipagesetupbase

getcenterheaderimage

public java.awt.image.bufferedimage getcenterheaderimage()

gets / set image for center part of the header.

specified by:

getcenterheaderimage in interface ipagesetupbase

returns:

setcenterheaderimage

public void setcenterheaderimage(java.awt.image.bufferedimage image)

description copied from interface: ipagesetupbase

gets / set image for center part of the header.

specified by:

setcenterheaderimage in interface ipagesetupbase

setcenterheaderimage

public void setcenterheaderimage(java.awt.image.bufferedimage image,
                                 float scale)

getcenterhorizontally

public boolean getcenterhorizontally()

true if the sheet is centered horizontally on the page when it is printed. read / write boolean.

specified by:

getcenterhorizontally in interface ipagesetupbase

setcenterhorizontally

public void setcenterhorizontally(boolean value)

true if the sheet is centered horizontally on the page when it is printed. read / write boolean.

specified by:

setcenterhorizontally in interface ipagesetupbase

getcentervertically

public boolean getcentervertically()

true if the sheet is centered vertically on the page when it is printed. read / write boolean.

specified by:

getcentervertically in interface ipagesetupbase

setcentervertically

public void setcentervertically(boolean value)

true if the sheet is centered vertically on the page when it is printed. read / write boolean.

specified by:

setcentervertically in interface ipagesetupbase

getcopies

public int getcopies()

number of copies to print.

specified by:

getcopies in interface ipagesetupbase

setcopies

public void setcopies(int value)

number of copies to print.

specified by:

setcopies in interface ipagesetupbase

getdraft

public boolean getdraft()

true if the sheet will be printed without graphics. read / write boolean.

specified by:

getdraft in interface ipagesetupbase

setdraft

public void setdraft(boolean value)

true if the sheet will be printed without graphics. read / write boolean.

specified by:

setdraft in interface ipagesetupbase

getfirstpagenumber

public int getfirstpagenumber()

returns or sets the first page number that will be used when this sheet is printed. if xlautomatic, microsoft excel chooses the first page number. the default is xlautomatic. read / write long.

specified by:

getfirstpagenumber in interface ipagesetupbase

setfirstpagenumber

public void setfirstpagenumber(int value)

returns or sets the first page number that will be used when this sheet is printed. if xlautomatic, microsoft excel chooses the first page number. the default is xlautomatic. read / write long.

specified by:

setfirstpagenumber in interface ipagesetupbase

getfootermargininch

public double getfootermargininch()

returns or sets the distance from the bottom of the page to the footer, in inches. read / write double.

specified by:

getfootermargininch in interface ipagesetupbase

setfootermargininch

public void setfootermargininch(double value)

returns or sets the distance from the bottom of the page to the footer, in inches. read / write double.

specified by:

setfootermargininch in interface ipagesetupbase

getfittopagestall

public int getfittopagestall()

returns or sets the number of pages tall the worksheet will be scaled to when it is printed. applies only to worksheets. read / write int.

setfittopagestall

public void setfittopagestall(int value)

returns or sets the number of pages tall the worksheet will be scaled to when it is printed. applies only to worksheets. read / write int.

getfittopageswide

public int getfittopageswide()

returns or sets the number of pages wide the worksheet will be scaled to when it is printed. applies only to worksheets. read / write int.

setfittopageswide

public void setfittopageswide(int value)

returns or sets the number of pages wide the worksheet will be scaled to when it is printed. applies only to worksheets. read / write int.

getheadermargininch

public double getheadermargininch()

returns or sets the distance from the top of the page to the header, in inches. read / write double.

specified by:

getheadermargininch in interface ipagesetupbase

setheadermargininch

public void setheadermargininch(double value)

returns or sets the distance from the top of the page to the header, in inches. read / write double.

specified by:

setheadermargininch in interface ipagesetupbase

gethresolution

public int gethresolution()

gets or sets horizontal resolution in dpi.

sethresolution

public void sethresolution(int value)

gets or sets horizontal resolution in dpi.

getfullheaderstring

public java.lang.string getfullheaderstring()

represents full header string. read only.

setfullheaderstring

public void setfullheaderstring(java.lang.string value)

represents full header string. read only.

getfullfooterstring

public java.lang.string getfullfooterstring()

gets footer full string. read only.

setfullfooterstring

public void setfullfooterstring(java.lang.string value)

gets footer full string. read only.

getfirstheaderstring

public java.lang.string getfirstheaderstring()

represents first page header string. read only.

setfirstheaderstring

public void setfirstheaderstring(java.lang.string value)

represents first page header string. read only.

getfirstfooterstring

public java.lang.string getfirstfooterstring()

gets first page footer string. read only.

setfirstfooterstring

public void setfirstfooterstring(java.lang.string value)

gets first page footer string. read only.

getoddheaderstring

public java.lang.string getoddheaderstring()

gets odd page header string. read only.

setoddheaderstring

public void setoddheaderstring(java.lang.string oddheaderstring)

sets odd page header string. read only.

getoddfooterstring

public java.lang.string getoddfooterstring()

gets odd page footer string. read only.

setoddfooterstring

public void setoddfooterstring(java.lang.string oddfooterstring)

sets odd page footer string. read only.

getevenheaderstring

public java.lang.string getevenheaderstring()

gets even page header string. read only.

setevenheaderstring

public void setevenheaderstring(java.lang.string evenheaderstring)

sets even page header string. read only.

getevenfooterstring

public java.lang.string getevenfooterstring()

gets oddeven page footer string. read only.

setevenfooterstring

public void setevenfooterstring(java.lang.string evenfooterstring)

sets odd even page footer string. read only.

getalignwithmargins

public byte getalignwithmargins()

indicates whether align header footer margins with page margins.default value is 1

setalignwithmargins

public void setalignwithmargins(byte value)

indicates whether align header footer margins with page margins.default value is 1

getdifferentoddeven

public byte getdifferentoddeven()

indicates whether different odd and even page headers and footers.default value is 0

setdifferentoddeven

public void setdifferentoddeven(byte differentoddeven)

indicates whether different odd and even page headers and footers. default value is 0

getscalewithdoc

public byte getscalewithdoc()

indicates whether scale header and footer with document scaling.default value is 1

setscalewithdoc

public void setscalewithdoc(byte value)

indicates whether scale header and footer with document scaling.default value is 1

getdifferentfirst

public byte getdifferentfirst()

indicates whether different first page header and footer.default value is 0

setdifferentfirst

public void setdifferentfirst(byte value)

indicates whether different first page header and footer.default value is 0

getvresolution

public int getvresolution()

gets vertical resolution in dpi.

setvresolution

public void setvresolution(int value)

sets vertical resolution in dpi.

getleftfooter

public java.lang.string getleftfooter()

returns or sets the left part of the footer. read / write string. &l left aligns the characters that follow. &c centers the characters that follow. &r right aligns the characters that follow. &e turns double-underline printing on or off. &x turns superscript printing on or off. &y turns subscript printing on or off. &b turns bold printing on or off. &i turns italic printing on or off. &u turns underline printing on or off. &s turns strikethrough printing on or off. &d prints the current date. &t prints the current time. &f prints the name of the document. &a prints the name of the workbook tab. &p prints the page number. &p number prints the page number plus the specified number. &p-number prints the page number minus the specified number. && prints a single ampersand. & "fontname" prints the characters that follow in the specified font. be sure to include the double quotation marks. &nn prints the characters that follow in the specified font size. use a two-digit number to specify a size in points. &n prints the total number of pages in the document.

specified by:

getleftfooter in interface ipagesetupbase

setleftfooter

public void setleftfooter(java.lang.string value)

returns or sets the left part of the footer. read / write string. &l left aligns the characters that follow. &c centers the characters that follow. &r right aligns the characters that follow. &e turns double-underline printing on or off. &x turns superscript printing on or off. &y turns subscript printing on or off. &b turns bold printing on or off. &i turns italic printing on or off. &u turns underline printing on or off. &s turns strikethrough printing on or off. &d prints the current date. &t prints the current time. &f prints the name of the document. &a prints the name of the workbook tab. &p prints the page number. &p number prints the page number plus the specified number. &p-number prints the page number minus the specified number. && prints a single ampersand. & "fontname" prints the characters that follow in the specified font. be sure to include the double quotation marks. &nn prints the characters that follow in the specified font size. use a two-digit number to specify a size in points. &n prints the total number of pages in the document.

specified by:

setleftfooter in interface ipagesetupbase

getleftfooterimage

public java.awt.image.bufferedimage getleftfooterimage()

gets / set image for left part of the footer.

specified by:

getleftfooterimage in interface ipagesetupbase

returns:

setleftfooterimage

public void setleftfooterimage(java.awt.image.bufferedimage value)

set image for left part of the footer.

specified by:

setleftfooterimage in interface ipagesetupbase

parameters:

value -

getleftheader

public java.lang.string getleftheader()

returns or sets the left part of the header. read / write string.

specified by:

getleftheader in interface ipagesetupbase

setleftheader

public void setleftheader(java.lang.string leftheader)

sets the left part of the header. write string.

specified by:

setleftheader in interface ipagesetupbase

getleftheaderimage

public java.awt.image.bufferedimage getleftheaderimage()

gets / set image for left part of the header.

specified by:

getleftheaderimage in interface ipagesetupbase

returns:

setleftheaderimage

public void setleftheaderimage(java.awt.image.bufferedimage bufferedimage)

sets image for left part of the header.

specified by:

setleftheaderimage in interface ipagesetupbase

parameters:

bufferedimage -

setleftheaderimage

public void setleftheaderimage(java.awt.image.bufferedimage bufferedimage,
                               float scale)

sets image for left part of the header.

parameters:

bufferedimage -

scale -

getleftmargin

public double getleftmargin()

returns the size of the left margin, in inches. read / write double.

specified by:

getleftmargin in interface ipagesetupbase

setleftmargin

public void setleftmargin(double leftmargin)

sets the value of the left margin, in inches. write double.

specified by:

setleftmargin in interface ipagesetupbase

getorder

public ordertype getorder()

returns order that microsoft excel uses to number pages when printing a large worksheet. read / write excelorder..

specified by:

getorder in interface ipagesetupbase

setorder

public void setorder(ordertype value)

sets the order that microsoft excel uses to number pages when printing a large worksheet. read / write excelorder..

specified by:

setorder in interface ipagesetupbase

getorientation

public pageorientationtype getorientation()

portrait or landscape printing mode. read / write excelpageorientation

specified by:

getorientation in interface ipagesetupbase

setorientation

public void setorientation(pageorientationtype orientation)

sets portrait or landscape printing mode. write excel page orientation

specified by:

setorientation in interface ipagesetupbase

getpapersize

public papersizetype getpapersize()

returns the size of the paper. read / write excelpapersize.

specified by:

getpapersize in interface ipagesetupbase

setpapersize

public void setpapersize(papersizetype papersize)

sets the size of the paper. write excel paper size.

specified by:

setpapersize in interface ipagesetupbase

getprintcomments

public printcommenttype getprintcomments()

returns or sets the way comments are printed with the sheet. read / write excelprintlocation.

specified by:

getprintcomments in interface ipagesetupbase

setprintcomments

public void setprintcomments(printcommenttype value)

returns or sets the way comments are printed with the sheet. read / write excelprintlocation.

specified by:

setprintcomments in interface ipagesetupbase

getprinterrors

public printerrorstype getprinterrors()

sets or returns an excelprinterrors constant specifying the type of print error displayed. this feature allows users to suppress the display of error values when printing a worksheet. read / write.

specified by:

getprinterrors in interface ipagesetupbase

setprinterrors

public void setprinterrors(printerrorstype value)

sets or returns an excelprinterrors constant specifying the type of print error displayed. this feature allows users to suppress the display of error values when printing a worksheet. read / write.

specified by:

setprinterrors in interface ipagesetupbase

getprintnotes

public boolean getprintnotes()

true if cell notes are printed as end notes with the sheet. applies only to worksheets. read / write boolean.

specified by:

getprintnotes in interface ipagesetupbase

setprintnotes

public void setprintnotes(boolean value)

true if cell notes are printed as end notes with the sheet. applies only to worksheets. read / write boolean.

specified by:

setprintnotes in interface ipagesetupbase

getprintquality

public int getprintquality()

returns or sets the print quality. read / write ushort.

specified by:

getprintquality in interface ipagesetupbase

setprintquality

public void setprintquality(int value)

returns or sets the print quality. read / write ushort.

specified by:

setprintquality in interface ipagesetupbase

getrightfooter

public java.lang.string getrightfooter()

returns or sets the right part of the footer. read / write string.

specified by:

getrightfooter in interface ipagesetupbase

setrightfooter

public void setrightfooter(java.lang.string value)

returns or sets the right part of the footer. read / write string.

specified by:

setrightfooter in interface ipagesetupbase

getrightfooterimage

public java.awt.image.bufferedimage getrightfooterimage()

gets / set image for right part of the footer.

specified by:

getrightfooterimage in interface ipagesetupbase

returns:

setrightfooterimage

public void setrightfooterimage(java.awt.image.bufferedimage image)

set image for right part of the footer.

specified by:

setrightfooterimage in interface ipagesetupbase

parameters:

image -

getrightheader

public java.lang.string getrightheader()

returns or sets the right part of the header. read / write string.

specified by:

getrightheader in interface ipagesetupbase

setrightheader

public void setrightheader(java.lang.string value)

returns or sets the right part of the header. read / write string.

specified by:

setrightheader in interface ipagesetupbase

getrightheaderimage

public java.awt.image.bufferedimage getrightheaderimage()

gets / set image for right part of the header.

specified by:

getrightheaderimage in interface ipagesetupbase

returns:

setrightheaderimage

public void setrightheaderimage(java.awt.image.bufferedimage bufferedimage)

set image for right part of the header.

specified by:

setrightheaderimage in interface ipagesetupbase

parameters:

bufferedimage -

setrightheaderimage

public void setrightheaderimage(java.awt.image.bufferedimage bufferedimage,
                                float scale)

set image for right part of the header.

parameters:

bufferedimage -

scale -

getrightmargin

public double getrightmargin()

returns the size of the right margin, in inches. read / write double.

specified by:

getrightmargin in interface ipagesetupbase

setrightmargin

public void setrightmargin(double rightmargin)

sets the size of the right margin, in inches. write double.

specified by:

setrightmargin in interface ipagesetupbase

gettopmargin

public double gettopmargin()

returns the size of the top margin, in inches. read / write double.

specified by:

gettopmargin in interface ipagesetupbase

settopmargin

public void settopmargin(double topmargin)

sets the size of the top margin, in inches. write double.

specified by:

settopmargin in interface ipagesetupbase

getzoom

public int getzoom()

returns a percentage (between 10 and 400 percent) by which microsoft excel will scale the worksheet for printing. applies only .to worksheets. read / write ushort.

specified by:

getzoom in interface ipagesetupbase

setzoom

public void setzoom(int value)

sets a percentage (between 10 and 400 percent) by which microsoft excel will scale the worksheet for printing. applies only .to worksheets. read / write ushort.

specified by:

setzoom in interface ipagesetupbase

getcenterfooterpicturewidth

public int getcenterfooterpicturewidth()

gets or set width of picture for center part of the footer.

setcenterfooterpicturewidth

public void setcenterfooterpicturewidth(int value)

gets or set width of picture for center part of the footer.

getcenterfooterpictureheight

public int getcenterfooterpictureheight()

gets or set height of picture for center part of the footer.

setcenterfooterpictureheight

public void setcenterfooterpictureheight(int value)

gets or set height of picture for center part of the footer.

getcenterheaderpicturewidth

public int getcenterheaderpicturewidth()

gets or set width of picture for center part of the header.

setcenterheaderpicturewidth

public void setcenterheaderpicturewidth(int value)

gets or set width of picture for center part of the header.

getcenterheaderpictureheight

public int getcenterheaderpictureheight()

gets or set height of picture for center part of the header.

setcenterheaderpictureheight

public void setcenterheaderpictureheight(int value)

gets or set height of picture for center part of the header.

getleftfooterpicturewidth

public int getleftfooterpicturewidth()

gets or set width of picture for left part of the footer.

setleftfooterpicturewidth

public void setleftfooterpicturewidth(int value)

gets or set width of picture for left part of the footer.

getleftfooterpictureheight

public int getleftfooterpictureheight()

gets or set height of picture for left part of the footer.

setleftfooterpictureheight

public void setleftfooterpictureheight(int value)

gets or set height of picture for left part of the footer.

getleftheaderpicturewidth

public int getleftheaderpicturewidth()

gets or set width of picture for left part of the header.

setleftheaderpicturewidth

public void setleftheaderpicturewidth(int value)

gets or set width of picture for left part of the header.

getleftheaderpictureheight

public int getleftheaderpictureheight()

gets or set height of picture for left part of the header.

setleftheaderpictureheight

public void setleftheaderpictureheight(int value)

gets or set height of picture for left part of the header.

getrightfooterpicturewidth

public int getrightfooterpicturewidth()

gets or set width of picture for right part of the footer.

setrightfooterpicturewidth

public void setrightfooterpicturewidth(int value)

gets or set width of picture for right part of the footer.

getrightfooterpictureheight

public int getrightfooterpictureheight()

gets or set height of picture for right part of the footer.

setrightfooterpictureheight

public void setrightfooterpictureheight(int value)

gets or set height of picture for right part of the footer.

getrightheaderpicturewidth

public int getrightheaderpicturewidth()

gets or set width of picture for right part of the header.

setrightheaderpicturewidth

public void setrightheaderpicturewidth(int value)

gets or set width of picture for right part of the header.

getrightheaderpictureheight

public int getrightheaderpictureheight()

gets or set height of picture for right part of the header.

setrightheaderpictureheight

public void setrightheaderpictureheight(int value)

gets or set height of picture for right part of the header.

getbackgoundimage

public java.awt.image.bufferedimage getbackgoundimage()

gets / sets background image.

setbackgoundimage

public void setbackgoundimage(java.awt.image.bufferedimage image)

gets / sets background image.

parameters:

image -

getpagewidth

public double getpagewidth()

returns page width in points. read-only.

getpageheight

public double getpageheight()

returns page width in points. read-only.