com.spire.doc
Class PageSetup

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.PageSetup

All Implemented Interfaces:

IDocumentSerializable

public class PageSetup
extends DocumentSerializable

Method Summary

boolean	getBidi() Gets whether section contains right-to-left text.
Borders	getBorders() Gets page borders collection
CharacterSpacing	getCharacterSpacingControl() Character Spacing Control.
float	getClientHeight() Gets width of client area.
float	getClientWidth() Gets width of client area.
boolean	getColumnsLineBetween() Gets the value specifies if a vertical line is draw between each of the text columns in the this section.
float	getDefaultTabWidth() Gets the length of the auto tab.
boolean	getDifferentFirstPageHeaderFooter() Setting to specify that the current section has a different header/footer for first page.
boolean	getDifferentOddAndEvenPagesHeaderFooter() True if the document has different headers and footers for odd-numbered and even-numbered pages.
boolean	getEqualColumnWidth() Gets a value indicating whether equal column width.
float	getFooterDistance() Gets footer height in points.
GridPitchType	getGridType() Gets the grid type of this section.
float	getGutter() Gets extra space added to the margin for document binding in points.
float	getHeaderDistance() Gets height of header in points.
float	getLineNumberingDistanceFromText() Gets distance from text in lines numbering
LineNumberingRestartMode	getLineNumberingRestartMode() Returns line numbering mode
int	getLineNumberingStartValue() Gets line numbering start value
int	getLineNumberingStep() Gets line numbering step
int	getLinesPerPage() Gets the number of lines per page in the document grid.
MarginsF	getMargins() Gets page margins in points.
PageOrientation	getOrientation() Returns orientation of a page.
boolean	getPageBorderIncludeFooter() Gets a value indicating whether the page border include the footer.
boolean	getPageBorderIncludeHeader() Gets a value indicating whether the page border include the header.
PageBorderOffsetFrom	getPageBorderOffsetFrom() Gets the position of page border
PageBordersApplyType	getPageBordersApplyType() Gets the value that determine on which pages border is applied
PageNumberStyle	getPageNumberStyle() Gets the page number style.
java.awt.geom.Dimension2D	getPageSize() Gets page size in points.
int	getPageStartingNumber() Gets the page starting number.
boolean	getRestartPageNumbering() Gets a value indicating whether to restart page numbering.
PageAlignment	getVerticalAlignment() Gets the length of the auto tab.
void	insertPageNumbers(boolean fromTopPage, PageNumberAlignment horizontalAlignment) Inserts the page numbers.
boolean	isFrontPageBorder() Gets a value indicating whether this instance is front page border.
void	isFrontPageBorder(boolean value) Sets a value indicating whether this instance is front page border.
boolean	isTopGutter() Gets the value that determines whether use Top Gutter.
void	isTopGutter(boolean value) Sets the value that determines whether use Top Gutter.
void	setBidi(boolean value) Sets whether section contains right-to-left text.
void	setCharacterSpacingControl(CharacterSpacing value) Character Spacing Control.
void	setColumnsLineBetween(boolean value) Sets the value specifies if a vertical line is draw between each of the text columns in the this section.
void	setDefaultTabWidth(float value) Sets the length of the auto tab.
void	setDifferentFirstPageHeaderFooter(boolean value) Setting to specify that the current section has a different header/footer for first page.
void	setDifferentOddAndEvenPagesHeaderFooter(boolean value) True if the document has different headers and footers for odd-numbered and even-numbered pages.
void	setEqualColumnWidth(boolean value) Sets a value indicating whether equal column width.
void	setFooterDistance(float value) Sets footer height in points.
void	setGridType(GridPitchType value) Sets the grid type of this section.
void	setGutter(float value) Sets extra space added to the margin for document binding in points.
void	setHeaderDistance(float value) Gets or sets height of header in points.
void	setLineNumberingDistanceFromText(float value) Sets distance from text in lines numbering
void	setLineNumberingRestartMode(LineNumberingRestartMode value) Sets line numbering mode
void	setLineNumberingStartValue(int value) Sets line numbering start value
void	setLineNumberingStep(int value) Sets line numbering step
void	setLinesPerPage(int value) Sets the number of lines per page in the document grid.
void	setMargins(MarginsF value) Sets page margins in points.
void	setOrientation(PageOrientation value) Sets orientation of a page.
void	setPageBorderIncludeFooter(boolean value) Sets a value indicating whether the page border include the footer.
void	setPageBorderIncludeHeader(boolean value) Sets a value indicating whether the page border include the header.
void	setPageBorderOffsetFrom(PageBorderOffsetFrom value) Sets the position of page border
void	setPageBordersApplyType(PageBordersApplyType value) Sets the value that determine on which pages border is applied
void	setPageNumberStyle(PageNumberStyle value) Sets the page number style.
void	setPageSize(java.awt.geom.Dimension2D value) Sets page size in points.
void	setPageStartingNumber(int value) Sets the page starting number.
void	setRestartPageNumbering(boolean value) Sets a value indicating whether to restart page numbering.
void	setVerticalAlignment(PageAlignment value) Sets vertical alignment.
java.lang.String	toString()

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Method Detail

isTopGutter

public boolean isTopGutter()

Gets the value that determines whether use Top Gutter.

isTopGutter

public void isTopGutter(boolean value)

Sets the value that determines whether use Top Gutter.

getDefaultTabWidth

public float getDefaultTabWidth()

Gets the length of the auto tab.

Returns:

The length of the auto tab.

setDefaultTabWidth

public void setDefaultTabWidth(float value)

Sets the length of the auto tab.

Parameters:

value - The length of the auto tab.

getPageSize

public java.awt.geom.Dimension2D getPageSize()

Gets page size in points.

Returns:

SizeF

setPageSize

public void setPageSize(java.awt.geom.Dimension2D value)

Sets page size in points.

Parameters:

value - SizeF

getOrientation

public PageOrientation getOrientation()

Returns orientation of a page.

setOrientation

public void setOrientation(PageOrientation value)

Sets orientation of a page.

getVerticalAlignment

public PageAlignment getVerticalAlignment()

Gets the length of the auto tab.

Returns:

The length of the auto tab.

setVerticalAlignment

public void setVerticalAlignment(PageAlignment value)

Sets vertical alignment.

getMargins

public MarginsF getMargins()

Gets page margins in points.

setMargins

public void setMargins(MarginsF value)

Sets page margins in points.

getGutter

public float getGutter()

Gets extra space added to the margin for document binding in points.

setGutter

public void setGutter(float value)

Sets extra space added to the margin for document binding in points.

getHeaderDistance

public float getHeaderDistance()

Gets height of header in points.

setHeaderDistance

public void setHeaderDistance(float value)

Gets or sets height of header in points.

getFooterDistance

public float getFooterDistance()

Gets footer height in points.

setFooterDistance

public void setFooterDistance(float value)

Sets footer height in points.

getClientWidth

public float getClientWidth()

Gets width of client area.

getClientHeight

public float getClientHeight()

Gets width of client area.

getDifferentFirstPageHeaderFooter

public boolean getDifferentFirstPageHeaderFooter()

Setting to specify that the current section has a different header/footer for first page.

setDifferentFirstPageHeaderFooter

public void setDifferentFirstPageHeaderFooter(boolean value)

Setting to specify that the current section has a different header/footer for first page.

getDifferentOddAndEvenPagesHeaderFooter

public boolean getDifferentOddAndEvenPagesHeaderFooter()

True if the document has different headers and footers for odd-numbered and even-numbered pages.

setDifferentOddAndEvenPagesHeaderFooter

public void setDifferentOddAndEvenPagesHeaderFooter(boolean value)

True if the document has different headers and footers for odd-numbered and even-numbered pages.

getLineNumberingRestartMode

public LineNumberingRestartMode getLineNumberingRestartMode()

Returns line numbering mode

setLineNumberingRestartMode

public void setLineNumberingRestartMode(LineNumberingRestartMode value)

Sets line numbering mode

getLineNumberingStep

public int getLineNumberingStep()

Gets line numbering step

setLineNumberingStep

public void setLineNumberingStep(int value)

Sets line numbering step

getLineNumberingStartValue

public int getLineNumberingStartValue()

Gets line numbering start value

setLineNumberingStartValue

public void setLineNumberingStartValue(int value)

Sets line numbering start value

getLineNumberingDistanceFromText

public float getLineNumberingDistanceFromText()

Gets distance from text in lines numbering

setLineNumberingDistanceFromText

public void setLineNumberingDistanceFromText(float value)

Sets distance from text in lines numbering

getPageBordersApplyType

public PageBordersApplyType getPageBordersApplyType()

Gets the value that determine on which pages border is applied

setPageBordersApplyType

public void setPageBordersApplyType(PageBordersApplyType value)

Sets the value that determine on which pages border is applied

getPageBorderOffsetFrom

public PageBorderOffsetFrom getPageBorderOffsetFrom()

Gets the position of page border

setPageBorderOffsetFrom

public void setPageBorderOffsetFrom(PageBorderOffsetFrom value)

Sets the position of page border

isFrontPageBorder

public boolean isFrontPageBorder()

Gets a value indicating whether this instance is front page border.

isFrontPageBorder

public void isFrontPageBorder(boolean value)

Sets a value indicating whether this instance is front page border.

getPageBorderIncludeHeader

public boolean getPageBorderIncludeHeader()

Gets a value indicating whether the page border include the header. If the page border is not measured from the text extents using a value of text in the PageBorderOffsetFrome, then it can be ignored.

setPageBorderIncludeHeader

public void setPageBorderIncludeHeader(boolean value)

Sets a value indicating whether the page border include the header. If the page border is not measured from the text extents using a value of text in the PageBorderOffsetFrome, then it can be ignored.

getPageBorderIncludeFooter

public boolean getPageBorderIncludeFooter()

Gets a value indicating whether the page border include the footer. If the page border is not measured from the text extents using a value of text in the PageBorderOffsetFrome, then it can be ignored.

setPageBorderIncludeFooter

public void setPageBorderIncludeFooter(boolean value)

Sets a value indicating whether the page border include the footer. If the page border is not measured from the text extents using a value of text in the PageBorderOffsetFrome, then it can be ignored.

getBorders

public Borders getBorders()

Gets page borders collection

getBidi

public boolean getBidi()

Gets whether section contains right-to-left text.

setBidi

public void setBidi(boolean value)

Sets whether section contains right-to-left text.

getEqualColumnWidth

public boolean getEqualColumnWidth()

Gets a value indicating whether equal column width.

Returns:

true if equal column width; otherwise, false.

setEqualColumnWidth

public void setEqualColumnWidth(boolean value)

Sets a value indicating whether equal column width.

getPageNumberStyle

public PageNumberStyle getPageNumberStyle()

Gets the page number style.

Returns:

The page number style.

setPageNumberStyle

public void setPageNumberStyle(PageNumberStyle value)

Sets the page number style.

getPageStartingNumber

public int getPageStartingNumber()

Gets the page starting number.

Returns:

The page starting number.

setPageStartingNumber

public void setPageStartingNumber(int value)

Sets the page starting number.

getRestartPageNumbering

public boolean getRestartPageNumbering()

Gets a value indicating whether to restart page numbering. if restart page numbering, set to true.

Returns:

setRestartPageNumbering

public void setRestartPageNumbering(boolean value)

Sets a value indicating whether to restart page numbering. if restart page numbering, set to true.

getGridType

public GridPitchType getGridType()

Gets the grid type of this section.

setGridType

public void setGridType(GridPitchType value)

Sets the grid type of this section.

getLinesPerPage

public int getLinesPerPage()

Gets the number of lines per page in the document grid.

setLinesPerPage

public void setLinesPerPage(int value)

Sets the number of lines per page in the document grid.

getColumnsLineBetween

public boolean getColumnsLineBetween()

Gets the value specifies if a vertical line is draw between each of the text columns in the this section.

setColumnsLineBetween

public void setColumnsLineBetween(boolean value)

Sets the value specifies if a vertical line is draw between each of the text columns in the this section.

getCharacterSpacingControl

public CharacterSpacing getCharacterSpacingControl()

Character Spacing Control.

setCharacterSpacingControl

public void setCharacterSpacingControl(CharacterSpacing value)

Character Spacing Control.

insertPageNumbers

public void insertPageNumbers(boolean fromTopPage,
                              PageNumberAlignment horizontalAlignment)

Inserts the page numbers.

Parameters:

fromTopPage - if it specifies the top of page, set to true.

horizontalAlignment - The horizontal alignment.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object