Class

Condition

A condition for conditional text.

QuickLinks

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

Hierarchy

Application | Document

Condition

Event | EventListener | MutationEvent

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 Condition.
index	number	readonly	The index of the Condition within its containing object.
indicatorColor	3 Reals (0 - 255) UIColors	r/w	The color for the condition indicator; specified either as an array of three doubles representing RGB values in the range 0 to 255, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
indicatorMethod	ConditionIndicatorMethod: ConditionIndicatorMethod.USE_UNDERLINE ConditionIndicatorMethod.USE_HIGHLIGHT	r/w	The condition indicator method.
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 Condition.
parent	Application Document	readonly	The parent of the Condition (a Application or Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
underlineIndicatorAppearance	ConditionUnderlineIndicatorAppearance: ConditionUnderlineIndicatorAppearance.WAVY ConditionUnderlineIndicatorAppearance.SOLID ConditionUnderlineIndicatorAppearance.DASHED	r/w	The condition underline indicator appearance.
visible	bool	r/w	If true, the Condition is visible.

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 Condition 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 remove ([replacingWith: varies])
Delete the condition.

Parameter	Type	Description
replacingWith	Condition String	The condition to apply to text in place of the deleted condition. By default, no condition is applied in place of the deleted condition. Can accept: Condition 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 Condition.

string toSpecifier ()
Retrieves the object specifier.

Element of

Character.appliedConditions

InsertionPoint.appliedConditions

Line.appliedConditions

Paragraph.appliedConditions

Text.appliedConditions

TextColumn.appliedConditions

TextStyleRange.appliedConditions

Word.appliedConditions

Used in:

void Character.applyConditions (using: Array of Condition[, removeExisting: bool=false])

Condition Conditions.nextItem (obj: Condition)

Condition Conditions.previousItem (obj: Condition)

void InsertionPoint.applyConditions (using: Array of Condition[, removeExisting: bool=false])

void Line.applyConditions (using: Array of Condition[, removeExisting: bool=false])

void Paragraph.applyConditions (using: Array of Condition[, removeExisting: bool=false])

void Text.applyConditions (using: Array of Condition[, removeExisting: bool=false])

void TextColumn.applyConditions (using: Array of Condition[, removeExisting: bool=false])

void TextStyleRange.applyConditions (using: Array of Condition[, removeExisting: bool=false])

void Word.applyConditions (using: Array of Condition[, removeExisting: bool=false])

Return

Array of Condition Condition.getElements ()

Condition Conditions.[] (index: number)

Condition Conditions.add ([withProperties: Object])

Condition Conditions.anyItem ()

Array of Condition Conditions.everyItem ()

Condition Conditions.firstItem ()

Condition Conditions.item (index: varies)

Condition Conditions.itemByID (id: number)

Condition Conditions.itemByName (name: string)

Array of Condition Conditions.itemByRange (from: varies, to: varies)

Condition Conditions.lastItem ()

Condition Conditions.middleItem ()

Condition Conditions.nextItem (obj: Condition)

Condition Conditions.previousItem (obj: Condition)

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index