PrintPreference

Print preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, ColorOutputModes, ColorRenderingDictionary, DataFormat, EventListeners, Events, File, Flip, FontDownloading, ImageDataTypes, MarkLineWeight, MarkTypes, Number, Object, PPDValues, PagePositions, PageRange, PaperSize, PaperSizes, PostScriptLevels, PrintLayerOptions, PrintPageOrientation, Printer, PrinterPreset, PrinterPresetTypes, Profile, RenderingIntent, ScaleModes, Screeening, Sequences, SourceSpaces, String, ThumbsPerPage, TilingTypes, Trapping,

Hierarchy:

Superclass: Preference

Class: PrintPreference

Property Listing

Property

Type

Access

Description

activePrinterPreset

PrinterPresetTypes

PrinterPresetTypes.CUSTOM

PrinterPresetTypes.DEFAULT_VALUE

PrinterPreset

read/write

The current printer preset type. Can return: PrinterPresetTypes enumerator or PrinterPreset.

allPrinterMarks

Boolean

read/write

If true, prints all printer marks. If false, prints specified printer marks.

bitmapPrinting

Boolean

read/write

If true, uses bitmap printing.

bitmapResolution

Number (range 72 - 1200)

read/write

The resolution for bitmap printing. (Range: 72 to 1200) Note: Valid when bitmap printing is true.

blackAngle

Number (range 0 - 360)

read/write

The angle override for black ink. (Range: 0 to 360)

blackFrequency

Number (range 1 - 500)

read/write

The frequency override for black ink. (Range: 1 to 500)

bleedBottom

Number

String

read/write

The height of the bleed area at the bottom of the page. Note: Valid only when use document bleed to print is true.

bleedChain

Boolean

read/write

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.

bleedInside

Number

String

read/write

The width of the bleed area at the inside of the page. Note: Valid only when use document bleed to print is true.

bleedMarks

Boolean

read/write

If true, print bleed marks.

bleedOutside

Number

String

read/write

The width of the bleed area at the outside of the page. Note: Valid only when use document bleed to print is true.

bleedTop

Number

String

read/write

The height of the bleed area at the top of the page. Note: Valid only when use document bleed to print is true.

collating

Boolean

read/write

If true, collate printed copies.

colorBars

Boolean

read/write

If true, add small squares of color representing the CMYK inks and tints of gray in 10% increments.

colorOutput

ColorOutputModes

ColorOutputModes.COMPOSITE_CMYK

ColorOutputModes.COMPOSITE_GRAY

ColorOutputModes.COMPOSITE_LEAVE_UNCHANGED

ColorOutputModes.COMPOSITE_RGB

ColorOutputModes.INRIP_SEPARATIONS

ColorOutputModes.SEPARATIONS

read/write

The color output mode for composites. Note: Not valid when a device-independent PPD is specified.

compositeAngle

Number (range 0 - 360)

read/write

The screen angle to use when printing composites. (Range: 0 to 360) Note: Valid only for PostScript or PDF files that use custom screening.

compositeFrequency

Number (range 1 - 500)

read/write

The screen frequency to use when printing composites. (Range: 1 to 500) Note: Valid only for PostScript or PDF files that use custom screening.

copies

Number

read/write

The number of copies to print. Note: Not valid when printer is PostScript File.

crd

ColorRenderingDictionary

ColorRenderingDictionary.DEFAULT_VALUE

ColorRenderingDictionary.USE_DOCUMENT

ColorRenderingDictionary.WORKING

String

read/write

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.

cropMarks

Boolean

read/write

Prints crop marks that define where the page should be trimmed.

cyanAngle

Number (range 0 - 360)

read/write

The angle override for cyan ink. (Range: 0 to 360)

cyanFrequency

Number (range 1 - 500)

read/write

The frequency override for cyan ink. (Range: 1 to 500)

dataFormat

DataFormat

DataFormat.ASCII

DataFormat.BINARY

read/write

The format in which to send image data to the printer.

downloadPPDFonts

Boolean

read/write

If true, downloads all fonts listed in the selected PPD. Valid only when font downloading is complete or subset.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

flattenerPresetName

String

read/write

The name of the transparency flattener preset.

flip

Flip

Flip.BOTH

Flip.HORIZONTAL

Flip.HORIZONTAL_AND_VERTICAL

Flip.NONE

Flip.VERTICAL

read/write

The direction in which to flip the printed image.

fontDownloading

FontDownloading

FontDownloading.COMPLETE

FontDownloading.NONE

FontDownloading.SUBSET

FontDownloading.SUBSET_LARGE

read/write

Controls how fonts are downloaded to the printer.

ignoreSpreadOverrides

Boolean

read/write

If true, ignores flattener spread overrides.

includeSlugToPrint

Boolean

read/write

If true, includes the slug area in the printed document.

intent

RenderingIntent

RenderingIntent.ABSOLUTE_COLORIMETRIC

RenderingIntent.PERCEPTUAL

RenderingIntent.RELATIVE_COLORIMETRIC

RenderingIntent.SATURATION

RenderingIntent.USE_COLOR_SETTINGS

read/write

The rendering intent. Note: Valid only when use color management is true.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

magentaAngle

Number (range 0 - 360)

read/write

The angle override for magenta ink. (Range: 0 to 360)

magentaFrequency

Number (range 1 - 500)

read/write

The frequency override for magenta ink. (Range: 1 to 500)

markLineWeight

MarkLineWeight

MarkLineWeight.P05MM

MarkLineWeight.P07MM

MarkLineWeight.P10MM

MarkLineWeight.P125PT

MarkLineWeight.P15MM

MarkLineWeight.P20MM

MarkLineWeight.P25PT

MarkLineWeight.P30MM

MarkLineWeight.P50PT

read/write

The stroke weight (in points) for printer marks.

markOffset

Number

String

read/write

The distance to offset the page marks from the edge of the page.

markType

MarkTypes

MarkTypes.DEFAULT_VALUE

MarkTypes.J_MARK_WITHOUT_CIRCLE

MarkTypes.J_MARK_WITH_CIRCLE

String

read/write

The type of printer marks, either an enum value or the name of a custom marks file. Can return: MarkTypes enumerator or String.

negative

Boolean

read/write

If true, prints the document as a negative.

omitBitmaps

Boolean

read/write

If true, replaces bitmap images with OPI links.

omitEPS

Boolean

read/write

If true, replaces EPS images with OPI links.

omitPDF

Boolean

read/write

If true, replaces PDF images with OPI links.

opiImageReplacement

Boolean

read/write

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.

pageInformationMarks

Boolean

read/write

If true, prints the filename, page number, current date and time, and color separation name.

pagePosition

PagePositions

PagePositions.CENTERED

PagePositions.CENTER_HORIZONTALLY

PagePositions.CENTER_VERTICALLY

PagePositions.UPPER_LEFT

read/write

The position of the page on the printing medium. Note: Valid only when tile is false.

pageRange

PageRange

PageRange.ALL_PAGES

PageRange.SELECTED_ITEMS

String

read/write

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.

paperGap

Number

String

read/write

The space between document pages on the printing medium.

paperHeight

PaperSize

PaperSize.AUTO

Unit

read/write

The paper height. Note: Valid only when paper size is custom or scale mode is scale width height. Can return: PaperSize enumerator or Unit.

paperOffset

Number

String

read/write

The amount of space to offset the page from the left edge of the imageable area.

paperSize

PaperSizes PaperSize

PaperSizes.CUSTOM

PaperSizes.DEFINED_BY_DRIVER

String

read/write

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.

paperSizeList

Array of String

readonly

A list of the available paper sizes.

paperTransverse

Boolean

read/write

If true, uses transverse orientation.

paperWidth

PaperSize

PaperSize.AUTO

Unit

read/write

The paper width. Note: Valid only when paper size is custom or scale mode is scale width height. Can return: PaperSize enumerator or Unit.

parent

Book

Document

readonly

The parent of the PrintPreference (a Book or Document).

pdfPassthrough

Boolean

readonly

If true, doing pdf passthrough.

postscriptLevel

PostScriptLevels

PostScriptLevels.LEVEL_2

PostScriptLevels.LEVEL_3

read/write

The PostScript level of the printer.

ppd

PPDValues

PPDValues.DEVICE_INDEPENDENT

String

read/write

The PPD, specified as a PPD name or an enumeration. Can return: PPDValues enumerator or String.

ppdList

Array of String

readonly

Available PPDs.

preserveColorNumbers

Boolean

read/write

If true, preserves uncalibrated color numbers.

printBlack

Boolean

read/write

If true, prints the black ink. Note: Valid only when trapping is off.

printBlankPages

Boolean

read/write

If true, prints blank pages. Note: Valid only when trapping is off.

printCyan

Boolean

read/write

If true, prints the cyan ink. Note: Valid only when trapping is off.

printFile

File

read/write

The PostScript file to print to. Note: Valid only when the current printer is defined as postscript file.

printGuidesGrids

Boolean

read/write

If true, prints visible guides and baseline grids. Note: Valid only when trapping is off.

printLayers

PrintLayerOptions

PrintLayerOptions.ALL_LAYERS

PrintLayerOptions.VISIBLE_LAYERS

PrintLayerOptions.VISIBLE_PRINTABLE_LAYERS

read/write

The layers to print.

printMagenta

Boolean

read/write

If true, prints the magenta ink. Note: Valid only when trapping is off.

printMasterPages

Boolean

read/write

If true, prints master pages.

printNonprinting

Boolean

read/write

If true, prints non-printing objects. Note: Valid only when trapping is off.

printPageOrientation

PrintPageOrientation

PrintPageOrientation.LANDSCAPE

PrintPageOrientation.PORTRAIT

PrintPageOrientation.REVERSE_LANDSCAPE

PrintPageOrientation.REVERSE_PORTRAIT

read/write

The orientation of the printed page.

printSpreads

Boolean

read/write

If true, prints each spread with all spread pages on a single sheet. If false, prints spread pages as separate pages.

printYellow

Boolean

read/write

If true, prints the yellow ink. Note: Valid only when trapping is off.

printer

Printer

Printer.POSTSCRIPT_FILE

String

read/write

The current printer. Can return: Printer enumerator or String.

printerList

Array of String

readonly

Available printers.

profile

Profile

Profile.NO_CMS

Profile.POSTSCRIPT_CMS

Profile.USE_DOCUMENT

Profile.WORKING

String

read/write

The color profile. Can return: Profile enumerator or String.

properties

Object

read/write

A property that allows setting of several properties at the same time.

registrationMarks

Boolean

read/write

If true, prints small targets outside the page area for aligning color separations.

reverseOrder

Boolean

read/write

If true, prints pages in reverse order.

scaleHeight

Number (range 0 - 1000)

read/write

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.

scaleMode

ScaleModes

ScaleModes.SCALE_TO_FIT

ScaleModes.SCALE_WIDTH_HEIGHT

read/write

The policy for scaling the page. Note: Valid only when printing from Layout view.

scaleProportional

Boolean

read/write

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.

scaleWidth

Number (range 0 - 1000)

read/write

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.

screening

Screeening

Screeening.CUSTOM

Screeening.DEFAULT_VALUE

String

read/write

The ink screening settings for composite gray output in PostScript or PDF format. . Can return: Screeening enumerator or String.

screeningList

Array of String

readonly

Lists the ink screenings available in the PPD. Note: Valid only when color output is separations or in rip separations.

sendImageData

ImageDataTypes

ImageDataTypes.ALL_IMAGE_DATA

ImageDataTypes.NONE

ImageDataTypes.OPTIMIZED_SUBSAMPLING

ImageDataTypes.PROXY_IMAGE_DATA

read/write

The image data sent to the printer or file.

sequence

Sequences

Sequences.ALL

Sequences.EVEN

Sequences.ODD

read/write

The sequence of pages to print.

simulateOverprint

Boolean

read/write

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.

sourceSpace

SourceSpaces

SourceSpaces.PROOF_SPACE

SourceSpaces.USE_DOCUMENT

read/write

The source of the color management system. Note: Valid only when use color management is true.

textAsBlack

Boolean

read/write

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.

thumbnails

Boolean

read/write

If true, prints thumbnails. Note: Valid only when trapping is off and tile is false.

thumbnailsPerPage

ThumbsPerPage

ThumbsPerPage.K1X2

ThumbsPerPage.K2X2

ThumbsPerPage.K3X3

ThumbsPerPage.K4X4

ThumbsPerPage.K5X5

ThumbsPerPage.K6X6

ThumbsPerPage.K7X7

read/write

The number of thumbnails per page.

tile

Boolean

read/write

If true, tiles pages.

tilingOverlap

Number

read/write

The amount of tiling overlap. Note: Valid only when tiling is true and tiling type is not manual.

tilingType

TilingTypes

TilingTypes.AUTO

TilingTypes.AUTO_JUSTIFIED

TilingTypes.MANUAL

read/write

The tiling type. Note: Valid only when tiling is true.

trapping

Trapping

Trapping.ADOBE_INRIP

Trapping.APPLICATION_BUILTIN

Trapping.OFF

read/write

The type of trapping.

useDocumentBleedToPrint

Boolean

read/write

If true, uses the bleed area set for the document.

yellowAngle

Number (range 0 - 360)

read/write

The angle override for yellow ink. (Range: 0 to 360)

yellowFrequency

Number (range 1 - 500)

read/write

The frequency override for yellow ink. (Range: 1 to 500)

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

PrintPreference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Document.printPreferences

Book.printPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

PrintPreference.getElements()