Adobe InCopy CS5 (7.0) Object Model JS: ConditionSets

InCopy CS5

Class

ConditionSets

 A collection of condition sets 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

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

ParameterTypeDescription
indexnumberThe index.

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

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

ConditionSet anyItem ()
Returns any ConditionSet in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromConditionSet
Long Integer
String
The ConditionSet, index, or name at the beginning of the range. Can accept: ConditionSet, Long Integer or String.
toConditionSet
Long Integer
String
The ConditionSet, index, or name at the end of the range. Can accept: ConditionSet, Long Integer or String.

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

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

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

ParameterTypeDescription
objConditionSetThe ConditionSet whose index comes before the desired ConditionSet.

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

ParameterTypeDescription
objConditionSetThe index of the ConditionSet that follows the desired ConditionSet.

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

Element of

Application.conditionSets

Document.conditionSets

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