com.aspose.cells
Class PageSetup

java.lang.Object
    com.aspose.cells.PageSetup

public class PageSetup 
extends java.lang.Object

Workbook workbook = new Workbook();

WorksheetCollection sheets = workbook.getWorksheets();

//Add a worksheet
sheets.add();
Worksheet sheet = sheets.get(1);
PageSetup pageSetup = sheet.getPageSetup();
pageSetup.setPrintArea("D1:K13");

//do your business

public OdsPageBackground getODSPageBackground()

Gets the background of ODS.

public java.lang.String getPrintArea() / public void setPrintArea(java.lang.String value)

Represents the range to be printed.

public void setPrintArea(java.lang.String value)

public java.lang.String getPrintTitleColumns() / public void setPrintTitleColumns(java.lang.String value)

Represents the columns that contain the cells to be repeated on the left side of each page.

Example:

pageSetup.setPrintTitleColumns("$A:$A");

public void setPrintTitleColumns(java.lang.String value)

public java.lang.String getPrintTitleRows() / public void setPrintTitleRows(java.lang.String value)

Represents the rows that contain the cells to be repeated at the top of each page.

Example:

pageSetup.setPrintTitleRows("$1:$1");

public void setPrintTitleRows(java.lang.String value)

public boolean getBlackAndWhite() / public void setBlackAndWhite(boolean value)

Represents if elements of the document will be printed in black and white.

public void setBlackAndWhite(boolean value)

public boolean getCenterHorizontally() / public void setCenterHorizontally(boolean value)

Represent if the sheet is printed centered horizontally.

public void setCenterHorizontally(boolean value)

public boolean getCenterVertically() / public void setCenterVertically(boolean value)

Represent if the sheet is printed centered vertically.

public void setCenterVertically(boolean value)

public boolean getPrintDraft() / public void setPrintDraft(boolean value)

Represents if the sheet will be printed without graphics.

public void setPrintDraft(boolean value)

public double getFooterMargin() / public void setFooterMargin(double value)

Represents the distance from the bottom of the page to the footer, in unit of centimeters.

public void setFooterMargin(double value)

public double getFooterMarginInch() / public void setFooterMarginInch(double value)

Represents the distance from the bottom of the page to the footer, in unit of inches.

public void setFooterMarginInch(double value)

public double getHeaderMargin() / public void setHeaderMargin(double value)

Represents the distance from the top of the page to the header, in unit of centimeters.

public void setHeaderMargin(double value)

public double getHeaderMarginInch() / public void setHeaderMarginInch(double value)

Represents the distance from the top of the page to the header, in unit of inches.

public void setHeaderMarginInch(double value)

public byte[] getPrinterSettings() / public void setPrinterSettings(byte[] value)

Gets and sets the settings of the default printer.

public void setPrinterSettings(byte[] value)

public double getLeftMargin() / public void setLeftMargin(double value)

Represents the size of the left margin, in unit of centimeters.

public void setLeftMargin(double value)

public double getLeftMarginInch() / public void setLeftMarginInch(double value)

Represents the size of the left margin, in unit of inches.

public void setLeftMarginInch(double value)

public double getRightMargin() / public void setRightMargin(double value)

Represents the size of the right margin, in unit of centimeters.

public void setRightMargin(double value)

public double getRightMarginInch() / public void setRightMarginInch(double value)

Represents the size of the right margin, in unit of inches.

public void setRightMarginInch(double value)

public double getTopMargin() / public void setTopMargin(double value)

Represents the size of the top margin, in unit of centimeters.

public void setTopMargin(double value)

public double getTopMarginInch() / public void setTopMarginInch(double value)

Represents the size of the top margin, in unit of inches.

public void setTopMarginInch(double value)

public double getBottomMargin() / public void setBottomMargin(double value)

Represents the size of the bottom margin, in unit of centimeters.

public void setBottomMargin(double value)

public double getBottomMarginInch() / public void setBottomMarginInch(double value)

Represents the size of the bottom margin, in unit of inches.

public void setBottomMarginInch(double value)

public int getFirstPageNumber() / public void setFirstPageNumber(int value)

Represents the first page number that will be used when this sheet is printed.

public void setFirstPageNumber(int value)

public int getFitToPagesTall() / public void setFitToPagesTall(int value)

Represents the number of pages tall the worksheet will be scaled to when it's printed. The default value is 1.

You have to set FitToPagesWide as zero if you want to fit all rows on one page.

public void setFitToPagesTall(int value)

public int getFitToPagesWide() / public void setFitToPagesWide(int value)

Represents the number of pages wide the worksheet will be scaled to when it's printed. The default value is 1.

You have to set FitToPagesTall as zero if you want to fit all columns on one page.

public void setFitToPagesWide(int value)

public boolean isPercentScale() / public void setPercentScale(boolean value)

If this property is False, the FitToPagesWide and FitToPagesTall properties control how the worksheet is scaled.

public void setPercentScale(boolean value)

public int getOrder() / public void setOrder(int value)

Represents the order that Microsoft Excel uses to number pages when printing a large worksheet. The value of the property is PrintOrderType integer constant.

public void setOrder(int value)

public boolean isAutomaticPaperSize()

Indicates whether the paper size is automatic.

public int getPaperSize() / public void setPaperSize(int value)

Represents the size of the paper. The value of the property is PaperSizeType integer constant.

public void setPaperSize(int value)

public double getPaperWidth()

Gets the width of the paper in unit of inches, considered page orientation.

public double getPaperHeight()

Gets the height of the paper in unit of inches , considered page orientation.

public int getOrientation() / public void setOrientation(int value)

Represents page print orientation. The value of the property is PageOrientationType integer constant.

public void setOrientation(int value)

public int getPrintComments() / public void setPrintComments(int value)

Represents the way comments are printed with the sheet. The value of the property is PrintCommentsType integer constant.

public void setPrintComments(int value)

public int getPrintErrors() / public void setPrintErrors(int value)

Specifies the type of print error displayed. The value of the property is PrintErrorsType integer constant.

public void setPrintErrors(int value)

public boolean getPrintHeadings() / public void setPrintHeadings(boolean value)

Represents if row and column headings are printed with this page.

public void setPrintHeadings(boolean value)

public boolean getPrintGridlines() / public void setPrintGridlines(boolean value)

Represents if cell gridlines are printed on the page.

public void setPrintGridlines(boolean value)

public int getZoom() / public void setZoom(int value)

Represents the scaling factor in percent. It should be between 10 and 400.

public void setZoom(int value)

public boolean isAutoFirstPageNumber() / public void setAutoFirstPageNumber(boolean value)

Indicates whether the first the page number is automatically assigned.

public void setAutoFirstPageNumber(boolean value)

public int getPrintQuality() / public void setPrintQuality(int value)

Represents the print quality.

public void setPrintQuality(int value)

public int getPrintCopies() / public void setPrintCopies(int value)

Get and sets number of copies to print.

public void setPrintCopies(int value)

public boolean isHFDiffOddEven() / public void setHFDiffOddEven(boolean value)

True means that the header/footer of the odd pages is different with odd pages.

public void setHFDiffOddEven(boolean value)

public boolean isHFDiffFirst() / public void setHFDiffFirst(boolean value)

True means that the header/footer of the first page is different with other pages.

public void setHFDiffFirst(boolean value)

public boolean isHFScaleWithDoc() / public void setHFScaleWithDoc(boolean value)

Indicates whether header and footer are scaled with document scaling. Only applies for Excel 2007.

public void setHFScaleWithDoc(boolean value)

public boolean isHFAlignMargins() / public void setHFAlignMargins(boolean value)

Indicates whether header and footer margins are aligned with the page margins. If this property is true, the left header and footer will be aligned with the left margin, and the right header and footer will be aligned with the right margin. This option is enabled by default.

public void setHFAlignMargins(boolean value)

public Picture setHeaderPicture(int section, byte[] headerPicture)
                        throws java.lang.Exception

Sets an image in the header of a worksheet.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

headerPicture - Image data.

Returns:

Returns Picture object.

public Picture setFooterPicture(int section, byte[] footerPicture)
                        throws java.lang.Exception

Sets an image in the footer of a worksheet.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

footerPicture - Image data.

Returns:

Returns Picture object.

public Picture setPicture(boolean isFirst, boolean isEven, boolean isHeader, int section, byte[] imageData)
                  throws java.lang.Exception

Sets an image in the header/footer of a worksheet.

Parameters:

isFirst - Indicates whether setting the picture of first page header/footer.

isEven - Indicates whether setting the picture of even page header/footer.

isHeader - Indicates whether setting the picture of header/footer.

section - 0: Left Section, 1: Center Section, 2: Right Section.

imageData - Image data.

Returns:

Returns Picture object.

public Picture getPicture(boolean isHeader, int section)

Gets the Picture object of the header / footer.

Parameters:

isHeader - Indicates whether it is in the header or footer.

section - 0: Left Section, 1: Center Section, 2: Right Section.

Returns:

Returns Picture object. Returns null if there is no picture.

public Picture getPicture(boolean isFirst, boolean isEven, boolean isHeader, int section)

Gets the Picture object of the header / footer.

Parameters:

isFirst - Indicates whether getting the picture of first page header/footer.

isEven - Indicates whether getting the picture of even page header/footer.

isHeader - Indicates whether getting the picture of header/footer.

section - 0: Left Section, 1: Center Section, 2: Right Section.

Returns:

Returns Picture object.

public void copy(PageSetup source, CopyOptions copyOptions)
         throws java.lang.Exception

Copies the setting of the page setup.

Parameters:

source - The source.

copyOptions - The copy options.

public void setFitToPages(int wide, int tall)

Sets the number of pages the worksheet will be scaled to when it's printed.

Parameters:

wide - Pages wide.

tall - Pages tall.

public void customPaperSize(double width, double height)

Sets the custom paper size, in unit of inches.

Parameters:

width - The width of the paper.

height - The height of the paper.

public void clearHeaderFooter()

Clears header and footer setting.

public java.lang.String getHeader(int section)

Gets a script formatting the header of an Excel file.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

public com.aspose.cells.HeaderFooterCommand[] getCommands(java.lang.String headerFooterScript)

Gets all commands of header or footer.

Parameters:

headerFooterScript - The header/footer script

Returns:

Returns all commands of header or footer.

public java.lang.String getFooter(int section)

Gets a script formatting the footer of an Excel file.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

public void setHeader(int section, java.lang.String headerScript)

Sets a script formatting the header of an Excel file.

Script commands:

Command	Description
&P	Current page number
&N	Page count
&D	Current date
&T	Current time
&A	Sheet name
&F	File name without path
&"<FontName>"	Font name, for example: &"Arial"
&"<FontName>, <FontStyle>"	Font name and font style, for example: &"Arial,Bold"
&<FontSize>	Font size. If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.
&K<RRGGBB>	Font color, for example(RED): &KFF0000
&G	Image script

For example: "&Arial,Bold&8Header Note"

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

headerScript - Header format script.

public void setFooter(int section, java.lang.String footerScript)

Sets a script formatting the footer of an Excel file.

Script commands:

Command	Description
&P	Current page number
&N	Page count
&D	Current date
&T	Current time
&A	Sheet name
&F	File name without path
&"<FontName>"	Font name, for example: &"Arial"
&"<FontName>, <FontStyle>"	Font name and font style, for example: &"Arial,Bold"
&<FontSize>	Font size. If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.
&K<RRGGBB>	Font color, for example(RED): &KFF0000
&G	Image script

For example: "&Arial,Bold&8Footer Note"

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

footerScript - Footer format script.

public void setEvenHeader(int section, java.lang.String headerScript)

Sets a script formatting the even page header of an Excel file. Only effect in Excel 2007 when IsHFDiffOddEven is true.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

headerScript - Header format script.

public java.lang.String getEvenHeader(int section)

Gets a script formatting the even header of an Excel file.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

public void setEvenFooter(int section, java.lang.String footerScript)

Sets a script formatting the even page footer of an Excel file. Only effect in Excel 2007 when IsHFDiffOddEven is true.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

footerScript - Footer format script.

public java.lang.String getEvenFooter(int section)

Gets a script formatting the even footer of an Excel file.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

public void setFirstPageHeader(int section, java.lang.String headerScript)

Sets a script formatting the first page header of an Excel file. Only effect in Excel 2007 when IsHFDiffFirst is true.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

headerScript - Header format script.

public java.lang.String getFirstPageHeader(int section)

Gets a script formatting the first page header of an Excel file.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

public void setFirstPageFooter(int section, java.lang.String footerScript)

Sets a script formatting the first page footer of an Excel file.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.

footerScript - Footer format script.

public java.lang.String getFirstPageFooter(int section)

Gets a script formatting the first page footer of an Excel file.

Parameters:

section - 0: Left Section, 1: Center Section, 2: Right Section.