InDesign Server2025
API 20.5.0.49
Object

PreflightProcess

An active preflight process.

Hierarchy

Application

PreflightProcess

Properties

NameType AccessDescription
Array[] | String[] | Array[] | String[] | String[] | String[] | String[] | Array[] readonly 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.
PreflightProfile readonly The preflight profile the process is using.
String readonly The description of the PreflightProcess.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The index of the PreflightProcess within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Application readonly The parent of the PreflightProcess (a Application).
String readonly A string containing a description of all elements visited by the process.
String readonly The results found by the process as a large string.
Object read/write A property that allows setting of several properties at the same time.
Document readonly The target document the process is inspecting.

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.
PreflightProcess[]

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

void

Deletes the PreflightProcess.

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

Saves a report of the completed preflight process.

to File The preflight report to save to.
autoOpen? Boolean If true, automatically open the report after creation.
String

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

String

Retrieves the object specifier.

Boolean

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.

Object of 4

Properties elsewhere that hold a PreflightProcess.

Parameter of 3

Method parameters that accept a PreflightProcess.

Return 12

Methods that return a PreflightProcess.