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

InDesign Server CS5

previous page next page

Class

PrintPreference

Print preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Book | Document

Preference

PrintPreference

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
activePrinterPreset	PrinterPreset PrinterPresetTypes	r/w	The current printer preset type. Can return: PrinterPresetTypes enumerator or PrinterPreset.
allPrinterMarks	bool	r/w	If true, prints all printer marks. If false, prints specified printer marks.
bitmapPrinting	bool	r/w	If true, uses bitmap printing.
bitmapResolution	number (range: 72 - 1200)	r/w	The resolution for bitmap printing. (Range: 72 to 1200) Note: Valid when bitmap printing is true.
blackAngle	number	r/w	The angle override for black ink. (Range: 0 to 360)
blackFrequency	number	r/w	The frequency override for black ink. (Range: 1 to 500)
bleedBottom	Measurement Unit (Number or String) (range: 0 - 432)	r/w	The height of the bleed area at the bottom of the page. Note: Valid only when use document bleed to print is true.
bleedChain	bool	r/w	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	Measurement Unit (Number or String) (range: 0 - 432)	r/w	The width of the bleed area at the inside of the page. Note: Valid only when use document bleed to print is true.
bleedMarks	bool	r/w	If true, print bleed marks.
bleedOutside	Measurement Unit (Number or String) (range: 0 - 432)	r/w	The width of the bleed area at the outside of the page. Note: Valid only when use document bleed to print is true.
bleedTop	Measurement Unit (Number or String) (range: 0 - 432)	r/w	The height of the bleed area at the top of the page. Note: Valid only when use document bleed to print is true.
collating	bool	r/w	If true, collate printed copies.
colorBars	bool	r/w	If true, add small squares of color representing the CMYK inks and tints of gray in 10% increments.
colorOutput	ColorOutputModes: ColorOutputModes.COMPOSITE_LEAVE_UNCHANGED ColorOutputModes.COMPOSITE_GRAY ColorOutputModes.COMPOSITE_RGB ColorOutputModes.COMPOSITE_CMYK ColorOutputModes.SEPARATIONS ColorOutputModes.INRIP_SEPARATIONS	r/w	The color output mode for composites. Note: Not valid when a device-independent PPD is specified.
compositeAngle	number	r/w	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	r/w	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	r/w	The number of copies to print. Note: Not valid when printer is PostScript File.
crd	ColorRenderingDictionary String	r/w	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	bool	r/w	Prints crop marks that define where the page should be trimmed.
cyanAngle	number	r/w	The angle override for cyan ink. (Range: 0 to 360)
cyanFrequency	number	r/w	The frequency override for cyan ink. (Range: 1 to 500)
dataFormat	DataFormat: DataFormat.ASCII DataFormat.BINARY	r/w	The format in which to send image data to the printer.
downloadPPDFonts	bool	r/w	If true, downloads all fonts listed in the selected PPD. Valid only when font downloading is complete or subset.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
flattenerPresetName	string	r/w	The name of the transparency flattener preset.
flip	Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	r/w	The direction in which to flip the printed image.
fontDownloading	FontDownloading: FontDownloading.NONE FontDownloading.COMPLETE FontDownloading.SUBSET FontDownloading.SUBSET_LARGE	r/w	Controls how fonts are downloaded to the printer.
ignoreSpreadOverrides	bool	r/w	If true, ignores flattener spread overrides.
includeSlugToPrint	bool	r/w	If true, includes the slug area in the printed document.
intent	RenderingIntent: RenderingIntent.USE_COLOR_SETTINGS RenderingIntent.PERCEPTUAL RenderingIntent.SATURATION RenderingIntent.RELATIVE_COLORIMETRIC RenderingIntent.ABSOLUTE_COLORIMETRIC	r/w	The rendering intent. Note: Valid only when use color management is true.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
magentaAngle	number	r/w	The angle override for magenta ink. (Range: 0 to 360)
magentaFrequency	number	r/w	The frequency override for magenta ink. (Range: 1 to 500)
markLineWeight	MarkLineWeight: MarkLineWeight.P125PT MarkLineWeight.P25PT MarkLineWeight.P50PT MarkLineWeight.P05MM MarkLineWeight.P07MM MarkLineWeight.P10MM MarkLineWeight.P15MM MarkLineWeight.P20MM MarkLineWeight.P30MM	r/w	The stroke weight (in points) for printer marks.
markOffset	Measurement Unit (Number or String)	r/w	The distance to offset the page marks from the edge of the page.
markType	MarkTypes String	r/w	The type of printer marks, either an enum value or the name of a custom marks file. Can return: MarkTypes enumerator or String.
negative	bool	r/w	If true, prints the document as a negative.
omitBitmaps	bool	r/w	If true, replaces bitmap images with OPI links.
omitEPS	bool	r/w	If true, replaces EPS images with OPI links.
omitPDF	bool	r/w	If true, replaces PDF images with OPI links.
opiImageReplacement	bool	r/w	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	bool	r/w	If true, prints the filename, page number, current date and time, and color separation name.
pagePosition	PagePositions: PagePositions.UPPER_LEFT PagePositions.CENTER_HORIZONTALLY PagePositions.CENTER_VERTICALLY PagePositions.CENTERED	r/w	The position of the page on the printing medium. Note: Valid only when tile is false.
pageRange	PageRange String	r/w	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	Measurement Unit (Number or String)	r/w	The space between document pages on the printing medium.
paperHeight	PaperSize Unit	r/w	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	Measurement Unit (Number or String)	r/w	The amount of space to offset the page from the left edge of the imageable area.
paperSize	PaperSizes String	r/w	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	bool	r/w	If true, uses transverse orientation.
paperWidth	PaperSize Unit	r/w	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).
postscriptLevel	PostScriptLevels: PostScriptLevels.LEVEL_2 PostScriptLevels.LEVEL_3	r/w	The PostScript level of the printer.
ppd	PPDValues String	r/w	The PPD, specified as a PPD name or an enumeration. Can return: PPDValues enumerator or String.
ppdList	Array of string	readonly	Available PPDs.
preserveColorNumbers	bool	r/w	If true, preserves uncalibrated color numbers.
printBlack	bool	r/w	If true, prints the black ink. Note: Valid only when trapping is off.
printBlankPages	bool	r/w	If true, prints blank pages. Note: Valid only when trapping is off.
printCyan	bool	r/w	If true, prints the cyan ink. Note: Valid only when trapping is off.
printFile	File	r/w	The PostScript file to print to. Note: Valid only when the current printer is defined as postscript file.
printGuidesGrids	bool	r/w	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	r/w	The layers to print.
printMagenta	bool	r/w	If true, prints the magenta ink. Note: Valid only when trapping is off.
printMasterPages	bool	r/w	If true, prints master pages.
printNonprinting	bool	r/w	If true, prints non-printing objects. Note: Valid only when trapping is off.
printPageOrientation	PrintPageOrientation: PrintPageOrientation.PORTRAIT PrintPageOrientation.LANDSCAPE PrintPageOrientation.REVERSE_PORTRAIT PrintPageOrientation.REVERSE_LANDSCAPE	r/w	The orientation of the printed page.
printSpreads	bool	r/w	If true, prints each spread with all spread pages on a single sheet. If false, prints spread pages as separate pages.
printYellow	bool	r/w	If true, prints the yellow ink. Note: Valid only when trapping is off.
printer	Printer String	r/w	The current printer. Can return: Printer enumerator or String.
printerList	Array of string	readonly	Available printers.
profile	Profile String	r/w	The color profile. Can return: Profile enumerator or String.
properties	Object	r/w	A property that allows setting of several properties at the same time.
registrationMarks	bool	r/w	If true, prints small targets outside the page area for aligning color separations.
reverseOrder	bool	r/w	If true, prints pages in reverse order.
scaleHeight	number	r/w	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_WIDTH_HEIGHT ScaleModes.SCALE_TO_FIT	r/w	The policy for scaling the page. Note: Valid only when printing from Layout view.
scaleProportional	bool	r/w	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	r/w	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 String	r/w	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.OPTIMIZED_SUBSAMPLING ImageDataTypes.PROXY_IMAGE_DATA ImageDataTypes.NONE	r/w	The image data sent to the printer or file.
sequence	Sequences: Sequences.ALL Sequences.ODD Sequences.EVEN	r/w	The sequence of pages to print.
simulateOverprint	bool	r/w	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.USE_DOCUMENT SourceSpaces.PROOF_SPACE	r/w	The source of the color management system. Note: Valid only when use color management is true.
textAsBlack	bool	r/w	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	bool	r/w	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	r/w	The number of thumbnails per page.
tile	bool	r/w	If true, tiles pages.
tilingOverlap	number	r/w	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	r/w	The tiling type. Note: Valid only when tiling is true.
trapping	Trapping: Trapping.OFF Trapping.APPLICATION_BUILTIN Trapping.ADOBE_INRIP	r/w	The type of trapping.
useDocumentBleedToPrint	bool	r/w	If true, uses the bleed area set for the document.
yellowAngle	number	r/w	The angle override for yellow ink. (Range: 0 to 360)
yellowFrequency	number	r/w	The frequency override for yellow ink. (Range: 1 to 500)

Methods

Instances

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	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.

Element of

Book.printPreferences

Document.printPreferences

Return

Array of PrintPreference PrintPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3d

Contents :: Index

previous page start next page