Adobe InDesign CS4 (6.0) Object Model JS: RuleDataObject

InDesign CS4

Class

RuleDataObject

 A preflight rule data object.

QuickLinks

getElements, remove, toSource, toSpecifier

Hierarchy

PreflightProfileRule | PreflightRuleInstance
RuleDataObject

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

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

void remove ()
Deletes the RuleDataObject.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of RuleDataObject RuleDataObjects.itemByRange (from: any, to: any)

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: any[, withProperties: Object])

RuleDataObject RuleDataObjects.anyItem ()

Array of RuleDataObject RuleDataObjects.everyItem ()

RuleDataObject RuleDataObjects.firstItem ()

RuleDataObject RuleDataObjects.item (index: any)

RuleDataObject RuleDataObjects.itemByName (name: string)

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

RuleDataObject RuleDataObjects.lastItem ()

RuleDataObject RuleDataObjects.middleItem ()

RuleDataObject RuleDataObjects.nextItem (obj: RuleDataObject)

RuleDataObject RuleDataObjects.previousItem (obj: RuleDataObject)

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