K4 InDesign Javascript API Documentation

PreferencesPrintPreference

Print preferences.

Extends

Instance Properties

Name Description Access
activePrinterPreset The current printer preset type. Can return: PrinterPresetTypes enumerator or PrinterPreset. read-write
allPrinterMarks bool If true, prints all printer marks. If false, prints specified printer marks. read-write
bitmapPrinting bool If true, uses bitmap printing. read-write
bitmapResolution number The resolution for bitmap printing. (Range: 72 to 1200) Note: Valid when bitmap printing is true. read-write
blackAngle number The angle override for black ink. (Range: 0 to 360) read-write
blackFrequency number The frequency override for black ink. (Range: 1 to 500) read-write
bleedBottom Measurement Unit (Number or String)=any The height of the bleed area at the bottom of the page. Note: Valid only when use document bleed to print is true. read-write
bleedChain bool If true, forces all bleed area settings to be the same, using the most recent bleed measurement setting. If false, allows bleed top, bleed bottom, bleed inside, and bleed outside to have different measurements. read-write
bleedInside Measurement Unit (Number or String)=any The width of the bleed area at the inside of the page. Note: Valid only when use document bleed to print is true. read-write
bleedMarks bool If true, print bleed marks. read-write
bleedOutside Measurement Unit (Number or String)=any The width of the bleed area at the outside of the page. Note: Valid only when use document bleed to print is true. read-write
bleedTop Measurement Unit (Number or String)=any The height of the bleed area at the top of the page. Note: Valid only when use document bleed to print is true. read-write
collating bool If true, collate printed copies. read-write
colorBars bool If true, add small squares of color representing the CMYK inks and tints of gray in 10% increments. read-write
colorOutput ColorOutputModes The color output mode for composites. Note: Not valid when a device-independent PPD is specified. read-write
compositeAngle number The screen angle to use when printing composites. (Range: 0 to 360) Note: Valid only for PostScript or PDF files that use custom screening. read-write
compositeFrequency number The screen frequency to use when printing composites. (Range: 1 to 500) Note: Valid only for PostScript or PDF files that use custom screening. read-write
copies number The number of copies to print. Note: Not valid when printer is PostScript File. read-write
crd The color-rendering dictionary (CRD), specified as a CRD name or an enumeration value. Note: Valid only when use color management is true. Can return: ColorRenderingDictionary enumerator or String. read-write
cropMarks bool Prints crop marks that define where the page should be trimmed. read-write
cyanAngle number The angle override for cyan ink. (Range: 0 to 360) read-write
cyanFrequency number The frequency override for cyan ink. (Range: 1 to 500) read-write
dataFormat DataFormat The format in which to send image data to the printer. read-write
downloadPPDFonts bool If true, downloads all fonts listed in the selected PPD. Valid only when font downloading is complete or subset. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
flattenerPresetName string The name of the transparency flattener preset. read-write
flip Flip The direction in which to flip the printed image. read-write
fontDownloading FontDownloading Controls how fonts are downloaded to the printer. read-write
ignoreSpreadOverrides bool If true, ignores flattener spread overrides. read-write
includeSlugToPrint bool If true, includes the slug area in the printed document. read-write
intent RenderingIntent The rendering intent. Note: Valid only when use color management is true. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
magentaAngle number The angle override for magenta ink. (Range: 0 to 360) read-write
magentaFrequency number The frequency override for magenta ink. (Range: 1 to 500) read-write
markLineWeight MarkLineWeight The stroke weight (in points) for printer marks. read-write
markOffset Measurement Unit (Number or String)=any The distance to offset the page marks from the edge of the page. read-write
markType The type of printer marks, either an enum value or the name of a custom marks file. Can return: MarkTypes enumerator or String. read-write
negative bool If true, prints the document as a negative. read-write
omitBitmaps bool If true, replaces bitmap images with OPI links. read-write
omitEPS bool If true, replaces EPS images with OPI links. read-write
omitPDF bool If true, replaces PDF images with OPI links. read-write
opiImageReplacement bool If true, prints graphics that are either OPI comments stored in imported EPS files or linked using OPI comments. For information on linking files using OPI comments, see omit EPS, omit PDF, or omit bitmaps. read-write
pageInformationMarks bool If true, prints the filename, page number, current date and time, and color separation name. read-write
pagePosition PagePositions The position of the page on the printing medium. Note: Valid only when tile is false. read-write
pageRange The pages to print, specified either as an enumeration or a string. To specify a range, separate page numbers in the string with a hyphen (-). To specify separate pages, separate page numbers in the string with a comma (,). Can return: PageRange enumerator or String. read-write
paperGap Measurement Unit (Number or String)=any The space between document pages on the printing medium. read-write
paperHeight The paper height. Note: Valid only when paper size is custom or scale mode is scale width height. Can return: PaperSize enumerator or Unit. read-write
paperOffset Measurement Unit (Number or String)=any The amount of space to offset the page from the left edge of the imageable area. read-write
paperSize The paper size, specified as either a string or an enumeration. For information on paper size names, see paper size list. Can return: PaperSizes enumerator or String. read-write
paperSizeList string A list of the available paper sizes. read-only
paperTransverse bool If true, uses transverse orientation. read-write
paperWidth The paper width. Note: Valid only when paper size is custom or scale mode is scale width height. Can return: PaperSize enumerator or Unit. read-write
parent The parent of the PrintPreference (a Book or Document). read-only
pdfPassthrough bool If true, doing pdf passthrough. read-only
postscriptLevel PostScriptLevels The PostScript level of the printer. read-write
ppd The PPD, specified as a PPD name or an enumeration. Can return: PPDValues enumerator or String. read-write
ppdList string Available PPDs. read-only
preserveColorNumbers bool If true, preserves uncalibrated color numbers. read-write
printBlack bool If true, prints the black ink. Note: Valid only when trapping is off. read-write
printBlankPages bool If true, prints blank pages. Note: Valid only when trapping is off. read-write
printCyan bool If true, prints the cyan ink. Note: Valid only when trapping is off. read-write
printFile File The PostScript file to print to. Note: Valid only when the current printer is defined as postscript file. read-write
printGuidesGrids bool If true, prints visible guides and baseline grids. Note: Valid only when trapping is off. read-write
printLayers PrintLayerOptions The layers to print. read-write
printMagenta bool If true, prints the magenta ink. Note: Valid only when trapping is off. read-write
printMasterPages bool If true, prints master pages. read-write
printNonprinting bool If true, prints non-printing objects. Note: Valid only when trapping is off. read-write
printPageOrientation PrintPageOrientation The orientation of the printed page. read-write
printSpreads bool If true, prints each spread with all spread pages on a single sheet. If false, prints spread pages as separate pages. read-write
printYellow bool If true, prints the yellow ink. Note: Valid only when trapping is off. read-write
printer The current printer. Can return: Printer enumerator or String. read-write
printerList string Available printers. read-only
profile The color profile. Can return: Profile enumerator or String. read-write
properties Object A property that allows setting of several properties at the same time. read-write
registrationMarks bool If true, prints small targets outside the page area for aligning color separations. read-write
reverseOrder bool If true, prints pages in reverse order. read-write
scaleHeight number The amount (as a percentage) that the page height is scaled during printing. (Range: 0 to 1000) Note: Valid only when scale mode is scale width height. read-write
scaleMode ScaleModes The policy for scaling the page. Note: Valid only when printing from Layout view. read-write
scaleProportional bool If true, constrains the proportions of the scaling; uses the most recent value for either scale width or scale height to define both values. Note: Valid only when scale mode is scale width height. read-write
scaleWidth number The amount (as a percentage) that the page width is scaled during printing. (Range: 0 to 1000) Note: Valid only when scale mode is scale width height. read-write
screening The ink screening settings for composite gray output in PostScript or PDF format. . Can return: Screeening enumerator or String. read-write
screeningList string Lists the ink screenings available in the PPD. Note: Valid only when color output is separations or in rip separations. read-only
sendImageData ImageDataTypes The image data sent to the printer or file. read-write
sequence Sequences The sequence of pages to print. read-write
simulateOverprint bool If true, simulates the effects of overprinting spot inks with different neutral density values by converting spot colors to process colors for printing. Note: Not valid when the color output mode is defined to leave color profiles unchanged. read-write
sourceSpace SourceSpaces The source of the color management system. Note: Valid only when use color management is true. read-write
textAsBlack bool If true, prints all text as black unless text has the color None or Paper or a color value that equals white. If false, prints colored text, such as blue hyperlinks, in halftone patterns. Note: Valid only when trapping is off. read-write
thumbnails bool If true, prints thumbnails. Note: Valid only when trapping is off and tile is false. read-write
thumbnailsPerPage ThumbsPerPage The number of thumbnails per page. read-write
tile bool If true, tiles pages. read-write
tilingOverlap number The amount of tiling overlap. Note: Valid only when tiling is true and tiling type is not manual. read-write
tilingType TilingTypes The tiling type. Note: Valid only when tiling is true. read-write
trapping Trapping The type of trapping. read-write
useDocumentBleedToPrint bool If true, uses the bleed area set for the document. read-write
yellowAngle number The angle override for yellow ink. (Range: 0 to 360) read-write
yellowFrequency number The frequency override for yellow ink. (Range: 1 to 500) read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → PrintPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → PrintPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the PrintPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.