PreflightProcess
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| aggregatedResults | description:String Array of Ordered array containing label:String errorInfo:String errorName:String Ordered array containing documentName:String pageNumber:String profileName:String Array of 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. |
| appliedProfile | PreflightProfile | readonly | The preflight profile the process is using. |
| description | string | readonly | The description of the PreflightProcess. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| index | number | readonly | The index of the PreflightProcess within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Application | readonly | The parent of the PreflightProcess (a Application). |
| processInventory | string | readonly | A string containing a description of all elements visited by the process. |
| processResults | string | readonly | The results found by the process as a large string. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| targetObject | Document | readonly | The target document the process is inspecting. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of PreflightProcess getElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the PreflightProcess.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void saveReport (to:
File[, autoOpen:
bool=false])
Saves a report of the completed preflight process.
| Parameter | Type | Description |
|---|---|---|
| to | File | The preflight report to save to. |
| autoOpen | bool | 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.
bool 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 | number | The maximum time to wait, in seconds; if omitted, waits until completion no matter how long it takes. (Optional) |
Element of
Document.activeProcess
Used in:
PreflightProcess PreflightProcesses.nextItem (obj: PreflightProcess)
PreflightProcess PreflightProcesses.previousItem (obj: PreflightProcess)
Return
Array of PreflightProcess PreflightProcess.getElements ()
PreflightProcess PreflightProcesses.[] (index: number)
PreflightProcess PreflightProcesses.add (targetObject: Document, appliedProfile: PreflightProfile[, preflightOptions: PreflightOption][, withProperties: Object])
PreflightProcess PreflightProcesses.anyItem ()
Array of PreflightProcess PreflightProcesses.everyItem ()
PreflightProcess PreflightProcesses.firstItem ()
PreflightProcess PreflightProcesses.item (index: varies)
Array of PreflightProcess PreflightProcesses.itemByRange (from: varies, to: varies)
PreflightProcess PreflightProcesses.lastItem ()
PreflightProcess PreflightProcesses.middleItem ()
PreflightProcess PreflightProcesses.nextItem (obj: PreflightProcess)
PreflightProcess PreflightProcesses.previousItem (obj: PreflightProcess)
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |