K4 InDesign Javascript API Documentation

PreferencesPreflightBookOption

Preflight book options.

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
parent The parent of the PreflightBookOption (a Application or Book). read-only
preflightIncludeNonprintingObjects bool If true, include objects that do not print when preflighting. read-write
preflightIncludeObjectsOnPasteboard bool If true, include objects on pasteboard when preflighting. read-write
preflightProfilePolicy PreflightProfileOptions The policy for preflighting applied when opening a document or book, whether to use embedded profile or the another profile when the preflight is turned on. read-write
preflightScope The pages or documents to preflight, 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: PreflightScopeOptions enumerator or String. read-write
preflightWhichLayers PreflightLayerOptions Which layers to preflight. read-write
preflightWorkingProfile The working preflight profile. Can return: PreflightProfile or String. read-write
properties Object A property that allows setting of several properties at the same time. read-write

Methods

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