Adobe InCopy CS5 (7.0) Object Model JS: Conditions

InCopy CS5

Class

Conditions

 A collection of conditions for conditional text.

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

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

ParameterTypeDescription
indexnumberThe index.

Condition add ([withProperties: Object])
Creates a new Condition.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new Condition (Optional)

Condition anyItem ()
Returns any Condition in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromCondition
Long Integer
String
The Condition, index, or name at the beginning of the range. Can accept: Condition, Long Integer or String.
toCondition
Long Integer
String
The Condition, index, or name at the end of the range. Can accept: Condition, Long Integer or String.

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

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

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

ParameterTypeDescription
objConditionThe Condition whose index comes before the desired Condition.

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

ParameterTypeDescription
objConditionThe index of the Condition that follows the desired Condition.

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

Element of

Application.conditions

ChangeGrepPreference.appliedConditions

ChangeTextPreference.appliedConditions

Document.conditions

FindGrepPreference.appliedConditions

FindTextPreference.appliedConditions

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