PrintParams
PrintParams object controls the printing options for PDF documents. PrintParams objects are obtained through the Doc.getPrintParams method and are used with the Doc.print method.
properties
binaryOK
| Secure | Type | Access |
|---|---|---|
| No | boolean | R/W |
Not supported by Revu. Exists for compatibility reasons.
bitmapDPI
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
booklet
| Secure | Type | Access |
|---|---|---|
| No | object | R/W |
Not supported by Revu. Exists for compatibility reasons.
colorOverride
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Overrides color printing settings. See constants.colorOverrides for valid values.
example:
var pp = this.getPrintParams()
pp.colorOverride = pp.constants.colorOverrides.gray // Force grayscale printing
this.print(pp)
colorProfile
| Secure | Type | Access |
|---|---|---|
| No | string | R/W |
Not supported by Revu. Exists for compatibility reasons.
constants
| Secure | Type | Access |
|---|---|---|
| No | object | R |
Object containing constants used with PrintParams operations.
constants
| Property | Type | Description |
|---|---|---|
| bookletBindings | object | Booklet binding edge options |
| bookletDuplexMode | object | Booklet duplex printing modes |
| colorOverrides | object | Color override options |
| fontPolicies | object | Font download policies |
| handling | object | Page handling options |
| interactionLevel | object | User interaction levels |
| nUpPageOrders | object | Page ordering for N-up printing |
| printContents | object | Content to print |
| flagValues | object | Advanced printing flags |
| rasterFlagValues | object | Raster printing flags |
| subsets | object | Page subset options |
| tileMarks | object | Tile mark positions |
| usages | object | Usage options for various features |
bookletBindings
| Property | Value | Description |
|---|---|---|
| Left | 0 | Bind on left edge |
| Right | 1 | Bind on right edge |
| LeftTall | 2 | Bind on left edge (tall pages) |
| RightTall | 3 | Bind on right edge (tall pages) |
bookletDuplexMode
| Property | Value | Description |
|---|---|---|
| BothSides | 0 | Print on both sides |
| FrontSideOnly | 1 | Print on front side only |
| BackSideOnly | 2 | Print on back side only |
colorOverrides
| Property | Value | Description |
|---|---|---|
| auto | 0 | Use printer default |
| gray | 1 | Force grayscale |
| mono | 2 | Force monochrome |
fontPolicies
| Property | Value | Description |
|---|---|---|
| jobStart | 0 | Download fonts at start of job |
| pageRange | 1 | Download fonts for page range |
| everyPage | 2 | Download fonts for every page |
handling
| Property | Value | Description |
|---|---|---|
| none | 1 | No special handling |
| fit | 2 | Fit to page |
| shrink | 3 | Shrink oversized pages |
| tileLarge | 4 | Tile large pages |
| tileAll | 5 | Tile all pages |
| nUp | 6 | Multiple pages per sheet |
| booklet | 7 | Booklet printing |
interactionLevel
| Property | Value | Description |
|---|---|---|
| full | 1 | Show print dialog |
| automatic | 2 | Print with progress dialog |
| silent | 3 | Print silently |
nUpPageOrders
| Property | Value | Description |
|---|---|---|
| Horizontal | 1 | Left to right, top to bottom |
| HorizontalReversed | 2 | Right to left, top to bottom |
| Vertical | 3 | Top to bottom, left to right |
printContents
| Property | Value | Description |
|---|---|---|
| doc | 1 | Document only |
| docAndComments | 2 | Document and comments |
| formFieldsOnly | 3 | Form fields only |
subsets
| Property | Value | Description |
|---|---|---|
| all | -3 | All pages |
| even | -5 | Even pages only |
| odd | -4 | Odd pages only |
tileMarks
| Property | Value | Description |
|---|---|---|
| none | 0 | No tile marks |
| west | 1 | Western (left) style marks |
| east | 2 | Eastern (right) style marks |
example:
var pp = this.getPrintParams()
pp.interactive = pp.constants.interactionLevel.automatic
pp.pageHandling = pp.constants.handling.fit
pp.pageSubset = pp.constants.subsets.odd
this.print(pp)
downloadFarEastFonts
| Secure | Type | Access |
|---|---|---|
| No | boolean | R/W |
Not supported by Revu. Exists for compatibility reasons.
fileName
| Secure | Type | Access |
|---|---|---|
| No | string | R/W |
Output filename when printing to file. Default is empty string.
example:
var pp = this.getPrintParams()
pp.fileName = "output.ps" // Print to PostScript file
pp.printerName = "PostScript File"
this.print(pp)
firstPage
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
0-based index of the first page to print. Default is 0.
example:
var pp = this.getPrintParams()
pp.firstPage = 2 // Start printing from page 3
pp.lastPage = 5 // End at page 6
this.print(pp)
flags
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
fontPolicy
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
gradientDPI
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
interactive
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Level of user interaction during printing. See constants.interactionLevel for valid values. Default is full.
example:
var pp = this.getPrintParams()
pp.interactive = pp.constants.interactionLevel.silent // Print without dialogs
this.print(pp)
lastPage
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
0-based index of the last page to print. Default is the last page in the document.
example:
var pp = this.getPrintParams()
pp.firstPage = 0
pp.lastPage = 9 // Print first 10 pages
this.print(pp)
nUpAutoRotate
| Secure | Type | Access |
|---|---|---|
| No | boolean | R/W |
Not supported by Revu. Exists for compatibility reasons.
nUpNumPagesH
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
nUpNumPagesV
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
nUpPageBorder
| Secure | Type | Access |
|---|---|---|
| No | boolean | R/W |
Not supported by Revu. Exists for compatibility reasons.
nUpPageOrder
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
pageHandling
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Page sizing and handling option. See constants.handling for valid values. Default is fit.
example:
var pp = this.getPrintParams()
pp.pageHandling = pp.constants.handling.shrink // Shrink oversized pages
this.print(pp)
pageSubset
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Subset of pages to print. See constants.subsets for valid values. Default is all.
example:
var pp = this.getPrintParams()
pp.pageSubset = pp.constants.subsets.even // Print even pages only
this.print(pp)
printAsImage
| Secure | Type | Access |
|---|---|---|
| No | boolean | R/W |
Specifies whether to rasterize pages as images before printing. Default is false.
example:
var pp = this.getPrintParams()
pp.printAsImage = true // Print as image for compatibility
pp.bitmapDPI = 300
this.print(pp)
printContent
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
printerName
| Secure | Type | Access |
|---|---|---|
| No | string | R/W |
Name of the printer to use. Empty string uses the default printer. Default is "".
example:
var pp = this.getPrintParams()
pp.printerName = "HP LaserJet" // Specific printer
this.print(pp)
// Use default printer
pp.printerName = ""
this.print(pp)
psLevel
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
rasterFlags
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
reversePages
| Secure | Type | Access |
|---|---|---|
| No | boolean | R/W |
Specifies whether to print pages in reverse order. Default is false.
example:
var pp = this.getPrintParams()
pp.reversePages = true // Print last page first
this.print(pp)
tileLabel
| Secure | Type | Access |
|---|---|---|
| No | boolean | R/W |
Not supported by Revu. Exists for compatibility reasons.
tileMark
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
tileOverlap
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
tileScale
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
transparencyLevel
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
usePrinterCRD
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.
useT1Conversion
| Secure | Type | Access |
|---|---|---|
| No | number | R/W |
Not supported by Revu. Exists for compatibility reasons.