|
|||||||||
| 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.XlsPageSetupBase
public class XlsPageSetupBase
Summary description for PageSetupBaseImpl.
| Constructor Summary | |
|---|---|
XlsPageSetupBase(java.lang.Object parent)
|
|
| Method Summary | |
|---|---|
byte |
getAlignWithMargins()
Indicates whether align header footer margins with page margins.Default value is 1 |
boolean |
getAutoFirstPageNumber()
Indicates whether FirstPageNumber is set to Auto or not. |
java.awt.image.BufferedImage |
getBackgoundImage()
Gets / sets background image. |
boolean |
getBlackAndWhite()
True if elements of the document will be printed in black and white. |
double |
getBottomMargin()
Returns or sets the size of the bottom margin, in inches. |
java.lang.String |
getCenterFooter()
Returns or sets the center part of the footer. |
java.awt.image.BufferedImage |
getCenterFooterImage()
Gets / set image for center part of the footer. |
int |
getCenterFooterPictureHeight()
Gets or set height of picture for center part of the footer. |
int |
getCenterFooterPictureWidth()
Gets or set width of picture for center part of the footer. |
java.lang.String |
getCenterHeader()
Returns or sets the center part of the header. |
java.awt.image.BufferedImage |
getCenterHeaderImage()
Gets / set image for center part of the header. |
int |
getCenterHeaderPictureHeight()
Gets or set height of picture for center part of the header. |
int |
getCenterHeaderPictureWidth()
Gets or set width of picture for center part of the header. |
boolean |
getCenterHorizontally()
True if the sheet is centered horizontally on the page when it is printed. |
boolean |
getCenterVertically()
True if the sheet is centered vertically on the page when it is printed. |
int |
getCopies()
Number of copies to print. |
byte |
getDifferentFirst()
Indicates whether different first page header and footer.Default value is 0 |
byte |
getDifferentOddEven()
Indicates whether different odd and even page headers and footers.Default value is 0 |
boolean |
getDraft()
True if the sheet will be printed without graphics. |
java.lang.String |
getEvenFooterString()
Gets OddEven page footer string. |
java.lang.String |
getEvenHeaderString()
Gets Even page header string. |
java.lang.String |
getFirstFooterString()
Gets first page footer string. |
java.lang.String |
getFirstHeaderString()
Represents first page header string. |
int |
getFirstPageNumber()
Returns or sets the first page number that will be used when this sheet is printed. |
int |
getFitToPagesTall()
Returns or sets the number of pages tall the worksheet will be scaled to when it is printed. |
int |
getFitToPagesWide()
Returns or sets the number of pages wide the worksheet will be scaled to when it is printed. |
double |
getFooterMarginInch()
Returns or sets the distance from the bottom of the page to the footer, in inches. |
java.lang.String |
getFullFooterString()
Gets footer full string. |
java.lang.String |
getFullHeaderString()
Represents full header string. |
double |
getHeaderMarginInch()
Returns or sets the distance from the top of the page to the header, in inches. |
int |
getHResolution()
Gets or sets horizontal resolution in dpi. |
java.lang.String |
getLeftFooter()
Returns or sets the left part of the footer. |
java.awt.image.BufferedImage |
getLeftFooterImage()
Gets / set image for left part of the footer. |
int |
getLeftFooterPictureHeight()
Gets or set height of picture for left part of the footer. |
int |
getLeftFooterPictureWidth()
Gets or set width of picture for left part of the footer. |
java.lang.String |
getLeftHeader()
Returns or sets the left part of the header. |
java.awt.image.BufferedImage |
getLeftHeaderImage()
Gets / set image for left part of the header. |
int |
getLeftHeaderPictureHeight()
Gets or set height of picture for left part of the header. |
int |
getLeftHeaderPictureWidth()
Gets or set width of picture for left part of the header. |
double |
getLeftMargin()
Returns the size of the left margin, in inches. |
java.lang.String |
getOddFooterString()
Gets Odd page footer string. |
java.lang.String |
getOddHeaderString()
Gets Odd page header string. |
OrderType |
getOrder()
Returns order that Microsoft Excel uses to number pages when printing a large worksheet. |
PageOrientationType |
getOrientation()
Portrait or landscape printing mode. |
double |
getPageHeight()
Returns page width in points. |
double |
getPageWidth()
Returns page width in points. |
PaperSizeType |
getPaperSize()
Returns the size of the paper. |
PrintCommentType |
getPrintComments()
Returns or sets the way comments are printed with the sheet. |
PrintErrorsType |
getPrintErrors()
Sets or returns an ExcelPrintErrors constant specifying the type of print error displayed. |
java.lang.String |
getRightFooter()
Returns or sets the right part of the footer. |
java.awt.image.BufferedImage |
getRightFooterImage()
Gets / set image for right part of the footer. |
int |
getRightFooterPictureHeight()
Gets or set height of picture for right part of the footer. |
int |
getRightFooterPictureWidth()
Gets or set width of picture for right part of the footer. |
java.lang.String |
getRightHeader()
Returns or sets the right part of the header. |
java.awt.image.BufferedImage |
getRightHeaderImage()
Gets / set image for right part of the header. |
int |
getRightHeaderPictureHeight()
Gets or set height of picture for right part of the header. |
int |
getRightHeaderPictureWidth()
Gets or set width of picture for right part of the header. |
double |
getRightMargin()
Returns the size of the right margin, in inches. |
byte |
getScaleWithDoc()
Indicates whether scale header and footer with document scaling.Default value is 1 |
double |
getTopMargin()
Returns the size of the top margin, in inches. |
int |
getVResolution()
Gets vertical resolution in dpi. |
int |
getZoom()
Returns a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing. |
void |
setAlignWithMargins(byte value)
Indicates whether align header footer margins with page margins.Default value is 1 |
void |
setAutoFirstPageNumber(boolean value)
Indicates whether FirstPageNumber is set to Auto or not. |
void |
setBackgoundImage(java.awt.image.BufferedImage image)
Gets / sets background image. |
void |
setBlackAndWhite(boolean value)
True if elements of the document will be printed in black and white. |
void |
setBottomMargin(double bottomMargin)
Sets the size of the bottom margin, in inches. |
void |
setCenterFooter(java.lang.String centerFooter)
Sets the center part of the footer. |
void |
setCenterFooterImage(java.awt.image.BufferedImage image)
Sets image for center part of the footer. |
void |
setCenterFooterPictureHeight(int value)
Gets or set height of picture for center part of the footer. |
void |
setCenterFooterPictureWidth(int value)
Gets or set width of picture for center part of the footer. |
void |
setCenterHeader(java.lang.String value)
Returns or sets the center part of the header. |
void |
setCenterHeaderImage(java.awt.image.BufferedImage image)
Gets / set image for center part of the header. |
void |
setCenterHeaderImage(java.awt.image.BufferedImage image,
float scale)
|
void |
setCenterHeaderPictureHeight(int value)
Gets or set height of picture for center part of the header. |
void |
setCenterHeaderPictureWidth(int value)
Gets or set width of picture for center part of the header. |
void |
setCenterHorizontally(boolean value)
True if the sheet is centered horizontally on the page when it is printed. |
void |
setCenterVertically(boolean value)
True if the sheet is centered vertically on the page when it is printed. |
void |
setCopies(int value)
Number of copies to print. |
void |
setDifferentFirst(byte value)
Indicates whether different first page header and footer.Default value is 0 |
void |
setDifferentOddEven(byte differentOddEven)
Indicates whether different odd and even page headers and footers. |
void |
setDraft(boolean value)
True if the sheet will be printed without graphics. |
void |
setEvenFooterString(java.lang.String evenFooterString)
Sets odd even page footer string. |
void |
setEvenHeaderString(java.lang.String evenHeaderString)
Sets even page header string. |
void |
setFirstFooterString(java.lang.String value)
Gets first page footer string. |
void |
setFirstHeaderString(java.lang.String value)
Represents first page header string. |
void |
setFirstPageNumber(int value)
Returns or sets the first page number that will be used when this sheet is printed. |
void |
setFitToPagesTall(int value)
Returns or sets the number of pages tall the worksheet will be scaled to when it is printed. |
void |
setFitToPagesWide(int value)
Returns or sets the number of pages wide the worksheet will be scaled to when it is printed. |
void |
setFooterMarginInch(double value)
Returns or sets the distance from the bottom of the page to the footer, in inches. |
void |
setFullFooterString(java.lang.String value)
Gets footer full string. |
void |
setFullHeaderString(java.lang.String value)
Represents full header string. |
void |
setHeaderMarginInch(double value)
Returns or sets the distance from the top of the page to the header, in inches. |
void |
setHResolution(int value)
Gets or sets horizontal resolution in dpi. |
void |
setLeftFooter(java.lang.String value)
Returns or sets the left part of the footer. |
void |
setLeftFooterImage(java.awt.image.BufferedImage value)
set image for left part of the footer. |
void |
setLeftFooterPictureHeight(int value)
Gets or set height of picture for left part of the footer. |
void |
setLeftFooterPictureWidth(int value)
Gets or set width of picture for left part of the footer. |
void |
setLeftHeader(java.lang.String leftHeader)
Sets the left part of the header. |
void |
setLeftHeaderImage(java.awt.image.BufferedImage bufferedImage)
Sets image for left part of the header. |
void |
setLeftHeaderImage(java.awt.image.BufferedImage bufferedImage,
float scale)
Sets image for left part of the header. |
void |
setLeftHeaderPictureHeight(int value)
Gets or set height of picture for left part of the header. |
void |
setLeftHeaderPictureWidth(int value)
Gets or set width of picture for left part of the header. |
void |
setLeftMargin(double leftMargin)
Sets the value of the left margin, in inches. |
void |
setOddFooterString(java.lang.String oddFooterString)
Sets odd page footer string. |
void |
setOddHeaderString(java.lang.String oddHeaderString)
Sets odd page header string. |
void |
setOrder(OrderType value)
Sets the order that Microsoft Excel uses to number pages when printing a large worksheet. |
void |
setOrientation(PageOrientationType orientation)
Sets portrait or landscape printing mode. |
void |
setPaperSize(PaperSizeType paperSize)
Sets the size of the paper. |
void |
setPrintComments(PrintCommentType value)
Returns or sets the way comments are printed with the sheet. |
void |
setPrintErrors(PrintErrorsType value)
Sets or returns an ExcelPrintErrors constant specifying the type of print error displayed. |
void |
setRightFooter(java.lang.String value)
Returns or sets the right part of the footer. |
void |
setRightFooterImage(java.awt.image.BufferedImage image)
set image for right part of the footer. |
void |
setRightFooterPictureHeight(int value)
Gets or set height of picture for right part of the footer. |
void |
setRightFooterPictureWidth(int value)
Gets or set width of picture for right part of the footer. |
void |
setRightHeader(java.lang.String value)
Returns or sets the right part of the header. |
void |
setRightHeaderImage(java.awt.image.BufferedImage bufferedImage)
set image for right part of the header. |
void |
setRightHeaderImage(java.awt.image.BufferedImage bufferedImage,
float scale)
set image for right part of the header. |
void |
setRightHeaderPictureHeight(int value)
Gets or set height of picture for right part of the header. |
void |
setRightHeaderPictureWidth(int value)
Gets or set width of picture for right part of the header. |
void |
setRightMargin(double rightMargin)
Sets the size of the right margin, in inches. |
void |
setScaleWithDoc(byte value)
Indicates whether scale header and footer with document scaling.Default value is 1 |
void |
setTopMargin(double topMargin)
Sets the size of the top margin, in inches. |
void |
setVResolution(int value)
Sets vertical resolution in dpi. |
void |
setZoom(int value)
Sets a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing. |
| Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject |
|---|
dispose |
| Methods inherited from interface com.spire.xls.core.interfacess.IPageSetupBase |
|---|
getBackgoundInnerImage, getPrintNotes, getPrintQuality, setBackgoundInnerImage, setPrintNotes, setPrintQuality |
| Constructor Detail |
|---|
public XlsPageSetupBase(java.lang.Object parent)
| Method Detail |
|---|
public boolean getAutoFirstPageNumber()
getAutoFirstPageNumber in interface IPageSetupBasepublic void setAutoFirstPageNumber(boolean value)
setAutoFirstPageNumber in interface IPageSetupBasepublic boolean getBlackAndWhite()
getBlackAndWhite in interface IPageSetupBasepublic void setBlackAndWhite(boolean value)
setBlackAndWhite in interface IPageSetupBasepublic double getBottomMargin()
getBottomMargin in interface IPageSetupBasepublic void setBottomMargin(double bottomMargin)
setBottomMargin in interface IPageSetupBasepublic java.lang.String getCenterFooter()
getCenterFooter in interface IPageSetupBasepublic void setCenterFooter(java.lang.String centerFooter)
setCenterFooter in interface IPageSetupBasepublic java.awt.image.BufferedImage getCenterFooterImage()
getCenterFooterImage in interface IPageSetupBasepublic void setCenterFooterImage(java.awt.image.BufferedImage image)
setCenterFooterImage in interface IPageSetupBaseimage - public java.lang.String getCenterHeader()
getCenterHeader in interface IPageSetupBasepublic void setCenterHeader(java.lang.String value)
setCenterHeader in interface IPageSetupBasepublic java.awt.image.BufferedImage getCenterHeaderImage()
getCenterHeaderImage in interface IPageSetupBasepublic void setCenterHeaderImage(java.awt.image.BufferedImage image)
IPageSetupBase
setCenterHeaderImage in interface IPageSetupBase
public void setCenterHeaderImage(java.awt.image.BufferedImage image,
float scale)
public boolean getCenterHorizontally()
getCenterHorizontally in interface IPageSetupBasepublic void setCenterHorizontally(boolean value)
setCenterHorizontally in interface IPageSetupBasepublic boolean getCenterVertically()
getCenterVertically in interface IPageSetupBasepublic void setCenterVertically(boolean value)
setCenterVertically in interface IPageSetupBasepublic int getCopies()
getCopies in interface IPageSetupBasepublic void setCopies(int value)
setCopies in interface IPageSetupBasepublic boolean getDraft()
getDraft in interface IPageSetupBasepublic void setDraft(boolean value)
setDraft in interface IPageSetupBasepublic int getFirstPageNumber()
getFirstPageNumber in interface IPageSetupBasepublic void setFirstPageNumber(int value)
setFirstPageNumber in interface IPageSetupBasepublic double getFooterMarginInch()
getFooterMarginInch in interface IPageSetupBasepublic void setFooterMarginInch(double value)
setFooterMarginInch in interface IPageSetupBasepublic int getFitToPagesTall()
public void setFitToPagesTall(int value)
public int getFitToPagesWide()
public void setFitToPagesWide(int value)
public double getHeaderMarginInch()
getHeaderMarginInch in interface IPageSetupBasepublic void setHeaderMarginInch(double value)
setHeaderMarginInch in interface IPageSetupBasepublic int getHResolution()
public void setHResolution(int value)
public java.lang.String getFullHeaderString()
public void setFullHeaderString(java.lang.String value)
public java.lang.String getFullFooterString()
public void setFullFooterString(java.lang.String value)
public java.lang.String getFirstHeaderString()
public void setFirstHeaderString(java.lang.String value)
public java.lang.String getFirstFooterString()
public void setFirstFooterString(java.lang.String value)
public java.lang.String getOddHeaderString()
public void setOddHeaderString(java.lang.String oddHeaderString)
public java.lang.String getOddFooterString()
public void setOddFooterString(java.lang.String oddFooterString)
public java.lang.String getEvenHeaderString()
public void setEvenHeaderString(java.lang.String evenHeaderString)
public java.lang.String getEvenFooterString()
public void setEvenFooterString(java.lang.String evenFooterString)
public byte getAlignWithMargins()
public void setAlignWithMargins(byte value)
public byte getDifferentOddEven()
public void setDifferentOddEven(byte differentOddEven)
public byte getScaleWithDoc()
public void setScaleWithDoc(byte value)
public byte getDifferentFirst()
public void setDifferentFirst(byte value)
public int getVResolution()
public void setVResolution(int value)
public java.lang.String getLeftFooter()
getLeftFooter in interface IPageSetupBasepublic void setLeftFooter(java.lang.String value)
setLeftFooter in interface IPageSetupBasepublic java.awt.image.BufferedImage getLeftFooterImage()
getLeftFooterImage in interface IPageSetupBasepublic void setLeftFooterImage(java.awt.image.BufferedImage value)
setLeftFooterImage in interface IPageSetupBasevalue - public java.lang.String getLeftHeader()
getLeftHeader in interface IPageSetupBasepublic void setLeftHeader(java.lang.String leftHeader)
setLeftHeader in interface IPageSetupBasepublic java.awt.image.BufferedImage getLeftHeaderImage()
getLeftHeaderImage in interface IPageSetupBasepublic void setLeftHeaderImage(java.awt.image.BufferedImage bufferedImage)
setLeftHeaderImage in interface IPageSetupBasebufferedImage -
public void setLeftHeaderImage(java.awt.image.BufferedImage bufferedImage,
float scale)
bufferedImage - scale - public double getLeftMargin()
getLeftMargin in interface IPageSetupBasepublic void setLeftMargin(double leftMargin)
setLeftMargin in interface IPageSetupBasepublic OrderType getOrder()
getOrder in interface IPageSetupBasepublic void setOrder(OrderType value)
setOrder in interface IPageSetupBasepublic PageOrientationType getOrientation()
getOrientation in interface IPageSetupBasepublic void setOrientation(PageOrientationType orientation)
setOrientation in interface IPageSetupBasepublic PaperSizeType getPaperSize()
getPaperSize in interface IPageSetupBasepublic void setPaperSize(PaperSizeType paperSize)
setPaperSize in interface IPageSetupBasepublic PrintCommentType getPrintComments()
getPrintComments in interface IPageSetupBasepublic void setPrintComments(PrintCommentType value)
setPrintComments in interface IPageSetupBasepublic PrintErrorsType getPrintErrors()
getPrintErrors in interface IPageSetupBasepublic void setPrintErrors(PrintErrorsType value)
setPrintErrors in interface IPageSetupBasepublic java.lang.String getRightFooter()
getRightFooter in interface IPageSetupBasepublic void setRightFooter(java.lang.String value)
setRightFooter in interface IPageSetupBasepublic java.awt.image.BufferedImage getRightFooterImage()
getRightFooterImage in interface IPageSetupBasepublic void setRightFooterImage(java.awt.image.BufferedImage image)
setRightFooterImage in interface IPageSetupBaseimage - public java.lang.String getRightHeader()
getRightHeader in interface IPageSetupBasepublic void setRightHeader(java.lang.String value)
setRightHeader in interface IPageSetupBasepublic java.awt.image.BufferedImage getRightHeaderImage()
getRightHeaderImage in interface IPageSetupBasepublic void setRightHeaderImage(java.awt.image.BufferedImage bufferedImage)
setRightHeaderImage in interface IPageSetupBasebufferedImage -
public void setRightHeaderImage(java.awt.image.BufferedImage bufferedImage,
float scale)
bufferedImage - scale - public double getRightMargin()
getRightMargin in interface IPageSetupBasepublic void setRightMargin(double rightMargin)
setRightMargin in interface IPageSetupBasepublic double getTopMargin()
getTopMargin in interface IPageSetupBasepublic void setTopMargin(double topMargin)
setTopMargin in interface IPageSetupBasepublic int getZoom()
getZoom in interface IPageSetupBasepublic void setZoom(int value)
setZoom in interface IPageSetupBasepublic int getCenterFooterPictureWidth()
public void setCenterFooterPictureWidth(int value)
public int getCenterFooterPictureHeight()
public void setCenterFooterPictureHeight(int value)
public int getCenterHeaderPictureWidth()
public void setCenterHeaderPictureWidth(int value)
public int getCenterHeaderPictureHeight()
public void setCenterHeaderPictureHeight(int value)
public int getLeftFooterPictureWidth()
public void setLeftFooterPictureWidth(int value)
public int getLeftFooterPictureHeight()
public void setLeftFooterPictureHeight(int value)
public int getLeftHeaderPictureWidth()
public void setLeftHeaderPictureWidth(int value)
public int getLeftHeaderPictureHeight()
public void setLeftHeaderPictureHeight(int value)
public int getRightFooterPictureWidth()
public void setRightFooterPictureWidth(int value)
public int getRightFooterPictureHeight()
public void setRightFooterPictureHeight(int value)
public int getRightHeaderPictureWidth()
public void setRightHeaderPictureWidth(int value)
public int getRightHeaderPictureHeight()
public void setRightHeaderPictureHeight(int value)
public java.awt.image.BufferedImage getBackgoundImage()
public void setBackgoundImage(java.awt.image.BufferedImage image)
image - public double getPageWidth()
public double getPageHeight()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||