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

InDesign Server CS5.5

Class

PDFExportPreset

 PDF export settings for the document object.

QuickLinks

addEventListener, duplicate, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application
PDFExportPreset
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
acrobatCompatibilityAcrobatCompatibility:
AcrobatCompatibility.ACROBAT_4
AcrobatCompatibility.ACROBAT_5
AcrobatCompatibility.ACROBAT_6
AcrobatCompatibility.ACROBAT_7
AcrobatCompatibility.ACROBAT_8
r/wThe exported PDF document's Acrobat compatibility.
appliedFlattenerPresetFlattenerPreset r/wThe transparency flattener preset to use.
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.
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.
colorBarsbool r/wIf true, add small squares of color representing the CMYK inks and tints of gray in 10% increments.
colorBitmapCompressionBitmapCompression:
BitmapCompression.NONE
BitmapCompression.AUTO_COMPRESSION
BitmapCompression.JPEG
BitmapCompression.ZIP
BitmapCompression.JPEG_2000
BitmapCompression.AUTOMATIC_JPEG_2000
r/wThe amount of bitmap compression to use.
colorBitmapQualityCompressionQuality:
CompressionQuality.MINIMUM
CompressionQuality.LOW
CompressionQuality.MEDIUM
CompressionQuality.HIGH
CompressionQuality.MAXIMUM
CompressionQuality.FOUR_BIT
CompressionQuality.EIGHT_BIT
r/wThe compression option to apply to color images.
colorBitmapSamplingSampling:
Sampling.NONE
Sampling.DOWNSAMPLE
Sampling.SUBSAMPLE
Sampling.BICUBIC_DOWNSAMPLE
r/wThe sampling option to apply to color bitmap images in the PDF document.
colorBitmapSamplingDPInumber (range: 9 - 2400) r/wThe ppi of the resampled image. (Range: 9 to 2400)
colorTileSizenumber (range: 128 - 2048) r/wThe tile size for color images. Valid only when color bitmap compression is JPEG 2000. (Range: 128 to 2048)
compressTextAndLineArtbool r/wIf true, compresses text and line art using ZIP compression.
compressionTypePDFCompressionType:
PDFCompressionType.COMPRESS_NONE
PDFCompressionType.COMPRESS_STRUCTURE
PDFCompressionType.COMPRESS_OBJECTS
r/wThe objects to compress in the PDF document.
cropImagesToFramesbool r/wIf true, image data that falls outside the visible portion of an image's frame is not exported to the PDF document.
cropMarksbool r/wPrints crop marks that define where the page should be trimmed.
effectiveOCRegistrystring readonlyEffective PDF/X OC Registry.
effectiveOutputConditionstring readonlyEffective PDF/X output condition.
effectivePDFDestinationProfilePDFProfileSelector
String
readonlyEffective destination color profile. Can return: PDFProfileSelector enumerator or String.
effectivePDFXProfilePDFProfileSelector
String
readonlyEffective PDF X color profile. Can return: PDFProfileSelector enumerator or String.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
exportGuidesAndGridsbool r/wIf true, includes visible guides and baseline grids in the PDF document.
exportLayersbool r/wIf true, saves each layer as an Acrobat layer within the PDF document.
exportNonprintingObjectsbool r/wIf true, makes non-printing objects visible in the PDF document.
exportReaderSpreadsbool r/wIf true, each spread in the exported document is combined into a single page that has spread's original width.
exportWhichLayersExportLayerOptions:
ExportLayerOptions.EXPORT_ALL_LAYERS
ExportLayerOptions.EXPORT_VISIBLE_LAYERS
ExportLayerOptions.EXPORT_VISIBLE_PRINTABLE_LAYERS
r/wWhich layers to export.
fullNameFile readonlyThe full path to the PDFExportPreset, including the name of the PDFExportPreset.
generateThumbnailsbool r/wIf true, generates thumbnail images for each page or spread.
grayTileSizenumber (range: 128 - 2048) r/wThe tile size for grayscale images. Valid only when grayscale bitmap compression is JPEG 2000. (Range: 128 to 2048)
grayscaleBitmapCompressionBitmapCompression:
BitmapCompression.NONE
BitmapCompression.AUTO_COMPRESSION
BitmapCompression.JPEG
BitmapCompression.ZIP
BitmapCompression.JPEG_2000
BitmapCompression.AUTOMATIC_JPEG_2000
r/wThe bitmap compression option to apply to grayscale bitmap images.
grayscaleBitmapQualityCompressionQuality:
CompressionQuality.MINIMUM
CompressionQuality.LOW
CompressionQuality.MEDIUM
CompressionQuality.HIGH
CompressionQuality.MAXIMUM
CompressionQuality.FOUR_BIT
CompressionQuality.EIGHT_BIT
r/wThe compression option to apply to grayscale bitmap images.
grayscaleBitmapSamplingSampling:
Sampling.NONE
Sampling.DOWNSAMPLE
Sampling.SUBSAMPLE
Sampling.BICUBIC_DOWNSAMPLE
r/wThe sampling option to apply to grayscale bitmap images.
grayscaleBitmapSamplingDPInumber (range: 9 - 2400) r/wThe ppi of the resampled image. (Range: 9 to 2400)
ignoreSpreadOverridesbool r/wIf true, ignores flattener spread overrides.
includeBookmarksbool r/wIf true, displays bookmarks and table of contents entries as links in the bookmarks pane in the PDF document. If false, no bookmarks are exported.
includeHyperlinksbool r/wIf true, includes hyperlinks when exporting the document.
includeICCProfilesBoolean
ICCProfiles
r/wThe ICC Profiles to include in the exported PDF document. Can also accept: Boolean.
includeSlugWithPDFbool r/wIf true, includes the document's slug area in the PDF document.
includeStructurebool r/wIf 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.
indexnumber readonlyThe index of the PDFExportPreset within its containing object.
interactiveElementsOptionInteractiveElementsOptions:
InteractiveElementsOptions.DO_NOT_INCLUDE
InteractiveElementsOptions.APPEARANCE_ONLY
r/wHow to draw interactive elements.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
monochromeBitmapCompressionMonoBitmapCompression:
MonoBitmapCompression.NONE
MonoBitmapCompression.CCIT3
MonoBitmapCompression.CCIT4
MonoBitmapCompression.ZIP
MonoBitmapCompression.RUN_LENGTH
r/wThe bitmap compression option to apply to monochrome bitmap images.
monochromeBitmapSamplingSampling:
Sampling.NONE
Sampling.DOWNSAMPLE
Sampling.SUBSAMPLE
Sampling.BICUBIC_DOWNSAMPLE
r/wThe sampling option to apply to monochrome bitmap images.
monochromeBitmapSamplingDPInumber (range: 9 - 2400) r/wThe ppi of the resampled image. (Range: 9 to 2400)
namestring r/wThe name of the PDFExportPreset.
ocRegistrystring r/wThe web address for the output condition registry. Not valid when PDF/X-3 is the compliance standard or PDF export preset.
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.
optimizePDFbool r/wIf true, optimizes the exported PDF document for faster viewing in a web browser. Note: Compresses text and line art, regardless of specified compression settings.
outputConditionstring r/wThe 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.
outputConditionNamestring r/wThe name of the output condition. Valid only when a PDF/X standard has been defined for the document.
pageInformationMarksbool r/wIf true, prints the filename, page number, current date and time, and color separation name.
pageMarksOffsetMeasurement Unit (Number or String) (range: 0 - 72) r/wThe offset from the edge of the page for page marks.
parentApplication readonlyThe parent of the PDFExportPreset (a Application).
pdfColorSpacePDFColorSpace:
PDFColorSpace.RGB
PDFColorSpace.CMYK
PDFColorSpace.UNCHANGED_COLOR_SPACE
PDFColorSpace.REPURPOSE_RGB
PDFColorSpace.REPURPOSE_CMYK
r/wThe color space to use to represent color information in the exported PDF document.
pdfDestinationProfilePDFProfileSelector
String
r/wThe gamut of the final RGB or CMYK device. Can return: PDFProfileSelector enumerator or String.
pdfMarkTypeMarkTypes
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.
pdfXProfilePDFProfileSelector
String
r/wThe PDF X color profile to use for the PDF document. . Can return: PDFProfileSelector enumerator or String.
printerMarkWeightPDFMarkWeight:
PDFMarkWeight.P125PT
PDFMarkWeight.P25PT
PDFMarkWeight.P50PT
PDFMarkWeight.P05MM
PDFMarkWeight.P07MM
PDFMarkWeight.P10MM
PDFMarkWeight.P15MM
PDFMarkWeight.P20MM
PDFMarkWeight.P30MM
r/wThe stroke weight for printer's marks.
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.
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.
standardsCompliancePDFXStandards:
PDFXStandards.NONE
PDFXStandards.PDFX1A2001_STANDARD
PDFXStandards.PDFX32002_STANDARD
PDFXStandards.PDFX1A2003_STANDARD
PDFXStandards.PDFX32003_STANDARD
PDFXStandards.PDFX42010_STANDARD
r/wThe PDF/X standards compliance to test against.
subsetFontsBelownumber (range: 0 - 100) r/wSets 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).
thresholdToCompressColornumber r/wThe minimum dpi at which color compression is applied. (Range: 1 to 10 times the value specified for color bitmap sampling DPI.)
thresholdToCompressGraynumber r/wThe minimum dpi at which grayscale compression is applied. (Range: 1 to 10 times the value specified for grayscale bitmap sampling DPI.)
thresholdToCompressMonochromenumber r/wThe minimum dpi at which monochrome compression is applied. (Range: 1 to 10 times the value specified for monochrome bitmap sampling DPI.)
useDocumentBleedWithPDFbool r/wIf true, uses the document's bleed settings in the PDF document.

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)

PDFExportPreset duplicate ()
Duplicates the PDFExportPreset.

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

void remove ()
Deletes the PDFExportPreset.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

void Book.exportFile (format: varies[, to: File][, showingOptions: bool=false][, using: PDFExportPreset][, whichDocuments: Array of BookContent][, versionComments: string][, forceSave: bool=false])

void Button.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Character.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void DataMerge.exportFile (to: File[, using: PDFExportPreset][, outputOversetReportFile: File])

void Document.exportFile (format: varies, to: File[, using: PDFExportPreset][, withGrids: bool=false][, versionComments: string][, forceSave: bool=false])

void EPS.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void EPSText.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void FormField.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Graphic.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void GraphicLine.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Group.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Image.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void ImportedPage.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void InsertionPoint.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Line.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void MediaItem.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Movie.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void MultiStateObject.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Oval.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void PDF.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

PDFExportPreset PDFExportPresets.nextItem (obj: PDFExportPreset)

PDFExportPreset PDFExportPresets.previousItem (obj: PDFExportPreset)

void PICT.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void PageItem.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Paragraph.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Polygon.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Rectangle.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Sound.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void SplineItem.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Story.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Text.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void TextColumn.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void TextFrame.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void TextStyleRange.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void WMF.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void Word.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

void XMLElement.exportFile (format: varies, to: File[, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])

Return

PDFExportPreset PDFExportPreset.duplicate ()

Array of PDFExportPreset PDFExportPreset.getElements ()

PDFExportPreset PDFExportPresets.[] (index: number)

PDFExportPreset PDFExportPresets.add ([withProperties: Object])

PDFExportPreset PDFExportPresets.anyItem ()

Array of PDFExportPreset PDFExportPresets.everyItem ()

PDFExportPreset PDFExportPresets.firstItem ()

PDFExportPreset PDFExportPresets.item (index: varies)

PDFExportPreset PDFExportPresets.itemByName (name: string)

Array of PDFExportPreset PDFExportPresets.itemByRange (from: varies, to: varies)

PDFExportPreset PDFExportPresets.lastItem ()

PDFExportPreset PDFExportPresets.middleItem ()

PDFExportPreset PDFExportPresets.nextItem (obj: PDFExportPreset)

PDFExportPreset PDFExportPresets.previousItem (obj: PDFExportPreset)

Jongware, 28-Apr-2012 v3.0.3iContents :: Index