K4 InDesign Javascript API Documentation

PreferencesPDFExportPreference

PDF export settings for the application object.

Extends

Instance Properties

Name Description Access
acrobatCompatibility AcrobatCompatibility The exported PDF document's Acrobat compatibility. read-write
appliedFlattenerPreset FlattenerPreset The transparency flattener preset to use. read-write
bleedBottom Measurement Unit (Number or String)=any The height of the bleed area at the bottom of the page. Note: Valid only when use document bleed to print is true. read-write
bleedInside Measurement Unit (Number or String)=any The width of the bleed area at the inside of the page. Note: Valid only when use document bleed to print is true. read-write
bleedMarks bool If true, print bleed marks. read-write
bleedOutside Measurement Unit (Number or String)=any The width of the bleed area at the outside of the page. Note: Valid only when use document bleed to print is true. read-write
bleedTop Measurement Unit (Number or String)=any The height of the bleed area at the top of the page. Note: Valid only when use document bleed to print is true. read-write
changeSecurityPassword string 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. read-write
colorBars bool If true, add small squares of color representing the CMYK inks and tints of gray in 10% increments. read-write
colorBitmapCompression BitmapCompression The amount of bitmap compression to use. read-write
colorBitmapQuality CompressionQuality The compression option to apply to color images. read-write
colorBitmapSampling Sampling The sampling option to apply to color bitmap images in the PDF document. read-write
colorBitmapSamplingDPI number The ppi of the resampled image. (Range: 9 to 2400) read-write
colorTileSize number The tile size for color images. Valid only when color bitmap compression is JPEG 2000. (Range: 128 to 2048) read-write
compressTextAndLineArt bool If true, compresses text and line art using ZIP compression. read-write
compressionType PDFCompressionType The objects to compress in the PDF document. read-write
cropImagesToFrames bool If true, image data that falls outside the visible portion of an image's frame is not exported to the PDF document. read-write
cropMarks bool Prints crop marks that define where the page should be trimmed. read-write
defaultDocumentLanguage string Sets the default document language in the exported PDF. The correct ISO code of the language must be provided. read-write
disallowChanging bool If true, users cannot fill in forms, sign, extract pages, or add comments in the PDF document. Valid only when use security is true. read-write
disallowCopying bool If true, users cannot copy and paste text, images, or other content from the PDF document. Valid only when use security is true. read-write
disallowDocumentAssembly bool If true, users cannot insert, delete, or rotate pages in the PDF document. Valid only when use security is true. read-write
disallowExtractionForAccessibility bool If true, users cannot extract content from the PDF document using software tools for the visually impaired. Valid only when use security is true. read-write
disallowFormFillIn bool If true, users cannot change form fields in the PDF document. Valid only when use security is true. read-write
disallowHiResPrinting bool If true, users cannot print high-resolution copies of the PDF document. Valid only when use security is true. read-write
disallowNotes bool 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. read-write
disallowPlaintextMetadata bool 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. read-write
disallowPrinting bool If true, users cannot print the PDF document. Valid only when use security is true. read-write
effectiveOCRegistry string Effective PDF/X OC Registry. read-only
effectiveOutputCondition string Effective PDF/X output condition. read-only
effectivePDFDestinationProfile Effective destination color profile. Can return: PDFProfileSelector enumerator or String. read-only
effectivePDFXProfile Effective PDF X color profile. Can return: PDFProfileSelector enumerator or String. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
exportGuidesAndGrids bool If true, includes visible guides and baseline grids in the PDF document. read-write
exportLayers bool If true, saves each layer as an Acrobat layer within the PDF document. read-write
exportNonprintingObjects bool If true, makes non-printing objects visible in the PDF document. read-write
exportReaderSpreads bool If true, each spread in the exported document is combined into a single page that has spread's original width. read-write
exportWhichLayers ExportLayerOptions Which layers to export. read-write
generateThumbnails bool If true, generates thumbnail images for each page or spread. read-write
grayTileSize number The tile size for grayscale images. Valid only when grayscale bitmap compression is JPEG 2000. (Range: 128 to 2048) read-write
grayscaleBitmapCompression BitmapCompression The bitmap compression option to apply to grayscale bitmap images. read-write
grayscaleBitmapQuality CompressionQuality The compression option to apply to grayscale bitmap images. read-write
grayscaleBitmapSampling Sampling The sampling option to apply to grayscale bitmap images. read-write
grayscaleBitmapSamplingDPI number The ppi of the resampled image. (Range: 9 to 2400) read-write
ignoreSpreadOverrides bool If true, ignores flattener spread overrides. read-write
includeBookmarks bool 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. read-write
includeHyperlinks bool If true, includes hyperlinks when exporting the document. read-write
includeICCProfiles ICCProfiles The ICC Profiles to include in the exported PDF document. Can also accept: Boolean. read-write
includeSlugWithPDF bool If true, includes the document's slug area in the PDF document. read-write
includeStructure bool 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. read-write
interactiveElementsOption InteractiveElementsOptions How to draw interactive elements. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
monochromeBitmapCompression MonoBitmapCompression The bitmap compression option to apply to monochrome bitmap images. read-write
monochromeBitmapSampling Sampling The sampling option to apply to monochrome bitmap images. read-write
monochromeBitmapSamplingDPI number The ppi of the resampled image. (Range: 9 to 2400) read-write
ocRegistry string The web address for the output condition registry. Not valid when PDF/X-3 is the compliance standard or PDF export preset. read-write
omitBitmaps bool If true, replaces bitmap images with OPI links. read-write
omitEPS bool If true, replaces EPS images with OPI links. read-write
omitPDF bool If true, replaces PDF images with OPI links. read-write
openDocumentPassword string 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. read-write
openInFullScreen bool Open PDF in full screen mode. read-write
optimizePDF bool 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. read-write
outputCondition string 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. read-write
outputConditionName string The name of the output condition. Valid only when a PDF/X standard has been defined for the document. read-write
pageInformationMarks bool If true, prints the filename, page number, current date and time, and color separation name. read-write
pageMarksOffset Measurement Unit (Number or String)=any The offset from the edge of the page for page marks. read-write
pageRange 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. read-write
parent Application The parent of the PDFExportPreference (a Application). read-only
pdfColorSpace PDFColorSpace The color space to use to represent color information in the exported PDF document. read-write
pdfDestinationProfile The gamut of the final RGB or CMYK device. Can return: PDFProfileSelector enumerator or String. read-write
pdfDisplayTitle PdfDisplayTitleOptions The export PDF display title. read-write
pdfMagnification PdfMagnificationOptions The export PDF magnification options. read-write
pdfMarkType The type of printer marks, either an enum value or the name of a custom marks file. Can return: MarkTypes enumerator or String. read-write
pdfPageLayout PageLayoutOptions The export PDF page layout. read-write
pdfXProfile The PDF X color profile to use for the PDF document. . Can return: PDFProfileSelector enumerator or String. read-write
printerMarkWeight PDFMarkWeight The stroke weight for printer's marks. read-write
properties Object A property that allows setting of several properties at the same time. read-write
registrationMarks bool If true, prints small targets outside the page area for aligning color separations. read-write
simulateOverprint bool 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. read-write
standardsCompliance PDFXStandards The PDF/X standards compliance to test against. read-write
subsetFontsBelow number 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). read-write
thresholdToCompressColor number The minimum dpi at which color compression is applied. (Range: 1 to 10 times the value specified for color bitmap sampling DPI.) read-write
thresholdToCompressGray number The minimum dpi at which grayscale compression is applied. (Range: 1 to 10 times the value specified for grayscale bitmap sampling DPI.) read-write
thresholdToCompressMonochrome number The minimum dpi at which monochrome compression is applied. (Range: 1 to 10 times the value specified for monochrome bitmap sampling DPI.) read-write
useDocumentBleedWithPDF bool If true, uses the document's bleed settings in the PDF document. read-write
useSecurity bool If true, activates security controls for the PDF document. read-write
viewPDF bool If true, automatically opens the PDF file after exporting. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → PDFExportPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → PDFExportPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the PDFExportPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.