Adobe InDesign CS5 Server (7.0) Object Model JS: PrintPreference

InDesign Server CS5

Class

PrintPreference

 Print preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Book | Document
Preference
PrintPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
activePrinterPresetPrinterPresetPrinterPresetTypes r/wThe current printer preset type. Can return: PrinterPresetTypes enumerator or PrinterPreset.
allPrinterMarksbool r/wIf true, prints all printer marks. If false, prints specified printer marks.
bitmapPrintingbool r/wIf true, uses bitmap printing.
bitmapResolutionnumber (range: 72 - 1200) r/wThe resolution for bitmap printing. (Range: 72 to 1200) Note: Valid when bitmap printing is true.
blackAnglenumber r/wThe angle override for black ink. (Range: 0 to 360)
blackFrequencynumber r/wThe frequency override for black ink. (Range: 1 to 500)
bleedBottomMeasurement Unit (Number or String) (range: 0 - 432) r/wThe height of the bleed area at the bottom of the page. Note: Valid only when use document bleed to print is true.
bleedChainbool r/wIf 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.
bleedInsideMeasurement Unit (Number or String) (range: 0 - 432) r/wThe width of the bleed area at the inside of the page. Note: Valid only when use document bleed to print is true.
bleedMarksbool r/wIf true, print bleed marks.
bleedOutsideMeasurement Unit (Number or String) (range: 0 - 432) r/wThe width of the bleed area at the outside of the page. Note: Valid only when use document bleed to print is true.
bleedTopMeasurement Unit (Number or String) (range: 0 - 432) r/wThe height of the bleed area at the top of the page. Note: Valid only when use document bleed to print is true.
collatingbool r/wIf true, collate printed copies.
colorBarsbool r/wIf true, add small squares of color representing the CMYK inks and tints of gray in 10% increments.
colorOutputColorOutputModes:
ColorOutputModes.COMPOSITE_LEAVE_UNCHANGED
ColorOutputModes.COMPOSITE_GRAY
ColorOutputModes.COMPOSITE_RGB
ColorOutputModes.COMPOSITE_CMYK
ColorOutputModes.SEPARATIONS
ColorOutputModes.INRIP_SEPARATIONS
r/wThe color output mode for composites. Note: Not valid when a device-independent PPD is specified.
compositeAnglenumber r/wThe screen angle to use when printing composites. (Range: 0 to 360) Note: Valid only for PostScript or PDF files that use custom screening.
compositeFrequencynumber r/wThe screen frequency to use when printing composites. (Range: 1 to 500) Note: Valid only for PostScript or PDF files that use custom screening.
copiesnumber r/wThe number of copies to print. Note: Not valid when printer is PostScript File.
crdColorRenderingDictionary
String
r/wThe 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.
cropMarksbool r/wPrints crop marks that define where the page should be trimmed.
cyanAnglenumber r/wThe angle override for cyan ink. (Range: 0 to 360)
cyanFrequencynumber r/wThe frequency override for cyan ink. (Range: 1 to 500)
dataFormatDataFormat:
DataFormat.ASCII
DataFormat.BINARY
r/wThe format in which to send image data to the printer.
downloadPPDFontsbool r/wIf true, downloads all fonts listed in the selected PPD. Valid only when font downloading is complete or subset.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
flattenerPresetNamestring r/wThe name of the transparency flattener preset.
flipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wThe direction in which to flip the printed image.
fontDownloadingFontDownloading:
FontDownloading.NONE
FontDownloading.COMPLETE
FontDownloading.SUBSET
FontDownloading.SUBSET_LARGE
r/wControls how fonts are downloaded to the printer.
ignoreSpreadOverridesbool r/wIf true, ignores flattener spread overrides.
includeSlugToPrintbool r/wIf true, includes the slug area in the printed document.
intentRenderingIntent:
RenderingIntent.USE_COLOR_SETTINGS
RenderingIntent.PERCEPTUAL
RenderingIntent.SATURATION
RenderingIntent.RELATIVE_COLORIMETRIC
RenderingIntent.ABSOLUTE_COLORIMETRIC
r/wThe rendering intent. Note: Valid only when use color management is true.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
magentaAnglenumber r/wThe angle override for magenta ink. (Range: 0 to 360)
magentaFrequencynumber r/wThe frequency override for magenta ink. (Range: 1 to 500)
markLineWeightMarkLineWeight:
MarkLineWeight.P125PT
MarkLineWeight.P25PT
MarkLineWeight.P50PT
MarkLineWeight.P05MM
MarkLineWeight.P07MM
MarkLineWeight.P10MM
MarkLineWeight.P15MM
MarkLineWeight.P20MM
MarkLineWeight.P30MM
r/wThe stroke weight (in points) for printer marks.
markOffsetMeasurement Unit (Number or String) r/wThe distance to offset the page marks from the edge of the page.
markTypeMarkTypes
String
r/wThe type of printer marks, either an enum value or the name of a custom marks file. Can return: MarkTypes enumerator or String.
negativebool r/wIf true, prints the document as a negative.
omitBitmapsbool r/wIf true, replaces bitmap images with OPI links.
omitEPSbool r/wIf true, replaces EPS images with OPI links.
omitPDFbool r/wIf true, replaces PDF images with OPI links.
opiImageReplacementbool r/wIf 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.
pageInformationMarksbool r/wIf true, prints the filename, page number, current date and time, and color separation name.
pagePositionPagePositions:
PagePositions.UPPER_LEFT
PagePositions.CENTER_HORIZONTALLY
PagePositions.CENTER_VERTICALLY
PagePositions.CENTERED
r/wThe position of the page on the printing medium. Note: Valid only when tile is false.
pageRangePageRange
String
r/wThe 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.
paperGapMeasurement Unit (Number or String) r/wThe space between document pages on the printing medium.
paperHeightPaperSize
Unit
r/wThe paper height. Note: Valid only when paper size is custom or scale mode is scale width height. Can return: PaperSize enumerator or Unit.
paperOffsetMeasurement Unit (Number or String) r/wThe amount of space to offset the page from the left edge of the imageable area.
paperSizePaperSizes
String
r/wThe 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.
paperSizeList Array of string readonlyA list of the available paper sizes.
paperTransversebool r/wIf true, uses transverse orientation.
paperWidthPaperSize
Unit
r/wThe paper width. Note: Valid only when paper size is custom or scale mode is scale width height. Can return: PaperSize enumerator or Unit.
parentBook
Document
readonlyThe parent of the PrintPreference (a Book or Document).
postscriptLevelPostScriptLevels:
PostScriptLevels.LEVEL_2
PostScriptLevels.LEVEL_3
r/wThe PostScript level of the printer.
ppdPPDValues
String
r/wThe PPD, specified as a PPD name or an enumeration. Can return: PPDValues enumerator or String.
ppdList Array of string readonlyAvailable PPDs.
preserveColorNumbersbool r/wIf true, preserves uncalibrated color numbers.
printBlackbool r/wIf true, prints the black ink. Note: Valid only when trapping is off.
printBlankPagesbool r/wIf true, prints blank pages. Note: Valid only when trapping is off.
printCyanbool r/wIf true, prints the cyan ink. Note: Valid only when trapping is off.
printFileFile r/wThe PostScript file to print to. Note: Valid only when the current printer is defined as postscript file.
printGuidesGridsbool r/wIf true, prints visible guides and baseline grids. Note: Valid only when trapping is off.
printLayersPrintLayerOptions:
PrintLayerOptions.ALL_LAYERS
PrintLayerOptions.VISIBLE_LAYERS
PrintLayerOptions.VISIBLE_PRINTABLE_LAYERS
r/wThe layers to print.
printMagentabool r/wIf true, prints the magenta ink. Note: Valid only when trapping is off.
printMasterPagesbool r/wIf true, prints master pages.
printNonprintingbool r/wIf true, prints non-printing objects. Note: Valid only when trapping is off.
printPageOrientationPrintPageOrientation:
PrintPageOrientation.PORTRAIT
PrintPageOrientation.LANDSCAPE
PrintPageOrientation.REVERSE_PORTRAIT
PrintPageOrientation.REVERSE_LANDSCAPE
r/wThe orientation of the printed page.
printSpreadsbool r/wIf true, prints each spread with all spread pages on a single sheet. If false, prints spread pages as separate pages.
printYellowbool r/wIf true, prints the yellow ink. Note: Valid only when trapping is off.
printerPrinter
String
r/wThe current printer. Can return: Printer enumerator or String.
printerList Array of string readonlyAvailable printers.
profileProfile
String
r/wThe color profile. Can return: Profile enumerator or String.
propertiesObject r/wA property that allows setting of several properties at the same time.
registrationMarksbool r/wIf true, prints small targets outside the page area for aligning color separations.
reverseOrderbool r/wIf true, prints pages in reverse order.
scaleHeightnumber r/wThe 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.
scaleModeScaleModes:
ScaleModes.SCALE_WIDTH_HEIGHT
ScaleModes.SCALE_TO_FIT
r/wThe policy for scaling the page. Note: Valid only when printing from Layout view.
scaleProportionalbool r/wIf 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.
scaleWidthnumber r/wThe 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.
screeningScreeening
String
r/wThe ink screening settings for composite gray output in PostScript or PDF format. . Can return: Screeening enumerator or String.
screeningList Array of string readonlyLists the ink screenings available in the PPD. Note: Valid only when color output is separations or in rip separations.
sendImageDataImageDataTypes:
ImageDataTypes.ALL_IMAGE_DATA
ImageDataTypes.OPTIMIZED_SUBSAMPLING
ImageDataTypes.PROXY_IMAGE_DATA
ImageDataTypes.NONE
r/wThe image data sent to the printer or file.
sequenceSequences:
Sequences.ALL
Sequences.ODD
Sequences.EVEN
r/wThe sequence of pages to print.
simulateOverprintbool r/wIf 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.
sourceSpaceSourceSpaces:
SourceSpaces.USE_DOCUMENT
SourceSpaces.PROOF_SPACE
r/wThe source of the color management system. Note: Valid only when use color management is true.
textAsBlackbool r/wIf 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.
thumbnailsbool r/wIf true, prints thumbnails. Note: Valid only when trapping is off and tile is false.
thumbnailsPerPageThumbsPerPage:
ThumbsPerPage.K1X2
ThumbsPerPage.K2X2
ThumbsPerPage.K3X3
ThumbsPerPage.K4X4
ThumbsPerPage.K5X5
ThumbsPerPage.K6X6
ThumbsPerPage.K7X7
r/wThe number of thumbnails per page.
tilebool r/wIf true, tiles pages.
tilingOverlapnumber r/wThe amount of tiling overlap. Note: Valid only when tiling is true and tiling type is not manual.
tilingTypeTilingTypes:
TilingTypes.AUTO
TilingTypes.AUTO_JUSTIFIED
TilingTypes.MANUAL
r/wThe tiling type. Note: Valid only when tiling is true.
trappingTrapping:
Trapping.OFF
Trapping.APPLICATION_BUILTIN
Trapping.ADOBE_INRIP
r/wThe type of trapping.
useDocumentBleedToPrintbool r/wIf true, uses the bleed area set for the document.
yellowAnglenumber r/wThe angle override for yellow ink. (Range: 0 to 360)
yellowFrequencynumber r/wThe frequency override for yellow ink. (Range: 1 to 500)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of PrintPreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the PrintPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Book.printPreferences

Document.printPreferences

Return

Array of PrintPreference PrintPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index