PageSetup Class
Represents the page setup properties of a section.
Inheritance Hierarchy
SystemObject
  Aspose.WordsPageSetup

Namespace: Aspose.Words
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 19.9
Syntax
public class PageSetup

The PageSetup type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleBidi
Specifies that this section contains bidirectional (complex scripts) text.
Public propertyCode exampleBorderAlwaysInFront
Specifies where the page border is positioned relative to intersecting texts and objects.
Public propertyCode exampleBorderAppliesTo
Specifies which pages the page border is printed on.
Public propertyCode exampleBorderDistanceFrom
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.
Public propertyCode exampleBorders
Gets a collection of the page borders.
Public propertyCode exampleBorderSurroundsFooter
Specifies whether the page border includes or excludes the footer.
Public propertyCode exampleBorderSurroundsHeader
Specifies whether the page border includes or excludes the header.
Public propertyCode exampleBottomMargin
Returns or sets the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.
Public propertyCode exampleCharactersPerLine
Gets or sets the number of characters per line in the document grid.
Public propertyCode exampleDifferentFirstPageHeaderFooter
True if a different header or footer is used on the first page.
Public propertyCode exampleEndnoteOptions
Provides options that control numbering and positioning of endnotes in this section.
Public propertyCode exampleFirstPageTray
Gets or sets the paper tray (bin) to use for the first page of a section. The value is implementation (printer) specific.
Public propertyCode exampleFooterDistance
Returns or sets the distance (in points) between the footer and the bottom of the page.
Public propertyCode exampleFootnoteOptions
Provides options that control numbering and positioning of footnotes in this section.
Public propertyCode exampleGutter
Gets or sets the amount of extra space added to the margin for document binding.
Public propertyCode exampleHeaderDistance
Returns or sets the distance (in points) between the header and the top of the page.
Public propertyCode exampleLayoutMode
Gets or sets the layout mode of this section.
Public propertyCode exampleLeftMargin
Returns or sets the distance (in points) between the left edge of the page and the left boundary of the body text.
Public propertyCode exampleLineNumberCountBy
Returns or sets the numeric increment for line numbers.
Public propertyCode exampleLineNumberDistanceFromText
Gets or sets distance between the right edge of line numbers and the left edge of the document.
Public propertyCode exampleLineNumberRestartMode
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.
Public propertyCode exampleLinesPerPage
Gets or sets the number of lines per page in the document grid.
Public propertyCode exampleLineStartingNumber
Gets or sets the starting line number.
Public propertyCode exampleMultiplePages
For multiple page documents, gets or sets how a document is printed or rendered so that it can be bound as a booklet.
Public propertyCode exampleOddAndEvenPagesHeaderFooter
True if the document has different headers and footers for odd-numbered and even-numbered pages.
Public propertyCode exampleOrientation
Returns or sets the orientation of the page.
Public propertyCode exampleOtherPagesTray
Gets or sets the paper tray (bin) to be used for all but the first page of a section. The value is implementation (printer) specific.
Public propertyCode examplePageHeight
Returns or sets the height of the page in points.
Public propertyCode examplePageNumberStyle
Gets or sets the page number format.
Public propertyCode examplePageStartingNumber
Gets or sets the starting page number of the section.
Public propertyCode examplePageWidth
Returns or sets the width of the page in points.
Public propertyCode examplePaperSize
Returns or sets the paper size.
Public propertyCode exampleRestartPageNumbering
True if page numbering restarts at the beginning of the section.
Public propertyCode exampleRightMargin
Returns or sets the distance (in points) between the right edge of the page and the right boundary of the body text.
Public propertyCode exampleRtlGutter
Gets or sets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.
Public propertyCode exampleSectionStart
Returns or sets the type of section break for the specified object.
Public propertyCode exampleSheetsPerBooklet
Returns or sets the number of pages to be included in each booklet.
Public propertyCode exampleSuppressEndnotes
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.
Public propertyCode exampleTextColumns
Returns a collection that represents the set of text columns.
Public propertyCode exampleTextOrientation
Allows to specify TextOrientation for the whole page. Default value is Horizontal
Public propertyCode exampleTopMargin
Returns or sets the distance (in points) between the top edge of the page and the top boundary of the body text.
Public propertyCode exampleVerticalAlignment
Returns or sets the vertical alignment of text on each page in a document or section.
Methods
  NameDescription
Public methodCode exampleClearFormatting
Resets page setup to default paper size, margins and orientation.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Remarks

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

Examples
Shows how to insert sections using DocumentBuilder, specify page setup for a section and reset page setup to defaults.
[C#]

DocumentBuilder builder = new DocumentBuilder();

// Modify the first section in the document.
builder.PageSetup.Orientation = Orientation.Landscape;
builder.PageSetup.VerticalAlignment = PageVerticalAlignment.Center;
builder.Writeln("Section 1, landscape oriented and text vertically centered.");

// Start a new section and reset its formatting to defaults.
builder.InsertBreak(BreakType.SectionBreakNewPage);
builder.PageSetup.ClearFormatting();
builder.Writeln("Section 2, back to default Letter paper size, portrait orientation and top alignment.");

builder.Document.Save(ArtifactsDir + "PageSetup.ClearFormatting.doc");
See Also