K4 InDesign Javascript API Documentation

PreflightPreflightProcess

An active preflight process.

Instance Properties

Name Description Access
aggregatedResults The aggregated results found by the process. Can return: Ordered array containing documentName:String, profileName:String, results:Array of Ordered array containing parentNodeID:Long Integer, errorName:String, pageNumber:String, errorInfo:String, errorDetail:Array of Ordered array containing label:String, description:String. read-only
appliedProfile PreflightProfile The preflight profile the process is using. read-only
description string The description of the PreflightProcess. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the PreflightProcess within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent Application The parent of the PreflightProcess (a Application). read-only
processInventory string A string containing a description of all elements visited by the process. read-only
processResults string The results found by the process as a large string. read-only
properties Object A property that allows setting of several properties at the same time. read-write
targetObject Document The target document the process is inspecting. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → PreflightProcess
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
saveReport(
to ​[, autoOpen])
toSource(
)
  → string
toSpecifier(
)
  → string
waitForProcess(
[waitTime])
  → bool
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(
)
  → PreflightProcess
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the PreflightProcess.
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)
saveReport(
to ​[, autoOpen=false])
Saves a report of the completed preflight process.
to File The preflight report to save to.
autoOpen bool If true, automatically open the report after creation. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the PreflightProcess.
toSpecifier(
)
  → string
Retrieves the object specifier.
waitForProcess(
[waitTime])
  → bool
Waits for the process to finish, up to an optional maximum amount of time. No other processes get cycles during this time.
waitTime number The maximum time to wait, in seconds; if omitted, waits until completion no matter how long it takes. (Optional)