PDFExportPreference

PDF export settings for the application object.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

AcrobatCompatibility, BitmapCompression, Boolean, CompressionQuality, EventListeners, Events, ExportLayerOptions, FlattenerPreset, ICCProfiles, InteractiveElementsOptions, MarkTypes, MonoBitmapCompression, Number, Object, PDFColorSpace, PDFCompressionType, PDFMarkWeight, PDFProfileSelector, PDFXStandards, PageLayoutOptions, PageRange, PdfDisplayTitleOptions, PdfMagnificationOptions, Sampling, String,

Hierarchy:

Superclass: Preference

Class: PDFExportPreference

Property Listing

Property

Type

Access

Description

acrobatCompatibility

AcrobatCompatibility

AcrobatCompatibility.ACROBAT_4

AcrobatCompatibility.ACROBAT_5

AcrobatCompatibility.ACROBAT_6

AcrobatCompatibility.ACROBAT_7

AcrobatCompatibility.ACROBAT_8

read/write

The exported PDF document's Acrobat compatibility.

appliedFlattenerPreset

FlattenerPreset

read/write

The transparency flattener preset to use.

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.

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.

changeSecurityPassword

String

read/write

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

Boolean

read/write

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

colorBitmapCompression

BitmapCompression

BitmapCompression.AUTOMATIC_JPEG_2000

BitmapCompression.AUTO_COMPRESSION

BitmapCompression.JPEG

BitmapCompression.JPEG_2000

BitmapCompression.NONE

BitmapCompression.ZIP

read/write

The amount of bitmap compression to use.

colorBitmapQuality

CompressionQuality

CompressionQuality.EIGHT_BIT

CompressionQuality.FOUR_BIT

CompressionQuality.HIGH

CompressionQuality.LOW

CompressionQuality.MAXIMUM

CompressionQuality.MEDIUM

CompressionQuality.MINIMUM

read/write

The compression option to apply to color images.

colorBitmapSampling

Sampling

Sampling.BICUBIC_DOWNSAMPLE

Sampling.DOWNSAMPLE

Sampling.NONE

Sampling.SUBSAMPLE

read/write

The sampling option to apply to color bitmap images in the PDF document.

colorBitmapSamplingDPI

Number (range 9 - 2400)

read/write

The ppi of the resampled image. (Range: 9 to 2400)

colorTileSize

Number (range 128 - 2048)

read/write

The tile size for color images. Valid only when color bitmap compression is JPEG 2000. (Range: 128 to 2048)

compressTextAndLineArt

Boolean

read/write

If true, compresses text and line art using ZIP compression.

compressionType

PDFCompressionType

PDFCompressionType.COMPRESS_NONE

PDFCompressionType.COMPRESS_OBJECTS

PDFCompressionType.COMPRESS_STRUCTURE

read/write

The objects to compress in the PDF document.

cropImagesToFrames

Boolean

read/write

If true, image data that falls outside the visible portion of an image's frame is not exported to the PDF document.

cropMarks

Boolean

read/write

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

defaultDocumentLanguage

String

read/write

Sets the default document language in the exported PDF. The correct ISO code of the language must be provided.

disallowChanging

Boolean

read/write

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

Boolean

read/write

If true, users cannot copy and paste text, images, or other content from the PDF document. Valid only when use security is true.

disallowDocumentAssembly

Boolean

read/write

If true, users cannot insert, delete, or rotate pages in the PDF document. Valid only when use security is true.

disallowExtractionForAccessibility

Boolean

read/write

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

Boolean

read/write

If true, users cannot change form fields in the PDF document. Valid only when use security is true.

disallowHiResPrinting

Boolean

read/write

If true, users cannot print high-resolution copies of the PDF document. Valid only when use security is true.

disallowNotes

Boolean

read/write

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

Boolean

read/write

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

Boolean

read/write

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

PDFProfileSelector.USE_DOCUMENT

PDFProfileSelector.USE_MONITOR_PROFILE

PDFProfileSelector.USE_NO_PROFILE

PDFProfileSelector.WORKING

String

readonly

Effective destination color profile. Can return: PDFProfileSelector enumerator or String.

effectivePDFXProfile

PDFProfileSelector

PDFProfileSelector.USE_DOCUMENT

PDFProfileSelector.USE_MONITOR_PROFILE

PDFProfileSelector.USE_NO_PROFILE

PDFProfileSelector.WORKING

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.

exportAsSinglePages

Boolean

read/write

Export each page or spread as a separate PDF file.

exportGuidesAndGrids

Boolean

read/write

If true, includes visible guides and baseline grids in the PDF document.

exportHiddenSpread

Boolean

read/write

If true, export hidden spreads in PDF. If false, skip export of hidden spreads.

exportLayers

Boolean

read/write

If true, saves each layer as an Acrobat layer within the PDF document.

exportNonprintingObjects

Boolean

read/write

If true, makes non-printing objects visible in the PDF document.

exportReaderSpreads

Boolean

read/write

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

read/write

Which layers to export.

generateThumbnails

Boolean

read/write

If true, generates thumbnail images for each page or spread.

grayTileSize

Number (range 128 - 2048)

read/write

The tile size for grayscale images. Valid only when grayscale bitmap compression is JPEG 2000. (Range: 128 to 2048)

grayscaleBitmapCompression

BitmapCompression

BitmapCompression.AUTOMATIC_JPEG_2000

BitmapCompression.AUTO_COMPRESSION

BitmapCompression.JPEG

BitmapCompression.JPEG_2000

BitmapCompression.NONE

BitmapCompression.ZIP

read/write

The bitmap compression option to apply to grayscale bitmap images.

grayscaleBitmapQuality

CompressionQuality

CompressionQuality.EIGHT_BIT

CompressionQuality.FOUR_BIT

CompressionQuality.HIGH

CompressionQuality.LOW

CompressionQuality.MAXIMUM

CompressionQuality.MEDIUM

CompressionQuality.MINIMUM

read/write

The compression option to apply to grayscale bitmap images.

grayscaleBitmapSampling

Sampling

Sampling.BICUBIC_DOWNSAMPLE

Sampling.DOWNSAMPLE

Sampling.NONE

Sampling.SUBSAMPLE

read/write

The sampling option to apply to grayscale bitmap images.

grayscaleBitmapSamplingDPI

Number (range 9 - 2400)

read/write

The ppi of the resampled image. (Range: 9 to 2400)

ignoreSpreadOverrides

Boolean

read/write

If true, ignores flattener spread overrides.

includeBookmarks

Boolean

read/write

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

Boolean

read/write

If true, includes hyperlinks when exporting the document.

includeICCProfiles

ICCProfiles

ICCProfiles.INCLUDE_ALL

ICCProfiles.INCLUDE_NONE

ICCProfiles.INCLUDE_RGB_AND_TAGGED

ICCProfiles.INCLUDE_TAGGED

Boolean

read/write

The ICC Profiles to include in the exported PDF document. Can also accept: Boolean.

includeSlugWithPDF

Boolean

read/write

If true, includes the document's slug area in the PDF document.

includeStructure

Boolean

read/write

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

InteractiveElementsOptions.DO_NOT_INCLUDE

read/write

How to draw interactive elements.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

monochromeBitmapCompression

MonoBitmapCompression

MonoBitmapCompression.CCIT3

MonoBitmapCompression.CCIT4

MonoBitmapCompression.NONE

MonoBitmapCompression.RUN_LENGTH

MonoBitmapCompression.ZIP

read/write

The bitmap compression option to apply to monochrome bitmap images.

monochromeBitmapSampling

Sampling

Sampling.BICUBIC_DOWNSAMPLE

Sampling.DOWNSAMPLE

Sampling.NONE

Sampling.SUBSAMPLE

read/write

The sampling option to apply to monochrome bitmap images.

monochromeBitmapSamplingDPI

Number (range 9 - 2400)

read/write

The ppi of the resampled image. (Range: 9 to 2400)

ocRegistry

String

read/write

The web address for the output condition registry. Not valid when PDF/X-3 is the compliance standard or PDF export preset.

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.

openDocumentPassword

String

read/write

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.

openInFullScreen

Boolean

read/write

Open PDF in full screen mode.

optimizePDF

Boolean

read/write

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

read/write

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

read/write

The name of the output condition. Valid only when a PDF/X standard has been defined for the document.

pageInformationMarks

Boolean

read/write

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

pageMarksOffset

Number

String

read/write

The offset from the edge of the page for page marks.

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.

parent

Application

readonly

The parent of the PDFExportPreference (a Application).

pdfColorSpace

PDFColorSpace

PDFColorSpace.CMYK

PDFColorSpace.GRAY

PDFColorSpace.REPURPOSE_CMYK

PDFColorSpace.REPURPOSE_RGB

PDFColorSpace.RGB

PDFColorSpace.UNCHANGED_COLOR_SPACE

read/write

The color space to use to represent color information in the exported PDF document.

pdfDestinationProfile

PDFProfileSelector

PDFProfileSelector.USE_DOCUMENT

PDFProfileSelector.USE_MONITOR_PROFILE

PDFProfileSelector.USE_NO_PROFILE

PDFProfileSelector.WORKING

String

read/write

The gamut of the final RGB or CMYK device. Can return: PDFProfileSelector enumerator or String.

pdfDisplayTitle

PdfDisplayTitleOptions

PdfDisplayTitleOptions.DISPLAY_DOCUMENT_TITLE

PdfDisplayTitleOptions.DISPLAY_FILE_NAME

read/write

The export PDF display title.

pdfMagnification

PdfMagnificationOptions

PdfMagnificationOptions.ACTUAL_SIZE

PdfMagnificationOptions.DEFAULT_VALUE

PdfMagnificationOptions.FIFTY_PERCENT

PdfMagnificationOptions.FIT_HEIGHT

PdfMagnificationOptions.FIT_PAGE

PdfMagnificationOptions.FIT_VISIBLE

PdfMagnificationOptions.FIT_WIDTH

PdfMagnificationOptions.ONE_HUNDRED_PERCENT

PdfMagnificationOptions.SEVENTY_FIVE_PERCENT

PdfMagnificationOptions.TWENTY_FIVE_PERCENT

read/write

The export PDF magnification options.

pdfMarkType

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.

pdfPageLayout

PageLayoutOptions

PageLayoutOptions.DEFAULT_VALUE

PageLayoutOptions.SINGLE_PAGE

PageLayoutOptions.SINGLE_PAGE_CONTINUOUS

PageLayoutOptions.TWO_UP_COVER_PAGE

PageLayoutOptions.TWO_UP_COVER_PAGE_CONTINUOUS

PageLayoutOptions.TWO_UP_FACING

PageLayoutOptions.TWO_UP_FACING_CONTINUOUS

read/write

The export PDF page layout.

pdfXProfile

PDFProfileSelector

PDFProfileSelector.USE_DOCUMENT

PDFProfileSelector.USE_MONITOR_PROFILE

PDFProfileSelector.USE_NO_PROFILE

PDFProfileSelector.WORKING

String

read/write

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

read/write

The stroke weight for printer's marks.

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.

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.

singlePagesPDFSuffix

String

read/write

Suffix to be used at the end of each file when pages are exported as separate PDF files.

standardsCompliance

PDFXStandards

PDFXStandards.NONE

PDFXStandards.PDFX1A2001_STANDARD

PDFXStandards.PDFX1A2003_STANDARD

PDFXStandards.PDFX32002_STANDARD

PDFXStandards.PDFX32003_STANDARD

PDFXStandards.PDFX42010_STANDARD

read/write

The PDF/X standards compliance to test against.

subsetFontsBelow

Number (range 0 - 100)

read/write

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 (range 1 - 10)

read/write

The minimum dpi at which color compression is applied. (Range: 1 to 10 times the value specified for color bitmap sampling DPI.)

thresholdToCompressGray

Number (range 1 - 10)

read/write

The minimum dpi at which grayscale compression is applied. (Range: 1 to 10 times the value specified for grayscale bitmap sampling DPI.)

thresholdToCompressMonochrome

Number (range 1 - 10)

read/write

The minimum dpi at which monochrome compression is applied. (Range: 1 to 10 times the value specified for monochrome bitmap sampling DPI.)

useDocumentBleedWithPDF

Boolean

read/write

If true, uses the document's bleed settings in the PDF document.

useSecurity

Boolean

read/write

If true, activates security controls for the PDF document.

viewPDF

Boolean

read/write

If true, automatically opens the PDF file after exporting.

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)

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.pdfExportPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

PDFExportPreference.getElements()