InDesign Server2025
API 20.5.0.49
Object

Condition

A condition for conditional text.

Hierarchy

Application | Document

Condition

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the Condition.
Number readonly The index of the Condition within its containing object.
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write 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.
ConditionIndicatorMethod
read/write The condition indicator method.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the Condition.
Application | Document readonly The parent of the Condition (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.
ConditionUnderlineIndicatorAppearance
read/write The condition underline indicator appearance.
Boolean read/write If true, the Condition is visible.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

Gets the label value associated with the specified key.

key String The key.
Condition[]

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

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
void

Delete the condition.

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

Removes the event listener.

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

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

String

Retrieves the object specifier.

Object of 11

Properties elsewhere that hold a Condition.

Parameter of 12

Method parameters that accept a Condition.

Return 14

Methods that return a Condition.