Adobe InDesign CS5 (7.0) Object Model JS: PreflightProfileRule

InDesign CS5

Class

PreflightProfileRule

 

A preflight profile rule.

Superclass of PreflightRuleInstance

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

PreflightProfile
PreflightProfileRule
PreflightRuleInstance
Event | EventListener | MutationEvent | RuleDataObject

Properties

PropertyTypeAccessDescription
descriptionstring readonlyThe description of the PreflightProfileRule.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
flagPreflightRuleFlag:
PreflightRuleFlag.RULE_IS_DISABLED
PreflightRuleFlag.RETURN_AS_ERROR
PreflightRuleFlag.RETURN_AS_WARNING
PreflightRuleFlag.RETURN_AS_INFORMATIONAL
r/wIndicates whether or not the preflight rule is disabled, set for error, warning, or information level feedback.
idstring readonlyThe rule ID for this rule.
indexnumber readonlyThe index of the PreflightProfileRule 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 readonlyThe name of the PreflightProfileRule.
parentPreflightProfile readonlyThe parent of the PreflightProfileRule (a PreflightProfile).
propertiesObject r/wA property that allows setting of several properties at the same time.
ruleDataObjectsRuleDataObjects readonlyA collection of prefight rule data objects.

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)

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

ParameterTypeDescription
keystringThe key.

Array of PreflightProfileRule 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 PreflightProfileRule.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

RuleDataObject.parent

Used in:

PreflightProfileRule PreflightProfileRules.nextItem (obj: PreflightProfileRule)

PreflightProfileRule PreflightProfileRules.previousItem (obj: PreflightProfileRule)

Return

Array of PreflightProfileRule PreflightProfileRule.getElements ()

PreflightProfileRule PreflightProfileRules.[] (index: number)

PreflightProfileRule PreflightProfileRules.anyItem ()

Array of PreflightProfileRule PreflightProfileRules.everyItem ()

PreflightProfileRule PreflightProfileRules.firstItem ()

PreflightProfileRule PreflightProfileRules.item (index: varies)

PreflightProfileRule PreflightProfileRules.itemByID (id: number)

PreflightProfileRule PreflightProfileRules.itemByName (name: string)

Array of PreflightProfileRule PreflightProfileRules.itemByRange (from: varies, to: varies)

PreflightProfileRule PreflightProfileRules.lastItem ()

PreflightProfileRule PreflightProfileRules.middleItem ()

PreflightProfileRule PreflightProfileRules.nextItem (obj: PreflightProfileRule)

PreflightProfileRule PreflightProfileRules.previousItem (obj: PreflightProfileRule)

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