Edit

Share via

Word.DocumentPrintOutOptions interface

Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Provides configuration options for the Document.printOut method.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

activePrinterMacGX

If provided, specifies the printer name. The default value is an empty string. This argument is available only in Microsoft Office Macintosh Edition.
append

If provided, specifies whether to append to an existing file. The default value is false.
background

If provided, specifies whether to print in the background. The default value is true.
collate

If provided, specifies whether to collate pages. The default value is true.
copies

If provided, specifies the number of copies to print. The default value is 1.
from

If provided, specifies the starting page number. The default value is 1.
item

If provided, specifies the item to print. The default value is PrintOutItem.documentContent.
manualDuplexPrint

If provided, specifies whether to manually duplex print. The default value is false.
outputFileName

If provided, specifies the name of the output file. The default value is an empty string.
pages

If provided, specifies specific pages to print. The default value is an empty string.
pageType

If provided, specifies the page order. The default value is PrintOutPages.allPages.
printToFile

If provided, specifies whether to print to file. The default value is false.
printZoomColumn

If provided, specifies the zoom column setting. The default value is 1.
printZoomPaperHeight

If provided, specifies the paper height for printing in twips (20 twips = 1 point; 72 points = 1 inch). The default value is 0 (use original height).
printZoomPaperWidth

If provided, specifies the paper width for printing in twips (20 twips = 1 point; 72 points = 1 inch). The default value is 0 (use original width).
printZoomRow

If provided, specifies the zoom row setting. The default value is 1.
range

If provided, specifies the range to print. The default value is allDocument.
to

If provided, specifies the ending page number. The default value is the last page of the document.

Property Details

activePrinterMacGX

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the printer name. The default value is an empty string. This argument is available only in Microsoft Office Macintosh Edition.

activePrinterMacGX?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

append

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to append to an existing file. The default value is false.

append?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

background

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to print in the background. The default value is true.

background?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

collate

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to collate pages. The default value is true.

collate?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

copies

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the number of copies to print. The default value is 1.

copies?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

from

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the starting page number. The default value is 1.

from?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

item

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the item to print. The default value is PrintOutItem.documentContent.

item?: Word.PrintOutItem | "DocumentContent" | "Properties" | "Comments" | "Markup" | "Styles" | "AutoTextEntries" | "KeyAssignments" | "Envelope" | "DocumentWithMarkup";

Property Value

Word.PrintOutItem | "DocumentContent" | "Properties" | "Comments" | "Markup" | "Styles" | "AutoTextEntries" | "KeyAssignments" | "Envelope" | "DocumentWithMarkup"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

manualDuplexPrint

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to manually duplex print. The default value is false.

manualDuplexPrint?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

outputFileName

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the name of the output file. The default value is an empty string.

outputFileName?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

pages

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies specific pages to print. The default value is an empty string.

pages?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

pageType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the page order. The default value is PrintOutPages.allPages.

pageType?: Word.PrintOutPages | "All" | "OddOnly" | "EvenOnly";

Property Value

Word.PrintOutPages | "All" | "OddOnly" | "EvenOnly"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

printToFile

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to print to file. The default value is false.

printToFile?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

printZoomColumn

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the zoom column setting. The default value is 1.

printZoomColumn?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

printZoomPaperHeight

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the paper height for printing in twips (20 twips = 1 point; 72 points = 1 inch). The default value is 0 (use original height).

printZoomPaperHeight?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

printZoomPaperWidth

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the paper width for printing in twips (20 twips = 1 point; 72 points = 1 inch). The default value is 0 (use original width).

printZoomPaperWidth?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

printZoomRow

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the zoom row setting. The default value is 1.

printZoomRow?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

range

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the range to print. The default value is allDocument.

range?: Word.PrintOutRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo" | "RangeOfPages";

Property Value

Word.PrintOutRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo" | "RangeOfPages"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

to

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the ending page number. The default value is the last page of the document.

to?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]