Adobe InDesign CS5 (7.0) Object Model JS: PreflightRule

InDesign CS5

Class

PreflightRule

 A preflight rule

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
PreflightRule
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
descriptionstring readonlyThe description of the PreflightRule.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fullFeaturebool r/wIf true, the preflight rule is fully supported.
idstring readonlyThe rule ID for this rule.
indexnumber readonlyThe index of the PreflightRule within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring readonlyThe name of the PreflightRule.
parentApplication readonlyThe parent of the PreflightRule (a Application).
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)

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

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)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

PreflightRule PreflightRules.nextItem (obj: PreflightRule)

PreflightRule PreflightRules.previousItem (obj: PreflightRule)

Return

Array of PreflightRule PreflightRule.getElements ()

PreflightRule PreflightRules.[] (index: number)

PreflightRule PreflightRules.anyItem ()

Array of PreflightRule PreflightRules.everyItem ()

PreflightRule PreflightRules.firstItem ()

PreflightRule PreflightRules.item (index: varies)

PreflightRule PreflightRules.itemByID (id: number)

PreflightRule PreflightRules.itemByName (name: string)

Array of PreflightRule PreflightRules.itemByRange (from: varies, to: varies)

PreflightRule PreflightRules.lastItem ()

PreflightRule PreflightRules.middleItem ()

PreflightRule PreflightRules.nextItem (obj: PreflightRule)

PreflightRule PreflightRules.previousItem (obj: PreflightRule)

Jongware, 20-Jun-2010 v3.0.3dContents :: Index