Adobe InCopy CS5 (7.0) Object Model JS: ConditionSet

InCopy CS5

Class

ConditionSet

 A condition set for conditional text.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, redefine, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
ConditionSet
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the ConditionSet.
indexnumber readonlyThe index of the ConditionSet within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the ConditionSet.
parentApplicationDocument readonlyThe parent of the ConditionSet (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
setConditions Array of
Ordered array containing condition:Condition
visibility:Boolean
r/wList of conditions and visibilities in the set. Can return: Ordered array containing condition:Condition, visibility:Boolean.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

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

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void redefine ()
Redefine a condition set with the currently existing conditions and visibilities.

void remove ([replacingWith: varies])
Delete a condition set for conditional text.

ParameterTypeDescription
replacingWithConditionSet
String
The condition set to apply to the text in place of the deleted condition set. By default, no condition set is applied in place of the deleted condition set. Can accept: ConditionSet or String. (Optional)

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

ConditionalTextPreference.activeConditionSet

Used in:

ConditionSet ConditionSets.nextItem (obj: ConditionSet)

ConditionSet ConditionSets.previousItem (obj: ConditionSet)

Return

Array of ConditionSet ConditionSet.getElements ()

ConditionSet ConditionSets.[] (index: number)

ConditionSet ConditionSets.add ([withProperties: Object])

ConditionSet ConditionSets.anyItem ()

Array of ConditionSet ConditionSets.everyItem ()

ConditionSet ConditionSets.firstItem ()

ConditionSet ConditionSets.item (index: varies)

ConditionSet ConditionSets.itemByID (id: number)

ConditionSet ConditionSets.itemByName (name: string)

Array of ConditionSet ConditionSets.itemByRange (from: varies, to: varies)

ConditionSet ConditionSets.lastItem ()

ConditionSet ConditionSets.middleItem ()

ConditionSet ConditionSets.nextItem (obj: ConditionSet)

ConditionSet ConditionSets.previousItem (obj: ConditionSet)

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