Adobe InDesign CS5 Server (7.0) Object Model JS: PreflightProcess

InDesign Server CS5

Class

PreflightProcess

 An active preflight process.

QuickLinks

addEventListener, getElements, remove, removeEventListener, saveReport, toSource, toSpecifier, waitForProcess

Hierarchy

Application
PreflightProcess
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
aggregatedResultsdescription: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
readonlyThe 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.
appliedProfilePreflightProfile readonlyThe preflight profile the process is using.
descriptionstring readonlyThe description of the PreflightProcess.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the PreflightProcess within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication readonlyThe parent of the PreflightProcess (a Application).
processInventorystring readonlyA string containing a description of all elements visited by the process.
processResultsstring readonlyThe results found by the process as a large string.
propertiesObject r/wA property that allows setting of several properties at the same time.
targetObjectDocument readonlyThe target document the process is inspecting.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void saveReport (to: File[, autoOpen: bool=false])
Saves a report of the completed preflight process.

ParameterTypeDescription
toFileThe preflight report to save to.
autoOpenboolIf 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.

ParameterTypeDescription
waitTimenumberThe 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.3dContents :: Index