Adobe InDesign CS6 Server (8.0) Object Model JS: PreflightRuleInstance

InDesign Server CS6

Class

PreflightRuleInstance

 A preflight rule instance. Base Class: PreflightProfileRule

QuickLinks

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

Hierarchy

PreflightProfile
PreflightProfileRule
PreflightRuleInstance
Event | EventListener | MutationEvent | RuleDataObject

Properties

PropertyTypeAccessDescription
descriptionstring readonlyThe description of the PreflightRuleInstance.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event 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 PreflightRuleInstance 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 PreflightRuleInstance.
parentPreflightProfile readonlyThe parent of the PreflightRuleInstance (a PreflightProfile).
propertiesObject r/wA property that allows setting of several properties at the same time.
ruleDataObjectsRuleDataObjects RuleDataObject 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 PreflightRuleInstance 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 PreflightRuleInstance.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

RuleDataObject.parent

Used in:

PreflightRuleInstance PreflightRuleInstances.nextItem (obj: PreflightRuleInstance)

PreflightRuleInstance PreflightRuleInstances.previousItem (obj: PreflightRuleInstance)

Return

Array of PreflightRuleInstance PreflightRuleInstance.getElements ()

PreflightRuleInstance PreflightRuleInstances.[] (index: number)

PreflightRuleInstance PreflightRuleInstances.anyItem ()

Array of PreflightRuleInstance PreflightRuleInstances.everyItem ()

PreflightRuleInstance PreflightRuleInstances.firstItem ()

PreflightRuleInstance PreflightRuleInstances.item (index: varies)

PreflightRuleInstance PreflightRuleInstances.itemByID (id: number)

PreflightRuleInstance PreflightRuleInstances.itemByName (name: string)

Array of PreflightRuleInstance PreflightRuleInstances.itemByRange (from: varies, to: varies)

PreflightRuleInstance PreflightRuleInstances.lastItem ()

PreflightRuleInstance PreflightRuleInstances.middleItem ()

PreflightRuleInstance PreflightRuleInstances.nextItem (obj: PreflightRuleInstance)

PreflightRuleInstance PreflightRuleInstances.previousItem (obj: PreflightRuleInstance)

Jongware, 28-Apr-2012 v3.0.3iContents :: Index