public interface IPageSetup
| Modifier and Type | Method and Description |
|---|---|
void |
customPaperSize(double width,
double height)
Sets the custom paper size, in unit of inches.
|
void |
fromJson(java.lang.String json)
Generate the page setup from the json.
|
boolean |
getAlignMarginsHeaderFooter()
Gets True to align the header and the footer with the margins set in the
page setup options.
|
boolean |
getBestFitColumns()
Gets whether column widths are adjusted to fit the longest text width for printing.
|
boolean |
getBestFitRows()
Gets whether row heights are adjusted to fit the tallest text height for printing.
|
boolean |
getBlackAndWhite()
True if elements of the document will be printed in black and white.
|
double |
getBottomMargin()
Gets the size of the bottom margin, in points.
|
java.lang.String |
getCenterFooter()
Center aligns the footer information in the PageSetup object.
|
IGraphic |
getCenterFooterPicture()
Gets a
IGraphic object that represents the picture for the center
section of the footer. |
java.lang.String |
getCenterHeader()
Center aligns the header information in the PageSetup object.
|
IGraphic |
getCenterHeaderPicture()
Gets a
IGraphic object that represents the picture for the center
section of the header. |
boolean |
getCenterHorizontally()
True if the sheet is centered horizontally on the page when it's printed.
|
boolean |
getCenterVertically()
True if the sheet is centered vertically on the page when it's printed.
|
boolean |
getDifferentFirstPageHeaderFooter()
True if a different header or footer is used on the first page.
|
boolean |
getDraft()
True if the sheet will be printed without graphics.
|
IPage |
getEvenPage()
Gets the alignment of text on the even
IPage of a workbook or
section. |
IPage |
getFirstPage()
Gets the alignment of text on the first
IPage of a workbook or
section. |
int |
getFirstPageNumber()
Gets the first page number that will be used when this sheet is printed.
|
int |
getFitToPagesTall()
Gets the number of pages tall the worksheet will be scaled to when it's
printed.
|
int |
getFitToPagesWide()
Gets the number of pages wide the worksheet will be scaled to when it's
printed.
|
double |
getFooterMargin()
Gets the size of the footer margin, in points.
|
double |
getHeaderMargin()
Gets the size of the header margin, in points.
|
boolean |
getIsPercentScale()
If this property is False, the FitToPagesWide and FitToPagesTall properties
control how the worksheet is scaled.
|
java.lang.String |
getLeftFooter()
Gets the alignment of text on the left footer of a workbook or section.
|
IGraphic |
getLeftFooterPicture()
Gets a
IGraphic object that represents the picture for the left
section of the footer. |
java.lang.String |
getLeftHeader()
Gets the alignment of text on the left header of a workbook or section.
|
IGraphic |
getLeftHeaderPicture()
Gets a
IGraphic object that represents the picture for the left
section of the header. |
double |
getLeftMargin()
Gets the size of the left margin, in points.
|
boolean |
getOddAndEvenPagesHeaderFooter()
True if the specified PageSetup object has different headers and footers for
odd-numbered and even-numbered pages.
|
Order |
getOrder()
Gets a
Order value that represents the order that GcExcel
uses to number pages when printing a large worksheet. |
PageOrientation |
getOrientation()
Gets a
PageOrientation value that represents the portrait or
landscape printing mode. |
double |
getPaperHeight()
Represents the height in inches of the paper, considered page orientation.
|
PaperSize |
getPaperSize()
Gets the size of the paper.
|
double |
getPaperWidth()
Represents the width in inches of the paper, considered page orientation.
|
java.lang.String |
getPrintArea()
Gets the range to be printed, as a string using A1-style references in the
language of the macro.
|
PrintLocation |
getPrintComments()
Gets the way comments are printed with the sheet.
|
int |
getPrintCopies()
Gets number of copies to print.
|
PrintErrors |
getPrintErrors()
Gets an PrintErrors contstant specifying the type of print error
displayed.
|
boolean |
getPrintGridlines()
True if cell gridlines are printed on the page.
|
boolean |
getPrintHeadings()
True if row and column headings are printed with this page.
|
boolean |
getPrintNotes()
True if cell notes are printed as end notes with the sheet.
|
java.lang.String |
getPrintPageRange()
Gets range of pages to print, the numbers or page ranges are separated by commas counting from the beginning of the document.
|
PrintQuality |
getPrintQuality()
Gets a
PrintQuality value that represents the print quality of
this page. |
java.lang.String |
getPrintTailColumns()
Gets the columns that contain the cells to be repeated on the right side of
each page, as a string in A1-style notation in the language of the macro.
|
java.lang.String |
getPrintTailRows()
Gets the rows that contain the cells to be repeated on the bottom of
each page, as a string in A1-style notation in the language of the macro.
|
java.lang.String |
getPrintTitleColumns()
Gets the columns that contain the cells to be repeated on the left side of
each page, as a string in A1-style notation in the language of the macro.
|
java.lang.String |
getPrintTitleRows()
Gets the rows that contain the cells to be repeated at the top of each
page, as a string in A1-style notation in the language of the macro.
|
java.lang.String |
getRightFooter()
Gets the distance (in points) between the right edge of the page and the
right boundary of the footer.
|
IGraphic |
getRightFooterPicture()
Gets a
IGraphic object that represents the picture for the right
section of the footer. |
java.lang.String |
getRightHeader()
Gets the right part of the header.
|
IGraphic |
getRightHeaderPicture()
Gets a
IGraphic object that represents the picture for the right
section of the header. |
double |
getRightMargin()
Gets the size of the right margin, in points.
|
boolean |
getScaleWithDocHeaderFooter()
Gets if the header and footer should be scaled with the document when the
size of the document changes.
|
double |
getTopMargin()
Gets the size of the top margin, in points.
|
int |
getZoom()
Gets a Variant value that represents a percentage (between 10 and 400 percent) by which GcExcel will scale the worksheet for printing.
|
void |
setAlignMarginsHeaderFooter(boolean value)
Gets True to align the header and the footer with the margins set in the
page setup options.
|
void |
setBestFitColumns(boolean value)
Sets whether column widths are adjusted to fit the longest text width for printing.
|
void |
setBestFitRows(boolean value)
Sets whether row heights are adjusted to fit the tallest text height for printing.
|
void |
setBlackAndWhite(boolean value)
True if elements of the document will be printed in black and white.
|
void |
setBottomMargin(double value)
Sets the size of the bottom margin, in points.
|
void |
setCenterFooter(java.lang.String value)
Center aligns the footer information in the PageSetup object.
|
void |
setCenterHeader(java.lang.String value)
Center aligns the header information in the PageSetup object.
|
void |
setCenterHorizontally(boolean value)
True if the sheet is centered horizontally on the page when it's printed.
|
void |
setCenterVertically(boolean value)
True if the sheet is centered vertically on the page when it's printed.
|
void |
setDifferentFirstPageHeaderFooter(boolean value)
True if a different header or footer is used on the first page.
|
void |
setDraft(boolean value)
True if the sheet will be printed without graphics.
|
void |
setFirstPageNumber(int value)
Sets the first page number that will be used when this sheet is printed.
|
void |
setFitToPagesTall(int value)
Sets the number of pages tall the worksheet will be scaled to when it's
printed.
|
void |
setFitToPagesWide(int value)
Sets the number of pages wide the worksheet will be scaled to when it's
printed.
|
void |
setFooterMargin(double value)
Sets the size of the footer margin, in points.
|
void |
setHeaderMargin(double value)
Sets the size of the header margin, in points.
|
void |
setIsPercentScale(boolean value)
If this property is False, the FitToPagesWide and FitToPagesTall properties
control how the worksheet is scaled.
|
void |
setLeftFooter(java.lang.String value)
Sets the alignment of text on the left footer of a workbook or section.
|
void |
setLeftHeader(java.lang.String value)
Sets the alignment of text on the left header of a workbook or section.
|
void |
setLeftMargin(double value)
Sets the size of the left margin, in points.
|
void |
setOddAndEvenPagesHeaderFooter(boolean value)
True if the specified PageSetup object has different headers and footers for
odd-numbered and even-numbered pages.
|
void |
setOrder(Order value)
Sets a
Order value that represents the order that GcExcel
uses to number pages when printing a large worksheet. |
void |
setOrientation(PageOrientation value)
Sets a
PageOrientation value that represents the portrait or
landscape printing mode. |
void |
setPaperSize(PaperSize value)
Sets the size of the paper.
|
void |
setPrintArea(java.lang.String value)
Sets the range to be printed, as a string using A1-style references in the
language of the macro.
|
void |
setPrintComments(PrintLocation value)
Sets the way comments are printed with the sheet.
|
void |
setPrintCopies(int value)
Sets number of copies to print.
|
void |
setPrintErrors(PrintErrors value)
Sets an PrintErrors contstant specifying the type of print error displayed.
|
void |
setPrintGridlines(boolean value)
True if cell gridlines are printed on the page.
|
void |
setPrintHeadings(boolean value)
True if row and column headings are printed with this page.
|
void |
setPrintNotes(boolean value)
True if cell notes are printed as end notes with the sheet.
|
void |
setPrintPageRange(java.lang.String value)
Sets range of pages to print, the numbers or page ranges are separated by commas counting from the beginning of the document.
|
void |
setPrintQuality(PrintQuality value)
Sets a
PrintQuality value that represents the print quality of this
page. |
void |
setPrintTailColumns(java.lang.String value)
Sets the columns that contain the cells to be repeated on the right side of
each page, as a string in A1-style notation in the language of the macro.
|
void |
setPrintTailRows(java.lang.String value)
Sets the rows that contain the cells to be repeated on the bottom of
each page, as a string in A1-style notation in the language of the macro.
|
void |
setPrintTitleColumns(java.lang.String value)
Sets the columns that contain the cells to be repeated on the left side of
each page, as a string in A1-style notation in the language of the macro.
|
void |
setPrintTitleRows(java.lang.String value)
Sets the rows that contain the cells to be repeated at the top of each page,
as a string in A1-style notation in the language of the macro.
|
void |
setRightFooter(java.lang.String value)
Sets the distance (in points) between the right edge of the page and the
right boundary of the footer.
|
void |
setRightHeader(java.lang.String value)
Sets the right part of the header.
|
void |
setRightMargin(double value)
Sets the size of the right margin, in points.
|
void |
setScaleWithDocHeaderFooter(boolean value)
Sets if the header and footer should be scaled with the document when the
size of the document changes.
|
void |
setTopMargin(double value)
Sets the size of the top margin, in points.
|
void |
setZoom(int value)
Sets a Variant value that represents a percentage (between 10 and 400 percent) by which GcExcel will scale the worksheet for printing.
|
java.lang.String |
toJson()
Generate the json from page setup.
|
PrintQuality getPrintQuality()
PrintQuality value that represents the print quality of
this page. Default is 600 dpi.void setPrintQuality(PrintQuality value)
PrintQuality value that represents the print quality of this
page. Default is 600 dpi.boolean getBlackAndWhite()
void setBlackAndWhite(boolean value)
double getLeftMargin()
void setLeftMargin(double value)
double getRightMargin()
void setRightMargin(double value)
double getTopMargin()
void setTopMargin(double value)
double getBottomMargin()
void setBottomMargin(double value)
double getHeaderMargin()
void setHeaderMargin(double value)
double getFooterMargin()
void setFooterMargin(double value)
java.lang.String getCenterFooter()
void setCenterFooter(java.lang.String value)
java.lang.String getCenterHeader()
void setCenterHeader(java.lang.String value)
java.lang.String getLeftFooter()
void setLeftFooter(java.lang.String value)
java.lang.String getLeftHeader()
void setLeftHeader(java.lang.String value)
java.lang.String getRightFooter()
void setRightFooter(java.lang.String value)
java.lang.String getRightHeader()
void setRightHeader(java.lang.String value)
boolean getCenterHorizontally()
void setCenterHorizontally(boolean value)
boolean getCenterVertically()
void setCenterVertically(boolean value)
boolean getOddAndEvenPagesHeaderFooter()
void setOddAndEvenPagesHeaderFooter(boolean value)
boolean getDifferentFirstPageHeaderFooter()
void setDifferentFirstPageHeaderFooter(boolean value)
boolean getScaleWithDocHeaderFooter()
void setScaleWithDocHeaderFooter(boolean value)
boolean getAlignMarginsHeaderFooter()
void setAlignMarginsHeaderFooter(boolean value)
boolean getDraft()
void setDraft(boolean value)
int getFirstPageNumber()
void setFirstPageNumber(int value)
int getFitToPagesTall()
void setFitToPagesTall(int value)
int getFitToPagesWide()
void setFitToPagesWide(int value)
boolean getIsPercentScale()
void setIsPercentScale(boolean value)
Order getOrder()
Order value that represents the order that GcExcel
uses to number pages when printing a large worksheet.void setOrder(Order value)
Order value that represents the order that GcExcel
uses to number pages when printing a large worksheet.PageOrientation getOrientation()
PageOrientation value that represents the portrait or
landscape printing mode.void setOrientation(PageOrientation value)
PageOrientation value that represents the portrait or
landscape printing mode.PaperSize getPaperSize()
void setPaperSize(PaperSize value)
void customPaperSize(double width,
double height)
double getPaperWidth()
double getPaperHeight()
boolean getPrintGridlines()
void setPrintGridlines(boolean value)
boolean getPrintHeadings()
void setPrintHeadings(boolean value)
boolean getPrintNotes()
void setPrintNotes(boolean value)
java.lang.String getPrintArea()
void setPrintArea(java.lang.String value)
java.lang.String getPrintTitleColumns()
void setPrintTitleColumns(java.lang.String value)
java.lang.String getPrintTitleRows()
void setPrintTitleRows(java.lang.String value)
java.lang.String getPrintTailColumns()
void setPrintTailColumns(java.lang.String value)
java.lang.String getPrintTailRows()
void setPrintTailRows(java.lang.String value)
int getPrintCopies()
void setPrintCopies(int value)
java.lang.String getPrintPageRange()
void setPrintPageRange(java.lang.String value)
int getZoom()
void setZoom(int value)
PrintLocation getPrintComments()
void setPrintComments(PrintLocation value)
PrintErrors getPrintErrors()
void setPrintErrors(PrintErrors value)
IGraphic getCenterHeaderPicture()
IGraphic object that represents the picture for the center
section of the header. Used to set attributes about the picture.IGraphic getCenterFooterPicture()
IGraphic object that represents the picture for the center
section of the footer. Used to set attributes about the picture.IGraphic getLeftHeaderPicture()
IGraphic object that represents the picture for the left
section of the header. Used to set attributes about the picture.IGraphic getLeftFooterPicture()
IGraphic object that represents the picture for the left
section of the footer. Used to set attributes about the picture.IGraphic getRightHeaderPicture()
IGraphic object that represents the picture for the right
section of the header. Used to set attributes of the picture.IGraphic getRightFooterPicture()
IGraphic object that represents the picture for the right
section of the footer. Used to set attributes of the picture.IPage getEvenPage()
IPage of a workbook or
section.IPage getFirstPage()
IPage of a workbook or
section.boolean getBestFitColumns()
void setBestFitColumns(boolean value)
boolean getBestFitRows()
void setBestFitRows(boolean value)
void fromJson(java.lang.String json)
json - java.lang.String toJson()