ConditionSet
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| id | number | readonly | The unique ID of the ConditionSet. |
| index | number | readonly | The index of the ConditionSet within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the ConditionSet. |
| parent | ApplicationDocument | readonly | The parent of the ConditionSet (a Application or Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| setConditions |
Array
of Ordered array containing condition:Condition visibility:Boolean |
r/w | List 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The 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.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The 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.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | ConditionSet 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the ConditionSet.
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, 29-Apr-2012 v3.0.3i | Contents :: Index |