K4 InDesign Javascript API Documentation

PreferencesPDFPlacePreference

PDF place preferences.

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
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
pageNumber number The page number of the PDF document page to place. read-write
parent Application The parent of the PDFPlacePreference (a Application). read-only
pdfCrop PDFCrop The type of cropping to apply. read-write
properties Object A property that allows setting of several properties at the same time. read-write
transparentBackground bool If true, the background of the PDF is transparent. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → PDFPlacePreference
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(
)
  → PDFPlacePreference
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 PDFPlacePreference.
toSpecifier(
)
  → string
Retrieves the object specifier.