ConditionSet

A condition set for conditional text.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, String,

Property Listing

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

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the ConditionSet.

parent

Application

Document

readonly

The parent of the ConditionSet (a Application or Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

setConditions

Array of Orderedarraycontainingcondition:Condition

Array of Visibility:Boolean

read/write

List of conditions and visibilities in the set. Can return: Ordered array containing condition:Condition, visibility:Boolean.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

ConditionSet getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined redefine ()

Redefine a condition set with the currently existing conditions and visibilities.

undefined remove (replacingWith:Varies ConditionSet String)

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)

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

ConditionalTextPreference.activeConditionSet

Event.parent

EventListener.parent

MutationEvent.parent

Return

ConditionSets.add()

ConditionSet.getElements()

ConditionSets.anyItem()

ConditionSets.everyItem()

ConditionSets.nextItem()

ConditionSets.previousItem()

ConditionSets.itemByID()

ConditionSets.item()

ConditionSets.[]()

ConditionSets.itemByName()

ConditionSets.itemByRange()

ConditionSets.firstItem()

ConditionSets.lastItem()

ConditionSets.middleItem()