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

Property	Type	Access	Description
description	string	r/w	The description of the PreflightProfile.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the PreflightProfile.
index	number	readonly	The index of the PreflightProfile within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the PreflightProfile.
parent	Application Document	readonly	The parent of the PreflightProfile (a Application or Document).
preflightProfileRules	PreflightProfileRules PreflightProfileRule	readonly	A collection of preflight profile rules.
preflightRuleInstances	PreflightRuleInstances PreflightRuleInstance	readonly	A collection of preflight rule instances.
properties	Object	r/w	A 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.

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)

PreflightProfile duplicate ()
Duplicates the PreflightProfile.

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

Parameter	Type	Description
key	string	The 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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove ()
Deletes the PreflightProfile.

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

Parameter	Type	Description
to	File	The 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.

Parameter	Type	Description
using	PreflightProfile 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, 28-Apr-2012 v3.0.3i

Contents :: Index