PreflightProcess
An active preflight process.
Go to Property Listing | Method Listing
Methods:
addEventListener, getElements, remove, removeEventListener, saveReport, toSource, toSpecifier, waitForProcess
Property Listing
Property |
Type |
Access |
Description |
---|---|---|---|
OrderedarraycontainingdocumentName:String Description:String Array of errorDetail:Ordered array containing label:String ErrorInfo:String ErrorName:String PageNumber:String ProfileName:String Array of results:Ordered array containing parentNodeID:Long Integer |
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. |
|
readonly |
The preflight profile the process is using. |
||
readonly |
The description of the PreflightProcess. |
||
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
readonly |
The index of the PreflightProcess within its containing object. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
readonly |
The parent of the PreflightProcess (a Application). |
||
readonly |
A string containing a description of all elements visited by the process. |
||
readonly |
The results found by the process as a large string. |
||
read/write |
A property that allows setting of several properties at the same time. |
||
readonly |
The target document the process is inspecting. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
PreflightProcess getElements ()
Resolves the object specifier, creating an array of object references.
undefined remove ()
Deletes the PreflightProcess.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined saveReport (to:File, [autoOpen:Boolean=Boolean])
Saves a report of the completed preflight process.
Parameter |
Type |
Description |
---|---|---|
to |
The preflight report to save to. |
|
autoOpen |
If true, automatically open the report after creation. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the PreflightProcess.
String toSpecifier ()
Retrieves the object specifier.
Boolean waitForProcess (waitTime:Number)
Waits for the process to finish, up to an optional maximum amount of time. No other processes get cycles during this time.
Parameter |
Type |
Description |
---|---|---|
waitTime |
The maximum time to wait, in seconds; if omitted, waits until completion no matter how long it takes. (Optional) |
Object of
Document.activeProcess
Event.parent
EventListener.parent
MutationEvent.parent
Return
PreflightProcess.getElements()
PreflightProcesses.everyItem()
PreflightProcesses.previousItem()
PreflightProcesses.itemByRange()