Adobe InDesign CS5 Server (7.0) Object Model JS: RuleDataObject

InDesign Server CS5

Class

RuleDataObject

 A preflight rule data object.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

PreflightProfileRule | PreflightRuleInstance
RuleDataObject
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
dataTypeRuleDataType:
RuleDataType.INTEGER_DATA_TYPE
RuleDataType.SHORT_INTEGER_DATA_TYPE
RuleDataType.REAL_DATA_TYPE
RuleDataType.STRING_DATA_TYPE
RuleDataType.BOOLEAN_DATA_TYPE
RuleDataType.OBJECT_DATA_TYPE
RuleDataType.LIST_DATA_TYPE
readonlyThe type of data.
dataValue Array of Strings
Array of Array of Strings
Boolean
Booleans
Booleans
Long Integer
Long Integers
Long Integers
Object
Objects
Objects
Real
Reals
Reals
Short Integer
Short Integers
Short Integers
String
r/wThe value for this data object. Can return: String, Real, Long Integer, Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of Strings, Reals, Long Integers, Short Integers, Booleans or Objects.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idstring readonlyThe ID for this rule data object.
indexnumber readonlyThe index of the RuleDataObject within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring readonlyThe name of the RuleDataObject.
parentPreflightProfileRule
PreflightRuleInstance
readonlyThe parent of the RuleDataObject (a PreflightProfileRule or PreflightRuleInstance).
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 RuleDataObject getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the RuleDataObject.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

RuleDataObject RuleDataObjects.nextItem (obj: RuleDataObject)

RuleDataObject RuleDataObjects.previousItem (obj: RuleDataObject)

Return

Array of RuleDataObject RuleDataObject.getElements ()

RuleDataObject RuleDataObjects.[] (index: number)

RuleDataObject RuleDataObjects.add (name: string, dataType: RuleDataType, dataValue: varies[, withProperties: Object])

RuleDataObject RuleDataObjects.anyItem ()

Array of RuleDataObject RuleDataObjects.everyItem ()

RuleDataObject RuleDataObjects.firstItem ()

RuleDataObject RuleDataObjects.item (index: varies)

RuleDataObject RuleDataObjects.itemByID (id: number)

RuleDataObject RuleDataObjects.itemByName (name: string)

Array of RuleDataObject RuleDataObjects.itemByRange (from: varies, to: varies)

RuleDataObject RuleDataObjects.lastItem ()

RuleDataObject RuleDataObjects.middleItem ()

RuleDataObject RuleDataObjects.nextItem (obj: RuleDataObject)

RuleDataObject RuleDataObjects.previousItem (obj: RuleDataObject)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index