Word.Interfaces.PageSetupUpdateData interface
An interface for updating data on the PageSetup object, for use in pageSetup.set({ ... }).
Properties
| book |
Specifies whether Microsoft Word prints the document as a booklet. |
| book |
Specifies the number of pages for each booklet. |
| book |
Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. |
| bottom |
Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. |
| chars |
Specifies the number of characters per line in the document grid. |
| different |
Specifies whether the first page has a different header and footer. |
| footer |
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. |
| gutter |
Specifies on which side the gutter appears in a document. |
| gutter |
Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. |
| header |
Specifies the distance between the header and the top of the page in points. |
| layout |
Specifies the layout mode for the current document. |
| left |
Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. |
| line |
Specifies a |
| lines |
Specifies the number of lines per page in the document grid. |
| mirror |
Specifies if the inside and outside margins of facing pages are the same width. |
| odd |
Specifies whether odd and even pages have different headers and footers. |
| orientation | Specifies the orientation of the page. |
| page |
Specifies the page height in points. |
| page |
Specifies the page width in points. |
| paper |
Specifies the paper size of the page. |
| right |
Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. |
| section |
Specifies the reading order and alignment for the specified sections. |
| section |
Specifies the type of section break for the specified object. |
| show |
Specifies whether to show the grid. |
| suppress |
Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. |
| top |
Specifies the top margin of the page in points. |
| two |
Specifies whether to print two pages per sheet. |
| vertical |
Specifies the vertical alignment of text on each page in a document or section. |
Property Details
bookFoldPrinting
Specifies whether Microsoft Word prints the document as a booklet.
bookFoldPrinting?: boolean;Property Value
boolean
Remarks
bookFoldPrintingSheets
Specifies the number of pages for each booklet.
bookFoldPrintingSheets?: number;Property Value
number
Remarks
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
bottomMargin
Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.
bottomMargin?: number;Property Value
number
Remarks
charsLine
Specifies the number of characters per line in the document grid.
charsLine?: number;Property Value
number
Remarks
differentFirstPageHeaderFooter
Specifies whether the first page has a different header and footer.
differentFirstPageHeaderFooter?: boolean;Property Value
boolean
Remarks
footerDistance
Specifies the distance between the footer and the bottom of the page in points.
footerDistance?: number;Property Value
number
Remarks
gutter
Specifies the amount (in points) of extra margin space added to each page in a document or section for binding.
gutter?: number;Property Value
number
Remarks
gutterPosition
Specifies on which side the gutter appears in a document.
gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top";Property Value
Word.GutterPosition | "Left" | "Right" | "Top"
Remarks
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?: Word.GutterStyle | "Bidirectional" | "Latin";Property Value
Word.GutterStyle | "Bidirectional" | "Latin"
Remarks
headerDistance
Specifies the distance between the header and the top of the page in points.
headerDistance?: number;Property Value
number
Remarks
layoutMode
Specifies the layout mode for the current document.
layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko";Property Value
Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"
Remarks
leftMargin
Specifies the distance (in points) between the left edge of the page and the left boundary of the body text.
leftMargin?: number;Property Value
number
Remarks
lineNumbering
Specifies a LineNumbering object that represents the line numbers for the PageSetup object.
lineNumbering?: Word.Interfaces.LineNumberingUpdateData;Property Value
Remarks
linesPage
Specifies the number of lines per page in the document grid.
linesPage?: number;Property Value
number
Remarks
mirrorMargins
Specifies if the inside and outside margins of facing pages are the same width.
mirrorMargins?: boolean;Property Value
boolean
Remarks
oddAndEvenPagesHeaderFooter
Specifies whether odd and even pages have different headers and footers.
oddAndEvenPagesHeaderFooter?: boolean;Property Value
boolean
Remarks
orientation
Specifies the orientation of the page.
orientation?: Word.PageOrientation | "Portrait" | "Landscape";Property Value
Word.PageOrientation | "Portrait" | "Landscape"
Remarks
pageHeight
Specifies the page height in points.
pageHeight?: number;Property Value
number
Remarks
pageWidth
Specifies the page width in points.
pageWidth?: number;Property Value
number
Remarks
paperSize
Specifies the paper size of the page.
paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom";Property Value
Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"
Remarks
rightMargin
Specifies the distance (in points) between the right edge of the page and the right boundary of the body text.
rightMargin?: number;Property Value
number
Remarks
sectionDirection
Specifies the reading order and alignment for the specified sections.
sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight";Property Value
Word.SectionDirection | "RightToLeft" | "LeftToRight"
Remarks
sectionStart
Specifies the type of section break for the specified object.
sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage";Property Value
Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"
Remarks
showGrid
Specifies whether to show the grid.
showGrid?: boolean;Property Value
boolean
Remarks
suppressEndnotes
Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes.
suppressEndnotes?: boolean;Property Value
boolean
Remarks
topMargin
Specifies the top margin of the page in points.
topMargin?: number;Property Value
number
Remarks
twoPagesOnOne
Specifies whether to print two pages per sheet.
twoPagesOnOne?: boolean;Property Value
boolean
Remarks
verticalAlignment
Specifies the vertical alignment of text on each page in a document or section.
verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom";Property Value
Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"