PageSettings

Inheritance: java.lang.Object

public class PageSettings

Represents printing settings for a page of project view.

Constructors

Constructor	Description
PageSettings()	Initializes a new instance of the PageSettings class.

Methods

Method	Description
getAdjustToPercentOfNormalSize()	Gets a value indicating whether to adjust printing to the specified percentage (PercentOfNormalSize(getPercentOfNormalSize()/ setPercentOfNormalSize(int))) of normal size.
getFirstPageNumber()	Gets a first page number for printing.
getPagesInHeight()	Gets a number of pages in height to be printed.
getPagesInWidth()	Gets a number of pages in width to be printed.
getPaperSize()	Gets a paper size.
getPaperSizeId()	Gets an integer representing one of the PrinterPaperSize values or a custom page size id.
getPercentOfNormalSize()	Gets a percentage of normal size to adjust printing to.
isPortrait()	Gets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.
setAdjustToPercentOfNormalSize(boolean value)	Sets a value indicating whether to adjust printing to the specified percentage (PercentOfNormalSize(getPercentOfNormalSize()/ setPercentOfNormalSize(int))) of normal size.
setFirstPageNumber(short value)	Sets a first page number for printing.
setPagesInHeight(int value)	Sets a number of pages in height to be printed.
setPagesInWidth(int value)	Sets a number of pages in width to be printed.
setPaperSize(int value)	Sets a paper size.
setPaperSizeId(int value)	Sets an integer representing one of the PrinterPaperSize values or a custom page size id.
setPercentOfNormalSize(int value)	Sets a percentage of normal size to adjust printing to.
setPortrait(boolean value)	Sets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.

PageSettings()

public PageSettings()

Initializes a new instance of the PageSettings class. Represents printing settings for a page of project view.

getAdjustToPercentOfNormalSize()

public final boolean getAdjustToPercentOfNormalSize()

Gets a value indicating whether to adjust printing to the specified percentage (PercentOfNormalSize(getPercentOfNormalSize()/ setPercentOfNormalSize(int))) of normal size.

---

Is not effective when project is rendered in HTML format.

Returns: boolean - a value indicating whether to adjust printing to the specified percentage (PercentOfNormalSize(getPercentOfNormalSize()/ setPercentOfNormalSize(int))) of normal size.

getFirstPageNumber()

public final short getFirstPageNumber()

Gets a first page number for printing.

Returns: short - a first page number for printing.

getPagesInHeight()

public final int getPagesInHeight()

Gets a number of pages in height to be printed.

Returns: int - a number of pages in height to be printed.

getPagesInWidth()

public final int getPagesInWidth()

Gets a number of pages in width to be printed.

Returns: int - a number of pages in width to be printed.

getPaperSize()

public final int getPaperSize()

Gets a paper size. Can be one of the values of the PrinterPaperSize enumeration.

Returns: int - a paper size.

getPaperSizeId()

public final int getPaperSizeId()

Gets an integer representing one of the PrinterPaperSize values or a custom page size id. This value can be used to get PaperSize from OS settings ().

Returns: int - an integer representing one of the PrinterPaperSize values or a custom page size id.

getPercentOfNormalSize()

public final int getPercentOfNormalSize()

Gets a percentage of normal size to adjust printing to.

Returns: int - a percentage of normal size to adjust printing to.

isPortrait()

public final boolean isPortrait()

Gets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.

---

Is applicable during rendering when SaveOptions.getPageSize() == PageSize.DefinedInView.

Returns: boolean - a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.

setAdjustToPercentOfNormalSize(boolean value)

public final void setAdjustToPercentOfNormalSize(boolean value)

Sets a value indicating whether to adjust printing to the specified percentage (PercentOfNormalSize(getPercentOfNormalSize()/ setPercentOfNormalSize(int))) of normal size.

---

Is not effective when project is rendered in HTML format.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether to adjust printing to the specified percentage (PercentOfNormalSize(getPercentOfNormalSize()/ setPercentOfNormalSize(int))) of normal size.

setFirstPageNumber(short value)

public final void setFirstPageNumber(short value)

Sets a first page number for printing.

Parameters:

Parameter	Type	Description
value	short	a first page number for printing.

setPagesInHeight(int value)

public final void setPagesInHeight(int value)

Sets a number of pages in height to be printed.

Parameters:

Parameter	Type	Description
value	int	a number of pages in height to be printed.

setPagesInWidth(int value)

public final void setPagesInWidth(int value)

Sets a number of pages in width to be printed.

Parameters:

Parameter	Type	Description
value	int	a number of pages in width to be printed.

setPaperSize(int value)

public final void setPaperSize(int value)

Sets a paper size. Can be one of the values of the PrinterPaperSize enumeration.

Parameters:

Parameter	Type	Description
value	int	a paper size.

setPaperSizeId(int value)

public final void setPaperSizeId(int value)

Sets an integer representing one of the PrinterPaperSize values or a custom page size id. This value can be used to get PaperSize from OS settings ().

Parameters:

Parameter	Type	Description
value	int	an integer representing one of the PrinterPaperSize values or a custom page size id.

setPercentOfNormalSize(int value)

public final void setPercentOfNormalSize(int value)

Sets a percentage of normal size to adjust printing to.

Parameters:

Parameter	Type	Description
value	int	a percentage of normal size to adjust printing to.

setPortrait(boolean value)

public final void setPortrait(boolean value)

Sets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.

---

Is applicable during rendering when SaveOptions.getPageSize() == PageSize.DefinedInView.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.