Method Details

• getScaleWithDocHeaderFooter

  public final boolean getScaleWithDocHeaderFooter()

  Gets whether the header and footer are scaled with the document when the document size changes.

  Use this property to determine whether header and footer content follows the document scaling settings.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setScaleWithDocHeaderFooter(true);
   boolean scaleWithDocHeaderFooter = pageSettings.getScaleWithDocHeaderFooter();
   

  Returns:

  true if the header and footer are scaled with the document when the document size changes; otherwise, false.

• setScaleWithDocHeaderFooter

  public final void setScaleWithDocHeaderFooter(boolean value)

  Sets whether the header and footer are scaled with the document when the document size changes.

  Use this property to set whether header and footer content follows the document scaling settings.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setScaleWithDocHeaderFooter(true);
   

  Parameters:

  value - true if the header and footer are scaled with the document when the document size changes; otherwise, false.

• getCenterFooter

  public final String getCenterFooter()

  Returns the text in the center footer of the page.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setCenterFooter("Page &P of &N");
   String centerFooter = pageSettings.getCenterFooter();
   

  Returns:

  The text in the center footer of the page.

• setCenterFooter

  public final void setCenterFooter(String value)

  Sets the text displayed in the center footer of the page.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setCenterFooter("&P");
   

  Parameters:

  value - The text of the center footer. Sets null if the center footer has not been set.

• getLeftFooter

  public final String getLeftFooter()

  Gets the text in the left section of the page footer.

  Use this method to retrieve the footer content previously assigned with setLeftFooter(String).

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setLeftFooter("Confidential");
   String leftFooter = pageSettings.getLeftFooter();
   

  Returns:

  The text in the left section of the page footer, or null if no left footer text has been set.

• setLeftFooter

  public final void setLeftFooter(String value)

  Sets the text in the left section of the page footer.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setLeftFooter("Confidential");
   

  Parameters:

  value - The text in the left section of the page footer, or null if no left footer text has been set.

• getRightFooter

  public final String getRightFooter()

  Gets the text in the right section of the page footer.

  Use this method to retrieve the footer content previously assigned with setRightFooter(String).

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setRightFooter("Page &[Page] of &[Pages]");
   String rightFooter = pageSettings.getRightFooter();
   

  Returns:

  The text in the right section of the page footer, or null if no right footer text has been set.

• setRightFooter

  public final void setRightFooter(String value)

  Sets the text in the right section of the page footer.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setRightFooter("Page &[Page] of &[Pages]");
   

  Parameters:

  value - The text in the right section of the page footer, or null if no right footer text has been set.

• getLeftHeader

  public final String getLeftHeader()

  Gets the text on the left header of the page.

  Use this method to retrieve the header string configured by setLeftHeader(String) for the left section of the page header.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setLeftHeader("Confidential");
   String leftHeader = pageSettings.getLeftHeader();
   

  Returns:

  The text on the left header of the page.

• setLeftHeader

  public final void setLeftHeader(String value)

  Sets the text on the left header of the page.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setLeftHeader("Confidential");
   

  Parameters:

  value - The text on the left header of the page.

• getCenterHeader

  public final String getCenterHeader()

  Gets the text displayed in the center section of the page header.

  Use this method to retrieve the header content previously set by setCenterHeader(String) for the center header area.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setCenterHeader("Sales Report");
   String centerHeader = pageSettings.getCenterHeader();
   

  Returns:

  The center header text. Returns null if no center header text has been set.

• setCenterHeader

  public final void setCenterHeader(String value)

  Sets the text displayed in the center section of the page header.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setCenterHeader("Sales Report");
   

  Parameters:

  value - The center header text. Sets null if no center header text has been set.

• getRightHeader

  public final String getRightHeader()

  Gets the text on the right header of the page.

  Use this method to retrieve the header string configured by setRightHeader(String) for the right section of the page header.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setRightHeader("Quarterly Summary");
   String rightHeader = pageSettings.getRightHeader();
   

  Returns:

  The text on the right header of the page, or null if no right header text has been set.

• setRightHeader

  public final void setRightHeader(String value)

  Sets the text on the right header of the page.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setRightHeader("Quarterly Summary");
   

  Parameters:

  value - The text on the right header of the page, or null if no right header text has been set.

• getCenterFooterPicture

  public final IGraphic getCenterFooterPicture()

  Gets the picture for the center section of the page footer.

  Use this method to retrieve the IGraphic object previously assigned with setCenterFooterPicture(IGraphic) and to access or modify the picture's attributes.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setCenterFooter("&G");
   IGraphic picture = worksheet.getPageSetup().getCenterFooterPicture();
   pageSettings.setCenterFooter("&G");
   pageSettings.setCenterFooterPicture(picture);
   IGraphic centerFooterPicture = pageSettings.getCenterFooterPicture();
   

  Returns:

  The IGraphic object that represents the picture in the center section of the page footer, or null if no picture has been assigned.

• setCenterFooterPicture

  public final void setCenterFooterPicture(IGraphic value)

  Sets the picture for the center section of the page footer.

  Use this method to assign the IGraphic object that represents the center footer picture. The assigned object can be used together with setCenterFooter(String) to display a picture in the center footer section.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setCenterFooter("&G");
   IGraphic picture = worksheet.getPageSetup().getCenterFooterPicture();
   pageSettings.setCenterFooter("&G");
   pageSettings.setCenterFooterPicture(picture);
   

  Parameters:

  value - The IGraphic object that represents the picture for the center section of the page footer, or null if no picture should be assigned.

• getLeftFooterPicture

  public final IGraphic getLeftFooterPicture()

  Gets the picture for the left section of the page footer.

  Use this method to retrieve the IGraphic object previously assigned with setLeftFooterPicture(IGraphic) and to access or modify the picture's attributes.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setLeftFooter("&G");
   IGraphic picture = worksheet.getPageSetup().getLeftFooterPicture();
   pageSettings.setLeftFooter("&G");
   pageSettings.setLeftFooterPicture(picture);
   IGraphic leftFooterPicture = pageSettings.getLeftFooterPicture();
   

  Returns:

  The IGraphic object that represents the picture in the left section of the page footer, or null if no picture has been assigned.

• setLeftFooterPicture

  public final void setLeftFooterPicture(IGraphic value)

  Sets the picture for the left section of the page footer.

  Use this method to assign the IGraphic object that represents the left footer picture. The assigned object can be used together with setLeftFooter(String) to display a picture in the left footer section.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setLeftFooter("&G");
   IGraphic picture = worksheet.getPageSetup().getLeftFooterPicture();
   pageSettings.setLeftFooter("&G");
   pageSettings.setLeftFooterPicture(picture);
   

  Parameters:

  value - The IGraphic object that represents the picture for the left section of the page footer, or null if no picture should be assigned.

• getRightFooterPicture

  public final IGraphic getRightFooterPicture()

  Gets the picture for the right section of the page footer.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setRightFooter("&G");
   IGraphic picture = worksheet.getPageSetup().getRightFooterPicture();
   pageSettings.setRightFooter("&G");
   pageSettings.setRightFooterPicture(picture);
   IGraphic rightFooterPicture = pageSettings.getRightFooterPicture();
   

  Returns:

  The picture for the right section of the page footer.

• setRightFooterPicture

  public final void setRightFooterPicture(IGraphic value)

  Sets the picture for the right section of the page footer.

  Use this method to assign the IGraphic object that represents the right footer picture. The assigned object can be used together with setRightFooter(String) to display a picture in the right footer section.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setRightFooter("&G");
   IGraphic picture = worksheet.getPageSetup().getRightFooterPicture();
   pageSettings.setRightFooter("&G");
   pageSettings.setRightFooterPicture(picture);
   

  Parameters:

  value - The IGraphic object that represents the picture for the right section of the page footer, or null if no picture should be assigned.

• getLeftHeaderPicture

  public final IGraphic getLeftHeaderPicture()

  Gets the picture for the left section of the page header.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setLeftHeader("&G");
   IGraphic picture = worksheet.getPageSetup().getLeftHeaderPicture();
   pageSettings.setLeftHeader("&G");
   pageSettings.setLeftHeaderPicture(picture);
   IGraphic leftHeaderPicture = pageSettings.getLeftHeaderPicture();
   

  Returns:

  The picture for the left section of the page header.

• setLeftHeaderPicture

  public final void setLeftHeaderPicture(IGraphic value)

  Sets the picture for the left section of the header.

  Use this method to assign an IGraphic object for the left header picture. The assigned graphic can then be configured with properties such as the image source and size.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setLeftHeader("&G");
   IGraphic graphic = worksheet.getPageSetup().getLeftHeaderPicture();
   pageSettings.setLeftHeader("&G");
   pageSettings.setLeftHeaderPicture(graphic);
   

  Parameters:

  value - The IGraphic object that represents the picture for the left section of the header; can be null.

• getCenterHeaderPicture

  public final IGraphic getCenterHeaderPicture()

  Gets the picture for the center section of the page header.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setCenterHeader("&G");
   IGraphic picture = worksheet.getPageSetup().getCenterHeaderPicture();
   pageSettings.setCenterHeader("&G");
   pageSettings.setCenterHeaderPicture(picture);
   IGraphic centerHeaderPicture = pageSettings.getCenterHeaderPicture();
   

  Returns:

  The picture for the center section of the page header.

• setCenterHeaderPicture

  public final void setCenterHeaderPicture(IGraphic value)

  Sets a IGraphic object that represents the picture for the center section of the header.

  Use this method to assign a picture object for the center header section after enabling the header picture field, for example by using setCenterHeader(String) with the &G code. The assigned picture object is used to set attributes about the picture.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setCenterHeader("&G");
   IGraphic graphic = worksheet.getPageSetup().getCenterHeaderPicture();
   pageSettings.setCenterHeader("&G");
   pageSettings.setCenterHeaderPicture(graphic);
   

  Parameters:

  value - The picture object for the center section of the header. Can be null.

• getRightHeaderPicture

  public final IGraphic getRightHeaderPicture()

  Gets the picture for the right section of the page header.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setRightHeader("&G");
   IGraphic picture = worksheet.getPageSetup().getRightHeaderPicture();
   pageSettings.setRightHeader("&G");
   pageSettings.setRightHeaderPicture(picture);
   IGraphic rightHeaderPicture = pageSettings.getRightHeaderPicture();
   

  Returns:

  The picture for the right section of the page header.

• setRightHeaderPicture

  public final void setRightHeaderPicture(IGraphic value)

  Sets an IGraphic object that represents the picture for the right section of the header.

  Use setRightHeader(String) with the "&G" placeholder to display the picture in the right header section.

  
   PageSettings pageSettings = new PageSettings();
   worksheet.getPageSetup().setRightHeader("&G");
   IGraphic graphic = worksheet.getPageSetup().getRightHeaderPicture();
   pageSettings.setRightHeader("&G");
   pageSettings.setRightHeaderPicture(graphic);
   

  Parameters:

  value - The IGraphic object that represents the picture for the right section of the header. null is allowed.

• getBlackAndWhite

  public final boolean getBlackAndWhite()

  Gets whether the elements of the document will be printed in black and white.

  Use this property to determine whether page content is configured for black-and-white printing.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setBlackAndWhite(true);
   boolean blackAndWhite = pageSettings.getBlackAndWhite();
   

  Returns:

  true if the elements of the document will be printed in black and white; otherwise, false.

• setBlackAndWhite

  public final void setBlackAndWhite(boolean value)

  Sets whether the elements of the document will be printed in black and white.

  Use this property to set whether page content is configured for black-and-white printing.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setBlackAndWhite(true);
   

  Parameters:

  value - true if the elements of the document will be printed in black and white; otherwise, false.

• getDraft

  public final boolean getDraft()

  Gets whether the sheet will be printed without graphics.

  When this property is true, the sheet is printed without graphics.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setDraft(true);
   boolean draft = pageSettings.getDraft();
   

  Returns:

  true if the sheet will be printed without graphics; otherwise, false.

• setDraft

  public final void setDraft(boolean value)

  Sets whether the sheet will be printed without graphics.

  When this property is true, the sheet is printed without graphics.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setDraft(true);
   

  Parameters:

  value - true if the sheet will be printed without graphics; otherwise, false.

• getPrintGridlines

  public final boolean getPrintGridlines()

  Gets whether cell gridlines are printed on the page.

  This setting applies only to worksheets.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setPrintGridlines(true);
   boolean printGridlines = pageSettings.getPrintGridlines();
   

  Returns:

  true if cell gridlines are printed on the page; otherwise, false.

• setPrintGridlines

  public final void setPrintGridlines(boolean value)

  Sets whether cell gridlines are printed on the page.

  This setting applies only to worksheets.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setPrintGridlines(true);
   

  Parameters:

  value - true if cell gridlines are printed on the page; otherwise, false.

• getPrintErrors

  public final PrintErrors getPrintErrors()

  Gets the print error display option for the page.

  This setting specifies how worksheet error values are displayed when the worksheet is printed. It can be used together with setPrintErrors(PrintErrors) to suppress the display of error values in printed output.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setPrintErrors(PrintErrors.Dash);
   PrintErrors printErrors = pageSettings.getPrintErrors();
   

  Returns:

  The PrintErrors value that specifies how print errors are displayed.

• setPrintErrors

  public final void setPrintErrors(PrintErrors value)

  Sets the print error display option for the page.

  This setting controls how worksheet error values are displayed when the worksheet is printed. Use this method to show errors as-is or suppress them in printed output by using a different PrintErrors value.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setPrintErrors(PrintErrors.Displayed);
   

  Parameters:

  value - The PrintErrors value that specifies how print errors are displayed. null is permitted.

• getAlignMarginsHeaderFooter

  public final boolean getAlignMarginsHeaderFooter()

  Gets whether the header and footer are aligned with the margins set in the page setup options.

  Use this property to determine whether header and footer content follows the left and right page margins when the worksheet is printed or exported as pages.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setAlignMarginsHeaderFooter(true);
   boolean alignMargins = pageSettings.getAlignMarginsHeaderFooter();
   

  Returns:

  true if the header and footer are aligned with the page margins; otherwise, false.

• setAlignMarginsHeaderFooter

  public final void setAlignMarginsHeaderFooter(boolean value)

  Sets whether the header and footer are aligned with the margins set in the page setup options.

  Use this property to set whether header and footer content follows the left and right page margins when the worksheet is printed or exported as pages.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setAlignMarginsHeaderFooter(true);
   

  Parameters:

  value - true if the header and footer are aligned with the page margins; otherwise, false.

• getCenterHorizontally

  public final boolean getCenterHorizontally()

  Gets whether the sheet is centered horizontally on the page when it is printed.

  Use this property to determine whether the printed sheet content is centered between the left and right page margins.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setCenterHorizontally(true);
   boolean centerHorizontally = pageSettings.getCenterHorizontally();
   

  Returns:

  true if the sheet is centered horizontally on the page when printed; otherwise, false.

• setCenterHorizontally

  public final void setCenterHorizontally(boolean value)

  Sets whether the sheet is centered horizontally on the page when it is printed.

  Use this property to set whether the printed sheet content is centered between the left and right page margins.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setCenterHorizontally(true);
   

  Parameters:

  value - true if the sheet is centered horizontally on the page when printed; otherwise, false.

• getCenterVertically

  public final boolean getCenterVertically()

  Gets whether the sheet is centered vertically on the page when it is printed.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setCenterVertically(true);
   boolean centerVertically = pageSettings.getCenterVertically();
   

  Returns:

  true if the sheet is centered vertically on the page when printed; otherwise, false.

• setCenterVertically

  public final void setCenterVertically(boolean value)

  Sets whether the sheet is centered vertically on the page when it is printed.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setCenterVertically(true);
   

  Parameters:

  value - true if the sheet is centered vertically on the page when printed; otherwise, false.

• getLeftMargin

  public final double getLeftMargin()

  Gets the size of the left margin, in points.

  Use this property to retrieve the current left page margin configured in the page settings.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setLeftMargin(72);
   double leftMargin = pageSettings.getLeftMargin();
   

  Returns:

  The size of the left margin, in points.

• setLeftMargin

  public final void setLeftMargin(double value)

  Sets the size of the left margin, in points.

  Use this property to update the current left page margin configured in the page settings.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setLeftMargin(72);
   

  Parameters:

  value - The size of the left margin, in points.

• getTopMargin

  public final double getTopMargin()

  Gets the size of the top margin, in points.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setTopMargin(72d);
   double topMargin = pageSettings.getTopMargin();
   

  Returns:

  The size of the top margin, in points.

• setTopMargin

  public final void setTopMargin(double value)

  Sets the size of the top margin, in points.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setTopMargin(72d);
   

  Parameters:

  value - The size of the top margin, in points.

• getRightMargin

  public final double getRightMargin()

  Gets the size of the right margin, in points.

  This value is used for page layout when the worksheet is printed.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setRightMargin(72);
   double rightMargin = pageSettings.getRightMargin();
   

  Returns:

  The size of the right margin, in points.

• setRightMargin

  public final void setRightMargin(double value)

  Sets the size of the right margin, in points.

  This value is used for page layout when the worksheet is printed.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setRightMargin(72);
   

  Parameters:

  value - The size of the right margin, in points.

• getBottomMargin

  public final double getBottomMargin()

  Gets the size of the bottom margin, in points.

  This value specifies the bottom page margin used for printing or page-based export.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setBottomMargin(36d);
   double bottomMargin = pageSettings.getBottomMargin();
   

  Returns:

  The size of the bottom margin, in points.

• setBottomMargin

  public final void setBottomMargin(double value)

  Sets the size of the bottom margin, in points.

  This value specifies the bottom page margin used for printing or page-based export.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setBottomMargin(36d);
   

  Parameters:

  value - The size of the bottom margin, in points.

• getHeaderMargin

  public final double getHeaderMargin()

  Gets the size of the header margin, in points.

  Use this property to read the current spacing reserved for the header area in these page settings.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setHeaderMargin(18.0);
   double headerMargin = pageSettings.getHeaderMargin();
   

  Returns:

  The header margin size, in points.

• setHeaderMargin

  public final void setHeaderMargin(double value)

  Sets the size of the header margin, in points.

  Use this property to set the spacing reserved for the header area in these page settings.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setHeaderMargin(18.0);
   

  Parameters:

  value - The header margin size, in points.

• getFooterMargin

  public final double getFooterMargin()

  Gets the size of the footer margin, in points.

  This value controls the distance between the worksheet content and the footer area when the worksheet is printed.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setFooterMargin(18.0);
   double footerMargin = pageSettings.getFooterMargin();
   

  Returns:

  The size of the footer margin, in points.

• setFooterMargin

  public final void setFooterMargin(double value)

  Sets the size of the footer margin, in points.

  This value controls the distance between the worksheet content and the footer area when the worksheet is printed.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setFooterMargin(18.0);
   

  Parameters:

  value - The size of the footer margin, in points.

• getPaperWidth

  public final double getPaperWidth()

  Gets the width of the paper, in points, considered page orientation.

  Use this property together with getPaperHeight() to determine the paper dimensions currently applied to the page.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setPaperWidth(595.0);
   double paperWidth = pageSettings.getPaperWidth();
   

  Returns:

  The width of the paper, in points, considered page orientation.

• setPaperWidth

  public final void setPaperWidth(double value)

  Sets the width of the paper, in points, considered page orientation.

  Use this property together with getPaperHeight() to determine the paper dimensions currently applied to the page.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setPaperWidth(595.0);
   

  Parameters:

  value - The width of the paper, in points, considered page orientation.

• getPaperHeight

  public final double getPaperHeight()

  Gets the height in points of the paper, considered page orientation.

  Use this property together with getPaperWidth() to determine the paper dimensions currently applied to the page.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setPaperHeight(842.0);
   double paperHeight = pageSettings.getPaperHeight();
   

  Returns:

  The height of the paper, in points, considered page orientation.

• setPaperHeight

  public final void setPaperHeight(double value)

  Sets the height in points of the paper, considered page orientation.

  Use this property together with getPaperWidth() to determine the paper dimensions currently applied to the page.

  
   PageSettings pageSettings = new PageSettings();
   pageSettings.setPaperHeight(842.0);
   

  Parameters:

  value - The height of the paper, in points, considered page orientation.