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

InDesign Server CS5

Class

PreflightProfileRules

 A collection of preflight profile rules.

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

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

ParameterTypeDescription
indexnumberThe index.

any add (id: string[, withProperties: Object])
Adds a new preflight rule to the profile.

ParameterTypeDescription
idstringThe ID of the rule to be added
withPropertiesObjectInitial values for properties of the new PreflightProfileRule (Optional)

PreflightProfileRule anyItem ()
Returns any PreflightProfileRule in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objPreflightProfileRuleThe PreflightProfileRule whose index comes before the desired PreflightProfileRule.

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

ParameterTypeDescription
objPreflightProfileRuleThe index of the PreflightProfileRule that follows the desired PreflightProfileRule.

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

Element of

PreflightProfile.preflightProfileRules

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