com.spire.doc
Class PageSetup

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

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() gets Character Spacing Control.
float	getClientHeight() Gets width of client area.
float	getClientWidth() Gets width of client area.
float	getDefaultTabWidth() Gets the length of the auto tab.
boolean	getDifferentFirstPageHeaderFooter()
boolean	getDifferentOddAndEvenPagesHeaderFooter() Setting to specify that the current section has a different header/footer for first page.
boolean	getEqualColumnWidth() Gets a value indicating whether equal column width.
float	getFooterDistance() Gets footer height in points.
float	getGutter() Gets or sets 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() return line numbering mode
int	getLineNumberingStartValue() Gets line numbering start value
int	getLineNumberingStep() Gets line numbering step
MarginsF	getMargins() Gets page margins in points.
PageOrientation	getOrientation() Gets 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 vertical alignment.
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.
void	setBidi(boolean value) Sets whether section contains right-to-left text.
void	setCharacterSpacingControl(CharacterSpacing value) Sets 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	setGutter(float value) Sets extra space added to the margin for document binding in points.
void	setHeaderDistance(float value) 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	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

getGutter

public float getGutter()

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

Returns:

The gutter size.

setGutter

public void setGutter(float value)

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

Parameters:

value - The gutter size.

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()

Gets orientation of a page.

Returns:

PageOrientation

setOrientation

public void setOrientation(PageOrientation value)

sets orientation of a page.

Parameters:

value - PageOrientation

getVerticalAlignment

public PageAlignment getVerticalAlignment()

Gets vertical alignment.

Returns:

PageAlignment

setVerticalAlignment

public void setVerticalAlignment(PageAlignment value)

Sets vertical alignment.

Parameters:

value - PageAlignment

getMargins

public MarginsF getMargins()

Gets page margins in points.

Returns:

MarginsF

setMargins

public void setMargins(MarginsF value)

Sets page margins in points.

Parameters:

value - MarginsF

getHeaderDistance

public float getHeaderDistance()

Gets height of header in points.

Returns:

float

setHeaderDistance

public void setHeaderDistance(float value)

Sets height of header in points.

Parameters:

value - float

getFooterDistance

public float getFooterDistance()

Gets footer height in points.

Returns:

float

setFooterDistance

public void setFooterDistance(float value)

Sets footer height in points.

Parameters:

value - float

getClientWidth

public float getClientWidth()

Gets width of client area.

Returns:

float

getClientHeight

public float getClientHeight()

Gets width of client area.

Returns:

float

getDifferentFirstPageHeaderFooter

public boolean getDifferentFirstPageHeaderFooter()

setDifferentFirstPageHeaderFooter

public void setDifferentFirstPageHeaderFooter(boolean value)

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

Parameters:

value - a boolean value

getDifferentOddAndEvenPagesHeaderFooter

public boolean getDifferentOddAndEvenPagesHeaderFooter()

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

Returns:

the boolean value

setDifferentOddAndEvenPagesHeaderFooter

public void setDifferentOddAndEvenPagesHeaderFooter(boolean value)

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

Parameters:

value - boolean

getLineNumberingRestartMode

public LineNumberingRestartMode getLineNumberingRestartMode()

return line numbering mode

Returns:

line numbering mode

setLineNumberingRestartMode

public void setLineNumberingRestartMode(LineNumberingRestartMode value)

sets line numbering mode

Parameters:

value - a line numbering mode

getLineNumberingStep

public int getLineNumberingStep()

Gets line numbering step

Returns:

line numbering step

setLineNumberingStep

public void setLineNumberingStep(int value)

Sets line numbering step

Parameters:

value - line numbering step

getLineNumberingStartValue

public int getLineNumberingStartValue()

Gets line numbering start value

Returns:

line numbering start value

setLineNumberingStartValue

public void setLineNumberingStartValue(int value)

sets line numbering start value

Parameters:

value - line numbering start value

getLineNumberingDistanceFromText

public float getLineNumberingDistanceFromText()

Gets distance from text in lines numbering

Returns:

distance from text in lines numbering

setLineNumberingDistanceFromText

public void setLineNumberingDistanceFromText(float value)

Sets distance from text in lines numbering

Parameters:

value - distance from text in lines numbering

getPageBordersApplyType

public PageBordersApplyType getPageBordersApplyType()

Gets the value that determine on which pages border is applied

Returns:

the PageBordersApplyType

setPageBordersApplyType

public void setPageBordersApplyType(PageBordersApplyType value)

Sets the value that determine on which pages border is applied

Parameters:

value - the PageBordersApplyType

getPageBorderOffsetFrom

public PageBorderOffsetFrom getPageBorderOffsetFrom()

Gets the position of page border

Returns:

PageBorderOffsetFrom

setPageBorderOffsetFrom

public void setPageBorderOffsetFrom(PageBorderOffsetFrom value)

Sets the position of page border

Parameters:

value - PageBorderOffsetFrom

isFrontPageBorder

public boolean isFrontPageBorder()

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

Returns:

the boolean value

isFrontPageBorder

public void isFrontPageBorder(boolean value)

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

Parameters:

value - a boolean value

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.

Returns:

the boolean value

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.

Parameters:

value - a boolean value

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.

Returns:

the boolean value

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.

Parameters:

value - a boolean value

getBorders

public Borders getBorders()

Gets page borders collection

Returns:

Borders

getBidi

public boolean getBidi()

Gets whether section contains right-to-left text.

Returns:

boolean

setBidi

public void setBidi(boolean value)

Sets whether section contains right-to-left text.

Parameters:

value - boolean

getEqualColumnWidth

public boolean getEqualColumnWidth()

Gets a value indicating whether equal column width.

Returns:

boolean

setEqualColumnWidth

public void setEqualColumnWidth(boolean value)

Sets a value indicating whether equal column width.

Parameters:

value - true if equal column width; otherwise, false

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.

Parameters:

value - 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.

Parameters:

value - The page starting number.

getRestartPageNumbering

public boolean getRestartPageNumbering()

Gets a value indicating whether to restart page numbering.

Returns:

if restart page numbering, set to true

setRestartPageNumbering

public void setRestartPageNumbering(boolean value)

Sets a value indicating whether to restart page numbering.

Parameters:

value - if restart page numbering, set to true

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.

Parameters:

value - boolean

getCharacterSpacingControl

public CharacterSpacing getCharacterSpacingControl()

gets Character Spacing Control.

Returns:

CharacterSpacing

setCharacterSpacingControl

public void setCharacterSpacingControl(CharacterSpacing value)

Sets Character Spacing Control.

Parameters:

value - CharacterSpacing

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