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

InDesign Server CS5

Class

PreflightProfile

 A preflight profile.

QuickLinks

addEventListener, duplicate, extractLabel, getElements, insertLabel, remove, removeEventListener, save, toSource, toSpecifier, unembed, update

Hierarchy

Application | Document
PreflightProfile
Event | EventListener | MutationEvent | PreflightProfileRule | PreflightRuleInstance

Properties

PropertyTypeAccessDescription
descriptionstring r/wThe description of the PreflightProfile.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the PreflightProfile.
indexnumber readonlyThe index of the PreflightProfile within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the PreflightProfile.
parentApplicationDocument readonlyThe parent of the PreflightProfile (a Application or Document).
preflightProfileRulesPreflightProfileRules readonlyA collection of preflight profile rules.
preflightRuleInstancesPreflightRuleInstances readonlyA collection of preflight rule instances.
propertiesObject r/wA property that allows setting of several properties at the same time.

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)

PreflightProfile duplicate ()
Duplicates the PreflightProfile.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of PreflightProfile getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the PreflightProfile.

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 save (to: File)
Saves this preflight profile to a InDesign preflight profile file.

ParameterTypeDescription
toFileThe preflight profile file to save to.

string toSource ()
Generates a string which, if executed, will return the PreflightProfile.

string toSpecifier ()
Retrieves the object specifier.

void unembed ()
Unembed this profile.

void update ([using: varies])
Update the preflight profile by copying from another profile.

ParameterTypeDescription
usingPreflightProfile
String
The preflight profile to copy. Can accept: String or PreflightProfile. (Optional)

Element of

PreflightBookOption.preflightWorkingProfile

PreflightOption.preflightWorkingProfile

PreflightProcess.appliedProfile

PreflightProfileRule.parent

PreflightRuleInstance.parent

Used in:

PreflightProcess PreflightProcesses.add (targetObject: Document, appliedProfile: PreflightProfile[, preflightOptions: PreflightOption][, withProperties: Object])

PreflightProfile PreflightProfiles.nextItem (obj: PreflightProfile)

PreflightProfile PreflightProfiles.previousItem (obj: PreflightProfile)

Return

PreflightProfile Application.loadPreflightProfile (from: File)

PreflightProfile Document.embed (using: varies)

PreflightProfile PreflightProfile.duplicate ()

Array of PreflightProfile PreflightProfile.getElements ()

PreflightProfile PreflightProfiles.[] (index: number)

PreflightProfile PreflightProfiles.add ([withProperties: Object])

PreflightProfile PreflightProfiles.anyItem ()

Array of PreflightProfile PreflightProfiles.everyItem ()

PreflightProfile PreflightProfiles.firstItem ()

PreflightProfile PreflightProfiles.item (index: varies)

PreflightProfile PreflightProfiles.itemByID (id: number)

PreflightProfile PreflightProfiles.itemByName (name: string)

Array of PreflightProfile PreflightProfiles.itemByRange (from: varies, to: varies)

PreflightProfile PreflightProfiles.lastItem ()

PreflightProfile PreflightProfiles.middleItem ()

PreflightProfile PreflightProfiles.nextItem (obj: PreflightProfile)

PreflightProfile PreflightProfiles.previousItem (obj: PreflightProfile)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index