Adobe InDesign CS6 (8.0) Object Model JS: RuleDataObjects

InDesign CS6

Class

RuleDataObjects

 A collection of prefight rule data objects.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

RuleDataObject [] (index: number)
Returns the RuleDataObject with the specified index.

ParameterTypeDescription
indexnumberThe index.

RuleDataObject add (name: string, dataType: RuleDataType, dataValue: varies[, withProperties: Object])
Add a new preflight rule data to a preflight profile rule.

ParameterTypeDescription
namestringThe name of the rule data to add
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
The 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
The value of data. Can accept: 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.
withPropertiesObjectInitial values for properties of the new RuleDataObject (Optional)

RuleDataObject anyItem ()
Returns any RuleDataObject in the collection.

number count ()
Displays the number of elements in the RuleDataObject.

Array of RuleDataObject everyItem ()
Returns every RuleDataObject in the collection.

RuleDataObject firstItem ()
Returns the first RuleDataObject in the collection.

RuleDataObject item (index: varies)
Returns the RuleDataObject with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

RuleDataObject itemByID (id: number)
Returns the RuleDataObject with the specified ID.

ParameterTypeDescription
idnumberThe ID.

RuleDataObject itemByName (name: string)
Returns the RuleDataObject with the specified name.

ParameterTypeDescription
namestringThe name.

Array of RuleDataObject itemByRange (from: varies, to: varies)
Returns the RuleDataObjects within the specified range.

ParameterTypeDescription
fromLong Integer
RuleDataObject
String
The RuleDataObject, index, or name at the beginning of the range. Can accept: RuleDataObject, Long Integer or String.
toLong Integer
RuleDataObject
String
The RuleDataObject, index, or name at the end of the range. Can accept: RuleDataObject, Long Integer or String.

RuleDataObject lastItem ()
Returns the last RuleDataObject in the collection.

RuleDataObject middleItem ()
Returns the middle RuleDataObject in the collection.

RuleDataObject nextItem (obj: RuleDataObject)
Returns the RuleDataObject whose index follows the specified RuleDataObject in the collection.

ParameterTypeDescription
objRuleDataObjectThe RuleDataObject whose index comes before the desired RuleDataObject.

RuleDataObject previousItem (obj: RuleDataObject)
Returns the RuleDataObject with the index previous to the specified index.

ParameterTypeDescription
objRuleDataObjectThe index of the RuleDataObject that follows the desired RuleDataObject.

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

Element of

PreflightProfileRule.ruleDataObjects

PreflightRuleInstance.ruleDataObjects

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