ASPOSE home

com.aspose.words
Class PageSetup

java.lang.Object
    extended by com.aspose.words.PageSetup

public class PageSetup
extends java.lang.Object

Represents the page setup properties of a section.

PageSetup object contains all the page setup attributes of a section (left margin, bottom margin, paper size, and so on) as properties.


Property Getters/Setters Summary
booleangetBidi()
voidsetBidi(boolean value)
           Specifies that this section contains bidirectional (complex scripts) text.
booleangetBorderAlwaysInFront()
voidsetBorderAlwaysInFront(boolean value)
           Specifies where the page border is positioned relative to intersecting texts and objects.
intgetBorderAppliesTo()
voidsetBorderAppliesTo(int value)
           Specifies which pages the page border is printed on. The value of the property is PageBorderAppliesTo integer constant.
intgetBorderDistanceFrom()
voidsetBorderDistanceFrom(int value)
           Gets or sets a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds. The value of the property is PageBorderDistanceFrom integer constant.
BordersgetBorders()
           Gets a collection of the page borders.
doublegetBottomMargin()
voidsetBottomMargin(double value)
           Returns or sets the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.
booleangetDifferentFirstPageHeaderFooter()
voidsetDifferentFirstPageHeaderFooter(boolean value)
          True if a different header or footer is used on the first page.
intgetFirstPageTray()
voidsetFirstPageTray(int value)
           Returns or sets the paper tray to use for the first page of a section. The value of the property is PaperTray integer constant.
doublegetFooterDistance()
voidsetFooterDistance(double value)
           Returns or sets the distance (in points) between the footer and the bottom of the page.
doublegetGutter()
voidsetGutter(double value)
           Gets or sets the amount of extra space added to the margin for document binding.
doublegetHeaderDistance()
voidsetHeaderDistance(double value)
           Returns or sets the distance (in points) between the header and the top of the page.
doublegetLeftMargin()
voidsetLeftMargin(double value)
           Returns or sets the distance (in points) between the left edge of the page and the left boundary of the body text.
intgetLineNumberCountBy()
voidsetLineNumberCountBy(int value)
           Returns or sets the numeric increment for line numbers.
doublegetLineNumberDistanceFromText()
voidsetLineNumberDistanceFromText(double value)
           Gets or sets distance between the right edge of line numbers and the left edge of the document.
intgetLineNumberRestartMode()
voidsetLineNumberRestartMode(int value)
           Gets or sets the way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously. The value of the property is LineNumberRestartMode integer constant.
intgetLineStartingNumber()
voidsetLineStartingNumber(int value)
           Gets or sets the starting line number.
booleangetOddAndEvenPagesHeaderFooter()
voidsetOddAndEvenPagesHeaderFooter(boolean value)
          True if the document has different headers and footers for odd-numbered and even-numbered pages.
intgetOrientation()
voidsetOrientation(int value)
           Returns or sets the orientation of the page. The value of the property is Orientation integer constant.
intgetOtherPagesTray()
voidsetOtherPagesTray(int value)
           Returns or sets the paper tray to be used for all but the first page of a section. The value of the property is PaperTray integer constant.
doublegetPageHeight()
voidsetPageHeight(double value)
           Returns or sets the height of the page in points.
intgetPageNumberStyle()
voidsetPageNumberStyle(int value)
           Gets or sets the page number format. The value of the property is NumberStyle integer constant.
intgetPageStartingNumber()
voidsetPageStartingNumber(int value)
           Gets or sets the starting page number of the section.
doublegetPageWidth()
voidsetPageWidth(double value)
           Returns or sets the width of the page in points.
intgetPaperSize()
voidsetPaperSize(int value)
           Returns or sets the paper size. The value of the property is PaperSize integer constant.
booleangetRestartPageNumbering()
voidsetRestartPageNumbering(boolean value)
          True if page numbering restarts at the beginning of the section.
doublegetRightMargin()
voidsetRightMargin(double value)
           Returns or sets the distance (in points) between the right edge of the page and the right boundary of the body text.
booleangetRtlGutter()
voidsetRtlGutter(boolean value)
           Gets or sets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.
intgetSectionStart()
voidsetSectionStart(int value)
           Returns or sets the type of section break for the specified object. The value of the property is SectionStart integer constant.
booleangetSuppressEndnotes()
voidsetSuppressEndnotes(boolean value)
          True if endnotes are printed at the end of the next section that doesn't suppress endnotes. Suppressed endnotes are printed before the endnotes in that section.
TextColumnsgetTextColumns()
           Returns a collection that represents the set of text columns.
doublegetTopMargin()
voidsetTopMargin(double value)
           Returns or sets the distance (in points) between the top edge of the page and the top boundary of the body text.
intgetVerticalAlignment()
voidsetVerticalAlignment(int value)
           Returns or sets the vertical alignment of text on each page in a document or section. The value of the property is PageVerticalAlignment integer constant.
 
Method Summary
voidclearFormatting()
           Resets page setup to default paper size, margins and orientation.
java.lang.ObjectfetchInheritedAttr(int key)
          Reserved for internal use.
java.lang.ObjectgetDirectAttr(int key)
          Reserved for internal use.
voidsetAttr(int key, java.lang.Object value)
          Reserved for internal use.
 

Property Getters/Setters Detail

getOddAndEvenPagesHeaderFooter/setOddAndEvenPagesHeaderFooter

public boolean getOddAndEvenPagesHeaderFooter()

public void setOddAndEvenPagesHeaderFooter(boolean value)
True if the document has different headers and footers for odd-numbered and even-numbered pages. Note, changing this property affects all sections in the document.

getDifferentFirstPageHeaderFooter/setDifferentFirstPageHeaderFooter

public boolean getDifferentFirstPageHeaderFooter()

public void setDifferentFirstPageHeaderFooter(boolean value)
True if a different header or footer is used on the first page.

getSectionStart/setSectionStart

public int getSectionStart()

public void setSectionStart(int value)
Returns or sets the type of section break for the specified object. The value of the property is SectionStart integer constant.

getSuppressEndnotes/setSuppressEndnotes

public boolean getSuppressEndnotes()

public void setSuppressEndnotes(boolean value)
True if endnotes are printed at the end of the next section that doesn't suppress endnotes. Suppressed endnotes are printed before the endnotes in that section.

getVerticalAlignment/setVerticalAlignment

public int getVerticalAlignment()

public void setVerticalAlignment(int value)
Returns or sets the vertical alignment of text on each page in a document or section. The value of the property is PageVerticalAlignment integer constant.

getBidi/setBidi

public boolean getBidi()

public void setBidi(boolean value)
Specifies that this section contains bidirectional (complex scripts) text.

When true, the columns in this section are laid out from right to left.


getPageWidth/setPageWidth

public double getPageWidth()

public void setPageWidth(double value)
Returns or sets the width of the page in points.

getPageHeight/setPageHeight

public double getPageHeight()

public void setPageHeight(double value)
Returns or sets the height of the page in points.

getPaperSize/setPaperSize

public int getPaperSize()

public void setPaperSize(int value)
Returns or sets the paper size. The value of the property is PaperSize integer constant.

getOrientation/setOrientation

public int getOrientation()

public void setOrientation(int value)
Returns or sets the orientation of the page. The value of the property is Orientation integer constant.

Changing Orientation swaps PageWidth and PageHeight.


getLeftMargin/setLeftMargin

public double getLeftMargin()

public void setLeftMargin(double value)
Returns or sets the distance (in points) between the left edge of the page and the left boundary of the body text.

getRightMargin/setRightMargin

public double getRightMargin()

public void setRightMargin(double value)
Returns or sets the distance (in points) between the right edge of the page and the right boundary of the body text.

getTopMargin/setTopMargin

public double getTopMargin()

public void setTopMargin(double value)
Returns or sets the distance (in points) between the top edge of the page and the top boundary of the body text.

getBottomMargin/setBottomMargin

public double getBottomMargin()

public void setBottomMargin(double value)
Returns or sets the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.

getHeaderDistance/setHeaderDistance

public double getHeaderDistance()

public void setHeaderDistance(double value)
Returns or sets the distance (in points) between the header and the top of the page.

getFooterDistance/setFooterDistance

public double getFooterDistance()

public void setFooterDistance(double value)
Returns or sets the distance (in points) between the footer and the bottom of the page.

getGutter/setGutter

public double getGutter()

public void setGutter(double value)
Gets or sets the amount of extra space added to the margin for document binding.

getFirstPageTray/setFirstPageTray

public int getFirstPageTray()

public void setFirstPageTray(int value)
Returns or sets the paper tray to use for the first page of a section. The value of the property is PaperTray integer constant.

getOtherPagesTray/setOtherPagesTray

public int getOtherPagesTray()

public void setOtherPagesTray(int value)
Returns or sets the paper tray to be used for all but the first page of a section. The value of the property is PaperTray integer constant.

getPageNumberStyle/setPageNumberStyle

public int getPageNumberStyle()

public void setPageNumberStyle(int value)
Gets or sets the page number format. The value of the property is NumberStyle integer constant.

getRestartPageNumbering/setRestartPageNumbering

public boolean getRestartPageNumbering()

public void setRestartPageNumbering(boolean value)
True if page numbering restarts at the beginning of the section. If set to false, the RestartPageNumbering property will override the PageStartingNumber property so that page numbering can continue from the previous section.

getPageStartingNumber/setPageStartingNumber

public int getPageStartingNumber()

public void setPageStartingNumber(int value)
Gets or sets the starting page number of the section. The RestartPageNumbering property, if set to false, will override the PageStartingNumber property so that page numbering can continue from the previous section.

getLineNumberRestartMode/setLineNumberRestartMode

public int getLineNumberRestartMode()

public void setLineNumberRestartMode(int value)
Gets or sets the way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously. The value of the property is LineNumberRestartMode integer constant.

getLineNumberCountBy/setLineNumberCountBy

public int getLineNumberCountBy()

public void setLineNumberCountBy(int value)
Returns or sets the numeric increment for line numbers.

getLineNumberDistanceFromText/setLineNumberDistanceFromText

public double getLineNumberDistanceFromText()

public void setLineNumberDistanceFromText(double value)
Gets or sets distance between the right edge of line numbers and the left edge of the document. Set this property to zero for automatic distance between the line numbers and text of the document.

getLineStartingNumber/setLineStartingNumber

public int getLineStartingNumber()

public void setLineStartingNumber(int value)
Gets or sets the starting line number.

getTextColumns

public TextColumns getTextColumns()
Returns a collection that represents the set of text columns.

getRtlGutter/setRtlGutter

public boolean getRtlGutter()

public void setRtlGutter(boolean value)
Gets or sets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.

getBorderAlwaysInFront/setBorderAlwaysInFront

public boolean getBorderAlwaysInFront()

public void setBorderAlwaysInFront(boolean value)
Specifies where the page border is positioned relative to intersecting texts and objects.

getBorderDistanceFrom/setBorderDistanceFrom

public int getBorderDistanceFrom()

public void setBorderDistanceFrom(int value)
Gets or sets a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds. The value of the property is PageBorderDistanceFrom integer constant.

getBorderAppliesTo/setBorderAppliesTo

public int getBorderAppliesTo()

public void setBorderAppliesTo(int value)
Specifies which pages the page border is printed on. The value of the property is PageBorderAppliesTo integer constant.

getBorders

public Borders getBorders()
Gets a collection of the page borders.

Method Detail

clearFormatting

public void clearFormatting()
Resets page setup to default paper size, margins and orientation.

setAttr

public void setAttr(int key, java.lang.Object value)
Reserved for internal use.

fetchInheritedAttr

public java.lang.Object fetchInheritedAttr(int key)
                         throws java.lang.Exception
Reserved for internal use.

getDirectAttr

public java.lang.Object getDirectAttr(int key)
Reserved for internal use.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home