Word.PageSetup class

Specifies whether Microsoft Word prints the document as a booklet.

bookFoldPrinting: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the number of pages for each booklet.

bookFoldPrintingSheets: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

bookFoldReversePrinting: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

bottomMargin: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

charsLine: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

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

differentFirstPageHeaderFooter: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

footerDistance: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

gutter: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies on which side the gutter appears in a document.

gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

headerDistance: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the layout mode for the current document.

layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

leftMargin: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

lineNumbering: Word.LineNumbering;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

linesPage: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

mirrorMargins: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

oddAndEvenPagesHeaderFooter: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the orientation of the page.

orientation: Word.PageOrientation | "Portrait" | "Landscape";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the page height in points.

pageHeight: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the page width in points.

pageWidth: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

rightMargin: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the reading order and alignment for the specified sections.

sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the type of section break for the specified object.

sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies whether to show the grid.

showGrid: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

suppressEndnotes: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets a TextColumnCollection object that represents the set of text columns for the PageSetup object.

readonly textColumns: Word.TextColumnCollection;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the top margin of the page in points.

topMargin: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies whether to print two pages per sheet.

twoPagesOnOne: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.PageSetup;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.PageSetup;

Parameters

Returns

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.PageSetup): void;

Parameters

Returns

Sets the specified page setup formatting as the default for the active document and all new documents based on the active template.

setAsTemplateDefault(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Switches between portrait and landscape page orientations for a document or section.

togglePortrait(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.PageSetup object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.PageSetupData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.PageSetupData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.PageSetup;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.PageSetup;

Returns