PageSettings

java.lang.Object
- com.grapecity.documents.excel.PageSettings

public class PageSettings
extends java.lang.Object

Represent the settings of the page.

Constructor Summary

Constructors
Constructor and Description

PageSettings()

Constructors
Constructor and Description
`PageSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PageSettings`	`clone()`
`boolean`	`getAlignMarginsHeaderFooter()` Returns whether to align the header and the footer with the margins set in the page setup options.
`Rect`	`getAvailbleContentRect()`
`boolean`	`getBlackAndWhite()` Returns whether the elements of the document will be printed in black and white.
`double`	`getBottomMargin()` Returns the size of the bottom margin, in points.
`java.lang.String`	`getCenterFooter()` Returns the alignment of text on the center footer of the page.
`IGraphic`	`getCenterFooterPicture()` Returns a IGraphic object that represents the picture for the center section of the footer.
`java.lang.String`	`getCenterHeader()` Returns the alignment of text on the center header of the page.
`IGraphic`	`getCenterHeaderPicture()` Returns a IGraphic object that represents the picture for the center section of the header.
`boolean`	`getCenterHorizontally()` Returns whether the sheet is centered horizontally on the page when it's printed.
`boolean`	`getCenterVertically()` Returns whether the sheet is centered vertically on the page when it's printed.
`boolean`	`getDraft()` Returns whether the sheet will be printed without graphics.
`double`	`getFooterMargin()` Returns the size of the footer margin, in points.
`double`	`getHeaderMargin()` Returns the size of the header margin, in points.
`java.lang.String`	`getLeftFooter()` Returns the alignment of text on the left footer of the page.
`IGraphic`	`getLeftFooterPicture()` Returns a IGraphic object that represents the picture for the left section of the footer.
`java.lang.String`	`getLeftHeader()` Returns the alignment of text on the left header of the page.
`IGraphic`	`getLeftHeaderPicture()` Returns a IGraphic object that represents the picture for the left section of the header.
`double`	`getLeftMargin()` Returns the size of the left margin, in points.
`double`	`getPaperHeight()` Returns the height in points of the paper, considered page orientation.
`double`	`getPaperWidth()` Returns the width in points of the paper, considered page orientation.
`PrintErrors`	`getPrintErrors()` Returns an PrintErrors contstant specifying the type of print error displayed.
`boolean`	`getPrintGridlines()` Returns whether cell gridlines are printed on the page.
`java.lang.String`	`getRightFooter()` Returns the alignment of text on the right footer of the page.
`IGraphic`	`getRightFooterPicture()` Returns a IGraphic object that represents the picture for the right section of the footer.
`java.lang.String`	`getRightHeader()` Returns the alignment of text on the right header of the page.
`IGraphic`	`getRightHeaderPicture()` Returns a IGraphic object that represents the picture for the right section of the header.
`double`	`getRightMargin()` Returns the size of the right margin, in points.
`boolean`	`getScaleWithDocHeaderFooter()` Returns if the header and footer should be scaled with the document when the size of the document changes.
`double`	`getTopMargin()` Returns the size of the top margin, in points.
`void`	`setAlignMarginsHeaderFooter(boolean value)` Sets whether to align the header and the footer with the margins set in the page setup options.
`void`	`setBlackAndWhite(boolean value)` Sets whether the 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)` Sets the alignment of text on the center footer of the page.
`void`	`setCenterFooterPicture(IGraphic value)` Sets a IGraphic object that represents the picture for the center section of the footer.
`void`	`setCenterHeader(java.lang.String value)` Sets the alignment of text on the center header of the page.
`void`	`setCenterHeaderPicture(IGraphic value)` Sets a IGraphic object that represents the picture for the center section of the header.
`void`	`setCenterHorizontally(boolean value)` Sets whether the sheet is centered horizontally on the page when it's printed.
`void`	`setCenterVertically(boolean value)` Sets whether the sheet is centered vertically on the page when it's printed.
`void`	`setDraft(boolean value)` Sets whether the sheet will be printed without graphics.
`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`	`setLeftFooter(java.lang.String value)` Sets the alignment of text on the left footer of the page.
`void`	`setLeftFooterPicture(IGraphic value)` Sets a IGraphic object that represents the picture for the left section of the footer.
`void`	`setLeftHeader(java.lang.String value)` Sets the alignment of text on the left header of the page.
`void`	`setLeftHeaderPicture(IGraphic value)` Sets a IGraphic object that represents the picture for the left section of the header.
`void`	`setLeftMargin(double value)` Sets the size of the left margin, in points.
`void`	`setPaperHeight(double value)` Sets the height in points of the paper, considered page orientation.
`void`	`setPaperWidth(double value)` Sets the width in points of the paper, considered page orientation.
`void`	`setPrintErrors(PrintErrors value)` Sets an PrintErrors contstant specifying the type of print error displayed.
`void`	`setPrintGridlines(boolean value)` Sets whether cell gridlines are printed on the page.
`void`	`setRightFooter(java.lang.String value)` Sets the alignment of text on the right footer of the page.
`void`	`setRightFooterPicture(IGraphic value)` Sets a IGraphic object that represents the picture for the right section of the footer.
`void`	`setRightHeader(java.lang.String value)` Sets the alignment of text on the right header of the page.
`void`	`setRightHeaderPicture(IGraphic value)` Sets a IGraphic object that represents the picture for the right section 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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PageSettings
```
public PageSettings()
```
- Method Detail
  - getScaleWithDocHeaderFooter
```
public final boolean getScaleWithDocHeaderFooter()
```
    Returns if the header and footer should be scaled with the document when the size of the document changes.
  - setScaleWithDocHeaderFooter
```
public final void setScaleWithDocHeaderFooter(boolean value)
```
    Sets if the header and footer should be scaled with the document when the size of the document changes.
  - getCenterFooter
```
public final java.lang.String getCenterFooter()
```
    Returns the alignment of text on the center footer of the page.
  - setCenterFooter
```
public final void setCenterFooter(java.lang.String value)
```
    Sets the alignment of text on the center footer of the page.
  - getLeftFooter
```
public final java.lang.String getLeftFooter()
```
    Returns the alignment of text on the left footer of the page.
  - setLeftFooter
```
public final void setLeftFooter(java.lang.String value)
```
    Sets the alignment of text on the left footer of the page.
  - getRightFooter
```
public final java.lang.String getRightFooter()
```
    Returns the alignment of text on the right footer of the page.
  - setRightFooter
```
public final void setRightFooter(java.lang.String value)
```
    Sets the alignment of text on the right footer of the page.
  - getLeftHeader
```
public final java.lang.String getLeftHeader()
```
    Returns the alignment of text on the left header of the page.
  - setLeftHeader
```
public final void setLeftHeader(java.lang.String value)
```
    Sets the alignment of text on the left header of the page.
  - getCenterHeader
```
public final java.lang.String getCenterHeader()
```
    Returns the alignment of text on the center header of the page.
  - setCenterHeader
```
public final void setCenterHeader(java.lang.String value)
```
    Sets the alignment of text on the center header of the page.
  - getRightHeader
```
public final java.lang.String getRightHeader()
```
    Returns the alignment of text on the right header of the page.
  - setRightHeader
```
public final void setRightHeader(java.lang.String value)
```
    Sets the alignment of text on the right header of the page.
  - getCenterFooterPicture
```
public final IGraphic getCenterFooterPicture()
```
    Returns a IGraphic object that represents the picture for the center section of the footer. Used to set attributes about the picture.
  - setCenterFooterPicture
```
public final void setCenterFooterPicture(IGraphic value)
```
    Sets a IGraphic object that represents the picture for the center section of the footer. Used to set attributes about the picture.
  - getLeftFooterPicture
```
public final IGraphic getLeftFooterPicture()
```
    Returns a IGraphic object that represents the picture for the left section of the footer. Used to set attributes about the picture.
  - setLeftFooterPicture
```
public final void setLeftFooterPicture(IGraphic value)
```
    Sets a IGraphic object that represents the picture for the left section of the footer. Used to set attributes about the picture.
  - getRightFooterPicture
```
public final IGraphic getRightFooterPicture()
```
    Returns a IGraphic object that represents the picture for the right section of the footer. Used to set attributes of the picture.
  - setRightFooterPicture
```
public final void setRightFooterPicture(IGraphic value)
```
    Sets a IGraphic object that represents the picture for the right section of the footer. Used to set attributes of the picture.
  - getLeftHeaderPicture
```
public final IGraphic getLeftHeaderPicture()
```
    Returns a IGraphic object that represents the picture for the left section of the header. Used to set attributes about the picture.
  - setLeftHeaderPicture
```
public final void setLeftHeaderPicture(IGraphic value)
```
    Sets a IGraphic object that represents the picture for the left section of the header. Used to set attributes about the picture.
  - getCenterHeaderPicture
```
public final IGraphic getCenterHeaderPicture()
```
    Returns a IGraphic object that represents the picture for the center section of the header. Used to set attributes about the picture.
  - setCenterHeaderPicture
```
public final void setCenterHeaderPicture(IGraphic value)
```
    Sets a IGraphic object that represents the picture for the center section of the header. Used to set attributes about the picture.
  - getRightHeaderPicture
```
public final IGraphic getRightHeaderPicture()
```
    Returns a IGraphic object that represents the picture for the right section of the header. Used to set attributes of the picture.
  - setRightHeaderPicture
```
public final void setRightHeaderPicture(IGraphic value)
```
    Sets a IGraphic object that represents the picture for the right section of the header. Used to set attributes of the picture.
  - getBlackAndWhite
```
public final boolean getBlackAndWhite()
```
    Returns whether the elements of the document will be printed in black and white.
  - setBlackAndWhite
```
public final void setBlackAndWhite(boolean value)
```
    Sets whether the elements of the document will be printed in black and white.
  - getDraft
```
public final boolean getDraft()
```
    Returns whether the sheet will be printed without graphics.
  - setDraft
```
public final void setDraft(boolean value)
```
    Sets whether the sheet will be printed without graphics.
  - getPrintGridlines
```
public final boolean getPrintGridlines()
```
    Returns whether cell gridlines are printed on the page. Applies only to worksheets.
  - setPrintGridlines
```
public final void setPrintGridlines(boolean value)
```
    Sets whether cell gridlines are printed on the page. Applies only to worksheets.
  - getPrintErrors
```
public final PrintErrors getPrintErrors()
```
    Returns an PrintErrors contstant specifying the type of print error displayed. This feature allows users to suppress the display of error values when printing a worksheet.
  - setPrintErrors
```
public final void setPrintErrors(PrintErrors value)
```
    Sets an PrintErrors contstant specifying the type of print error displayed. This feature allows users to suppress the display of error values when printing a worksheet.
  - getAlignMarginsHeaderFooter
```
public final boolean getAlignMarginsHeaderFooter()
```
    Returns whether to align the header and the footer with the margins set in the page setup options.
  - setAlignMarginsHeaderFooter
```
public final void setAlignMarginsHeaderFooter(boolean value)
```
    Sets whether to align the header and the footer with the margins set in the page setup options.
  - getCenterHorizontally
```
public final boolean getCenterHorizontally()
```
    Returns whether the sheet is centered horizontally on the page when it's printed.
  - setCenterHorizontally
```
public final void setCenterHorizontally(boolean value)
```
    Sets whether the sheet is centered horizontally on the page when it's printed.
  - getCenterVertically
```
public final boolean getCenterVertically()
```
    Returns whether the sheet is centered vertically on the page when it's printed.
  - setCenterVertically
```
public final void setCenterVertically(boolean value)
```
    Sets whether the sheet is centered vertically on the page when it's printed.
  - getLeftMargin
```
public final double 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.
  - getTopMargin
```
public final double 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.
  - getRightMargin
```
public final double 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.
  - getBottomMargin
```
public final double 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.
  - getHeaderMargin
```
public final double getHeaderMargin()
```
    Returns the size of the header margin, in points.
  - setHeaderMargin
```
public final void setHeaderMargin(double value)
```
    Sets the size of the header margin, in points.
  - getFooterMargin
```
public final double 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.
  - getPaperWidth
```
public final double getPaperWidth()
```
    Returns the width in points of the paper, considered page orientation.
  - setPaperWidth
```
public final void setPaperWidth(double value)
```
    Sets the width in points of the paper, considered page orientation.
  - getPaperHeight
```
public final double getPaperHeight()
```
    Returns the height in points of the paper, considered page orientation.
  - setPaperHeight
```
public final void setPaperHeight(double value)
```
    Sets the height in points of the paper, considered page orientation.
  - getAvailbleContentRect
```
public final Rect getAvailbleContentRect()
```
  - clone
```
public final PageSettings clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class PageSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PageSettings

Method Detail

getScaleWithDocHeaderFooter

setScaleWithDocHeaderFooter

getCenterFooter

setCenterFooter

getLeftFooter

setLeftFooter

getRightFooter

setRightFooter

getLeftHeader

setLeftHeader

getCenterHeader

setCenterHeader

getRightHeader

setRightHeader

getCenterFooterPicture

setCenterFooterPicture

getLeftFooterPicture

setLeftFooterPicture

getRightFooterPicture

setRightFooterPicture

getLeftHeaderPicture

setLeftHeaderPicture

getCenterHeaderPicture

setCenterHeaderPicture

getRightHeaderPicture

setRightHeaderPicture

getBlackAndWhite

setBlackAndWhite

getDraft

setDraft

getPrintGridlines

setPrintGridlines

getPrintErrors

setPrintErrors

getAlignMarginsHeaderFooter

setAlignMarginsHeaderFooter

getCenterHorizontally

setCenterHorizontally

getCenterVertically

setCenterVertically

getLeftMargin

setLeftMargin

getTopMargin

setTopMargin

getRightMargin

setRightMargin

getBottomMargin

setBottomMargin

getHeaderMargin

setHeaderMargin

getFooterMargin

setFooterMargin

getPaperWidth

setPaperWidth

getPaperHeight

setPaperHeight

getAvailbleContentRect

clone