Adobe InDesign CS5.5 Server (7.5) Object Model JS: PDFExportPreference

InDesign Server CS5.5

previous page next page

Class

PDFExportPreference

PDF export settings for the application object. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application

Preference

PDFExportPreference

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
acrobatCompatibility	AcrobatCompatibility: AcrobatCompatibility.ACROBAT_4 AcrobatCompatibility.ACROBAT_5 AcrobatCompatibility.ACROBAT_6 AcrobatCompatibility.ACROBAT_7 AcrobatCompatibility.ACROBAT_8	r/w	The exported PDF document's Acrobat compatibility.
appliedFlattenerPreset	FlattenerPreset	r/w	The transparency flattener preset to use.
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.
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.
changeSecurityPassword	string	r/w	Changes the open document password to the specified string. Valid only when use security is true. Note: A script can set but not get this value.
colorBars	bool	r/w	If true, add small squares of color representing the CMYK inks and tints of gray in 10% increments.
colorBitmapCompression	BitmapCompression: BitmapCompression.NONE BitmapCompression.AUTO_COMPRESSION BitmapCompression.JPEG BitmapCompression.ZIP BitmapCompression.JPEG_2000 BitmapCompression.AUTOMATIC_JPEG_2000	r/w	The amount of bitmap compression to use.
colorBitmapQuality	CompressionQuality: CompressionQuality.MINIMUM CompressionQuality.LOW CompressionQuality.MEDIUM CompressionQuality.HIGH CompressionQuality.MAXIMUM CompressionQuality.FOUR_BIT CompressionQuality.EIGHT_BIT	r/w	The compression option to apply to color images.
colorBitmapSampling	Sampling: Sampling.NONE Sampling.DOWNSAMPLE Sampling.SUBSAMPLE Sampling.BICUBIC_DOWNSAMPLE	r/w	The sampling option to apply to color bitmap images in the PDF document.
colorBitmapSamplingDPI	number (range: 9 - 2400)	r/w	The ppi of the resampled image. (Range: 9 to 2400)
colorTileSize	number (range: 128 - 2048)	r/w	The tile size for color images. Valid only when color bitmap compression is JPEG 2000. (Range: 128 to 2048)
compressTextAndLineArt	bool	r/w	If true, compresses text and line art using ZIP compression.
compressionType	PDFCompressionType: PDFCompressionType.COMPRESS_NONE PDFCompressionType.COMPRESS_STRUCTURE PDFCompressionType.COMPRESS_OBJECTS	r/w	The objects to compress in the PDF document.
cropImagesToFrames	bool	r/w	If true, image data that falls outside the visible portion of an image's frame is not exported to the PDF document.
cropMarks	bool	r/w	Prints crop marks that define where the page should be trimmed.
disallowChanging	bool	r/w	If true, users cannot fill in forms, sign, extract pages, or add comments in the PDF document. Valid only when use security is true.
disallowCopying	bool	r/w	If true, users cannot copy and paste text, images, or other content from the PDF document. Valid only when use security is true.
disallowDocumentAssembly	bool	r/w	If true, users cannot insert, delete, or rotate pages in the PDF document. Valid only when use security is true.
disallowExtractionForAccessibility	bool	r/w	If true, users cannot extract content from the PDF document using software tools for the visually impaired. Valid only when use security is true.
disallowFormFillIn	bool	r/w	If true, users cannot change form fields in the PDF document. Valid only when use security is true.
disallowHiResPrinting	bool	r/w	If true, users cannot print high-resolution copies of the PDF document. Valid only when use security is true.
disallowNotes	bool	r/w	If true, users cannot add or change notes, edit text, or fill in form fields in the PDF document. Valid only when use security is true.
disallowPlaintextMetadata	bool	r/w	If true and acrobat compatibility is Acrobat 6 or higher, storage systems and search engines cannot access metadata stored in the PDF document. If true and acrobat compatibility is acrobat 5 or higher, users cannot copy and extract content from the document. Valid only when use security is true.
disallowPrinting	bool	r/w	If true, users cannot print the PDF document. Valid only when use security is true.
effectiveOCRegistry	string	readonly	Effective PDF/X OC Registry.
effectiveOutputCondition	string	readonly	Effective PDF/X output condition.
effectivePDFDestinationProfile	PDFProfileSelector String	readonly	Effective destination color profile. Can return: PDFProfileSelector enumerator or String.
effectivePDFXProfile	PDFProfileSelector String	readonly	Effective PDF X color profile. Can return: PDFProfileSelector enumerator or String.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
exportGuidesAndGrids	bool	r/w	If true, includes visible guides and baseline grids in the PDF document.
exportLayers	bool	r/w	If true, saves each layer as an Acrobat layer within the PDF document.
exportNonprintingObjects	bool	r/w	If true, makes non-printing objects visible in the PDF document.
exportReaderSpreads	bool	r/w	If true, each spread in the exported document is combined into a single page that has spread's original width.
exportWhichLayers	ExportLayerOptions: ExportLayerOptions.EXPORT_ALL_LAYERS ExportLayerOptions.EXPORT_VISIBLE_LAYERS ExportLayerOptions.EXPORT_VISIBLE_PRINTABLE_LAYERS	r/w	Which layers to export.
generateThumbnails	bool	r/w	If true, generates thumbnail images for each page or spread.
grayTileSize	number (range: 128 - 2048)	r/w	The tile size for grayscale images. Valid only when grayscale bitmap compression is JPEG 2000. (Range: 128 to 2048)
grayscaleBitmapCompression	BitmapCompression: BitmapCompression.NONE BitmapCompression.AUTO_COMPRESSION BitmapCompression.JPEG BitmapCompression.ZIP BitmapCompression.JPEG_2000 BitmapCompression.AUTOMATIC_JPEG_2000	r/w	The bitmap compression option to apply to grayscale bitmap images.
grayscaleBitmapQuality	CompressionQuality: CompressionQuality.MINIMUM CompressionQuality.LOW CompressionQuality.MEDIUM CompressionQuality.HIGH CompressionQuality.MAXIMUM CompressionQuality.FOUR_BIT CompressionQuality.EIGHT_BIT	r/w	The compression option to apply to grayscale bitmap images.
grayscaleBitmapSampling	Sampling: Sampling.NONE Sampling.DOWNSAMPLE Sampling.SUBSAMPLE Sampling.BICUBIC_DOWNSAMPLE	r/w	The sampling option to apply to grayscale bitmap images.
grayscaleBitmapSamplingDPI	number (range: 9 - 2400)	r/w	The ppi of the resampled image. (Range: 9 to 2400)
ignoreSpreadOverrides	bool	r/w	If true, ignores flattener spread overrides.
includeBookmarks	bool	r/w	If true, displays bookmarks and table of contents entries as links in the bookmarks pane in the PDF document. If false, no bookmarks are exported.
includeHyperlinks	bool	r/w	If true, includes hyperlinks when exporting the document.
includeICCProfiles	Boolean ICCProfiles	r/w	The ICC Profiles to include in the exported PDF document. Can also accept: Boolean.
includeSlugWithPDF	bool	r/w	If true, includes the document's slug area in the PDF document.
includeStructure	bool	r/w	If true, creates a tagged PDF file. Note: If acrobat compatibility is acrobat 6 or higher, tags are visible only when the PDF is opened in Acrobat 6 or higher.
interactiveElementsOption	InteractiveElementsOptions: InteractiveElementsOptions.DO_NOT_INCLUDE InteractiveElementsOptions.APPEARANCE_ONLY	r/w	How to draw interactive elements.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
monochromeBitmapCompression	MonoBitmapCompression: MonoBitmapCompression.NONE MonoBitmapCompression.CCIT3 MonoBitmapCompression.CCIT4 MonoBitmapCompression.ZIP MonoBitmapCompression.RUN_LENGTH	r/w	The bitmap compression option to apply to monochrome bitmap images.
monochromeBitmapSampling	Sampling: Sampling.NONE Sampling.DOWNSAMPLE Sampling.SUBSAMPLE Sampling.BICUBIC_DOWNSAMPLE	r/w	The sampling option to apply to monochrome bitmap images.
monochromeBitmapSamplingDPI	number (range: 9 - 2400)	r/w	The ppi of the resampled image. (Range: 9 to 2400)
ocRegistry	string	r/w	The web address for the output condition registry. Not valid when PDF/X-3 is the compliance standard or PDF export preset.
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.
openDocumentPassword	string	r/w	The password to enter when opening the PDF document. Valid only when use security is true. Note: A script can set but not get this value.
optimizePDF	bool	r/w	If true, optimizes the exported PDF document for faster viewing in a web browser. Note: Compresses text and line art, regardless of specified compression settings.
outputCondition	string	r/w	The name of the intended printing condition. Valid only when a PDF/X compliance standard has been defined for the document. Not valid when PDF/X-3 is the compliance standard or PDF export preset. For information on compliance standards, see standards compliance and PDF X standards.
outputConditionName	string	r/w	The name of the output condition. Valid only when a PDF/X standard has been defined for the document.
pageInformationMarks	bool	r/w	If true, prints the filename, page number, current date and time, and color separation name.
pageMarksOffset	Measurement Unit (Number or String) (range: 0 - 72)	r/w	The offset from the edge of the page for page marks.
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.
parent	Application	readonly	The parent of the PDFExportPreference (a Application).
pdfColorSpace	PDFColorSpace: PDFColorSpace.RGB PDFColorSpace.CMYK PDFColorSpace.UNCHANGED_COLOR_SPACE PDFColorSpace.REPURPOSE_RGB PDFColorSpace.REPURPOSE_CMYK	r/w	The color space to use to represent color information in the exported PDF document.
pdfDestinationProfile	PDFProfileSelector String	r/w	The gamut of the final RGB or CMYK device. Can return: PDFProfileSelector enumerator or String.
pdfMarkType	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.
pdfXProfile	PDFProfileSelector String	r/w	The PDF X color profile to use for the PDF document. . Can return: PDFProfileSelector enumerator or String.
printerMarkWeight	PDFMarkWeight: PDFMarkWeight.P125PT PDFMarkWeight.P25PT PDFMarkWeight.P50PT PDFMarkWeight.P05MM PDFMarkWeight.P07MM PDFMarkWeight.P10MM PDFMarkWeight.P15MM PDFMarkWeight.P20MM PDFMarkWeight.P30MM	r/w	The stroke weight for printer's marks.
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.
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.
standardsCompliance	PDFXStandards: PDFXStandards.NONE PDFXStandards.PDFX1A2001_STANDARD PDFXStandards.PDFX32002_STANDARD PDFXStandards.PDFX1A2003_STANDARD PDFXStandards.PDFX32003_STANDARD PDFXStandards.PDFX42010_STANDARD	r/w	The PDF/X standards compliance to test against.
subsetFontsBelow	number (range: 0 - 100)	r/w	Sets the threshold for embedding complete fonts based on how many of the fonts' characters are used in the document. If the percentage of characters used in the document for any given font exceeds the specified value, the font is completely embedded; otherwise, the font is subsetted. (Range: 0 to 100) Notes: Embedding complete fonts increases file size. To completely embed all fonts, use 0 (zero).
thresholdToCompressColor	number	r/w	The minimum dpi at which color compression is applied. (Range: 1 to 10 times the value specified for color bitmap sampling DPI.)
thresholdToCompressGray	number	r/w	The minimum dpi at which grayscale compression is applied. (Range: 1 to 10 times the value specified for grayscale bitmap sampling DPI.)
thresholdToCompressMonochrome	number	r/w	The minimum dpi at which monochrome compression is applied. (Range: 1 to 10 times the value specified for monochrome bitmap sampling DPI.)
useDocumentBleedWithPDF	bool	r/w	If true, uses the document's bleed settings in the PDF document.
useSecurity	bool	r/w	If true, activates security controls for the PDF document.
viewJDF	bool	r/w	If true, creates a Job Definition Format (JDF) file using Acrobat.
viewPDF	bool	r/w	If true, automatically opens the PDF file after exporting.

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 PDFExportPreference 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 PDFExportPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.pdfExportPreferences

Return

Array of PDFExportPreference PDFExportPreference.getElements ()

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index

previous page start next page