Edit

Share via


Word.Interfaces.PageSetupLoadOptions interface

Represents the page setup settings for a Word document or section.

Remarks

[ API set: WordApiDesktop 1.3 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

bookFoldPrinting

Specifies whether Microsoft Word prints the document as a booklet.

bookFoldPrintingSheets

Specifies the number of pages for each booklet.

bookFoldReversePrinting

Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents.

bottomMargin

Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.

charsLine

Specifies the number of characters per line in the document grid.

differentFirstPageHeaderFooter

Specifies whether the first page has a different header and footer.

footerDistance

Specifies the distance between the footer and the bottom of the page in points.

gutter

Specifies the amount (in points) of extra margin space added to each page in a document or section for binding.

gutterPosition

Specifies on which side the gutter appears in a document.

gutterStyle

Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language.

headerDistance

Specifies the distance between the header and the top of the page in points.

layoutMode

Specifies the layout mode for the current document.

leftMargin

Specifies the distance (in points) between the left edge of the page and the left boundary of the body text.

lineNumbering

Specifies a LineNumbering object that represents the line numbers for the PageSetup object.

linesPage

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

mirrorMargins

Specifies if the inside and outside margins of facing pages are the same width.

oddAndEvenPagesHeaderFooter

Specifies whether odd and even pages have different headers and footers.

orientation

Specifies the orientation of the page.

pageHeight

Specifies the page height in points.

pageWidth

Specifies the page width in points.

paperSize

Specifies the paper size of the page.

rightMargin

Specifies the distance (in points) between the right edge of the page and the right boundary of the body text.

sectionDirection

Specifies the reading order and alignment for the specified sections.

sectionStart

Specifies the type of section break for the specified object.

showGrid

Specifies whether to show the grid.

suppressEndnotes

Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes.

topMargin

Specifies the top margin of the page in points.

twoPagesOnOne

Specifies whether to print two pages per sheet.

verticalAlignment

Specifies the vertical alignment of text on each page in a document or section.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

bookFoldPrinting

Specifies whether Microsoft Word prints the document as a booklet.

bookFoldPrinting?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

bookFoldPrintingSheets

Specifies the number of pages for each booklet.

bookFoldPrintingSheets?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

bookFoldReversePrinting

Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents.

bookFoldReversePrinting?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

bottomMargin

Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.

bottomMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

charsLine

Specifies the number of characters per line in the document grid.

charsLine?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

differentFirstPageHeaderFooter

Specifies whether the first page has a different header and footer.

differentFirstPageHeaderFooter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

footerDistance

Specifies the distance between the footer and the bottom of the page in points.

footerDistance?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

gutter

Specifies the amount (in points) of extra margin space added to each page in a document or section for binding.

gutter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

gutterPosition

Specifies on which side the gutter appears in a document.

gutterPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

gutterStyle

Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language.

gutterStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

headerDistance

Specifies the distance between the header and the top of the page in points.

headerDistance?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

layoutMode

Specifies the layout mode for the current document.

layoutMode?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

leftMargin

Specifies the distance (in points) between the left edge of the page and the left boundary of the body text.

leftMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

lineNumbering

Specifies a LineNumbering object that represents the line numbers for the PageSetup object.

lineNumbering?: Word.Interfaces.LineNumberingLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

linesPage

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

linesPage?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

mirrorMargins

Specifies if the inside and outside margins of facing pages are the same width.

mirrorMargins?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

oddAndEvenPagesHeaderFooter

Specifies whether odd and even pages have different headers and footers.

oddAndEvenPagesHeaderFooter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

orientation

Specifies the orientation of the page.

orientation?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

pageHeight

Specifies the page height in points.

pageHeight?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

pageWidth

Specifies the page width in points.

pageWidth?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

paperSize

Specifies the paper size of the page.

paperSize?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

rightMargin

Specifies the distance (in points) between the right edge of the page and the right boundary of the body text.

rightMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

sectionDirection

Specifies the reading order and alignment for the specified sections.

sectionDirection?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

sectionStart

Specifies the type of section break for the specified object.

sectionStart?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

showGrid

Specifies whether to show the grid.

showGrid?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

suppressEndnotes

Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes.

suppressEndnotes?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

topMargin

Specifies the top margin of the page in points.

topMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

twoPagesOnOne

Specifies whether to print two pages per sheet.

twoPagesOnOne?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

verticalAlignment

Specifies the vertical alignment of text on each page in a document or section.

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]