PreflightProfile

A preflight profile.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, PreflightProfileRules, PreflightRuleInstances, String

Property Listing

Property

Type

Access

Description

description

String

read/write

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

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

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

read/write

A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

PreflightProfile getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined remove ()

Deletes the PreflightProfile.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined 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.

undefined unembed ()

Unembed this profile.

undefined update (using:Varies String PreflightProfile)

Update the preflight profile by copying from another profile.

Parameter

Type

Description

using

String

PreflightProfile

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

Object of

Event.parent

EventListener.parent

MutationEvent.parent

PreflightProfileRule.parent

PreflightRuleInstance.parent

PreflightProcess.appliedProfile

PreflightOption.preflightWorkingProfile

PreflightBookOption.preflightWorkingProfile

Return

PreflightProfiles.add()

PreflightProfile.duplicate()

Document.embed()

Application.loadPreflightProfile()

PreflightProfile.getElements()

PreflightProfiles.anyItem()

PreflightProfiles.everyItem()

PreflightProfiles.nextItem()

PreflightProfiles.previousItem()

PreflightProfiles.itemByID()

PreflightProfiles.item()

PreflightProfiles.[]()

PreflightProfiles.itemByName()

PreflightProfiles.itemByRange()

PreflightProfiles.firstItem()

PreflightProfiles.lastItem()

PreflightProfiles.middleItem()