InDesign Server2025
API 20.5.0.49
Object

PDFExportPreference

PDF export settings for the application object.

Preference PDFExportPreference
Hierarchy

Application

PDFExportPreference

Properties

NameType AccessDescription
AcrobatCompatibility
read/write The exported PDF document's Acrobat compatibility.
FlattenerPreset read/write The transparency flattener preset to use.
Number | String unit 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.
Number | String unit 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.
Boolean read/write If true, print bleed marks.
Number | String unit 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.
Number | String unit 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.
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.
Boolean read/write If true, add small squares of color representing the CMYK inks and tints of gray in 10% increments.
BitmapCompression
read/write The amount of bitmap compression to use.
CompressionQuality
read/write The compression option to apply to color images.
Sampling
read/write The sampling option to apply to color bitmap images in the PDF document.
Number 9–2400 read/write The ppi of the resampled image. (Range: 9 to 2400)
Number 128–2048 read/write The tile size for color images. Valid only when color bitmap compression is JPEG 2000. (Range: 128 to 2048)
Boolean read/write If true, compresses text and line art using ZIP compression.
PDFCompressionType
read/write The objects to compress in the PDF document.
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.
Boolean read/write Prints crop marks that define where the page should be trimmed.
String read/write Sets the default document language in the exported PDF. The correct ISO code of the language must be provided.
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.
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.
Boolean read/write If true, users cannot insert, delete, or rotate pages in the PDF document. Valid only when use security is true.
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.
Boolean read/write If true, users cannot change form fields in the PDF document. Valid only when use security is true.
Boolean read/write If true, users cannot print high-resolution copies of the PDF document. Valid only when use security is true.
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.
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.
Boolean read/write If true, users cannot print the PDF document. Valid only when use security is true.
String readonly Effective PDF/X OC Registry.
String readonly Effective PDF/X output condition.
PDFProfileSelector | String
readonly Effective destination color profile. Can return: PDFProfileSelector enumerator or String.
PDFProfileSelector | String
readonly Effective PDF X color profile. Can return: PDFProfileSelector enumerator or String.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write Export each page or spread as a separate PDF file.
Boolean read/write If true, includes visible guides and baseline grids in the PDF document.
Boolean read/write If true, export hidden spreads in PDF. If false, skip export of hidden spreads.
Boolean read/write If true, saves each layer as an Acrobat layer within the PDF document.
Boolean read/write If true, makes non-printing objects visible in the PDF document.
Boolean read/write If true, each spread in the exported document is combined into a single page that has spread's original width.
ExportLayerOptions
read/write Which layers to export.
Boolean read/write If true, generates thumbnail images for each page or spread.
Number 128–2048 read/write The tile size for grayscale images. Valid only when grayscale bitmap compression is JPEG 2000. (Range: 128 to 2048)
BitmapCompression
read/write The bitmap compression option to apply to grayscale bitmap images.
CompressionQuality
read/write The compression option to apply to grayscale bitmap images.
Sampling
read/write The sampling option to apply to grayscale bitmap images.
Number 9–2400 read/write The ppi of the resampled image. (Range: 9 to 2400)
Boolean read/write If true, ignores flattener spread overrides.
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.
ICCProfiles | Boolean
read/write The ICC Profiles to include in the exported PDF document. Can also accept: Boolean.
Boolean read/write If true, includes the document's slug area in the PDF document.
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.
InteractiveElementsOptions
read/write How to draw interactive elements.
Boolean readonly Returns true if the object specifier resolves to valid objects.
MonoBitmapCompression
read/write The bitmap compression option to apply to monochrome bitmap images.
Sampling
read/write The sampling option to apply to monochrome bitmap images.
Number 9–2400 read/write The ppi of the resampled image. (Range: 9 to 2400)
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.
Boolean read/write If true, replaces bitmap images with OPI links.
Boolean read/write If true, replaces EPS images with OPI links.
Boolean read/write If true, replaces PDF images with OPI links.
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.
Boolean read/write Open PDF in full screen mode.
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.
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.
String read/write The name of the output condition. Valid only when a PDF/X standard has been defined for the document.
Boolean read/write If true, prints the filename, page number, current date and time, and color separation name.
Number | String unit read/write The offset from the edge of the page for page marks.
PageRange | 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.
Application readonly The parent of the PDFExportPreference (a Application).
PDFColorSpace
read/write The color space to use to represent color information in the exported PDF document.
PDFProfileSelector | String
read/write The gamut of the final RGB or CMYK device. Can return: PDFProfileSelector enumerator or String.
PdfDisplayTitleOptions
read/write The export PDF display title.
PdfMagnificationOptions
read/write The export PDF magnification options.
MarkTypes | 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.
PageLayoutOptions
read/write The export PDF page layout.
PDFProfileSelector | String
read/write The PDF X color profile to use for the PDF document. . Can return: PDFProfileSelector enumerator or String.
PDFMarkWeight
read/write The stroke weight for printer's marks.
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write If true, prints small targets outside the page area for aligning color separations.
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.
String read/write Suffix to be used at the end of each file when pages are exported as separate PDF files.
PDFXStandards
read/write The PDF/X standards compliance to test against.
Number 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).
Number 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.)
Number 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.)
Number 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.)
Boolean read/write If true, uses the document's bleed settings in the PDF document.
Boolean read/write If true, activates security controls for the PDF document.
Boolean read/write If true, automatically opens the PDF file after exporting.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
PDFExportPreference[]

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

Boolean

Removes the event listener.

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

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a PDFExportPreference.

Return 1

Methods that return a PDFExportPreference.