K4 InDesign Javascript API Documentation

TextCondition

A condition for conditional text.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the Condition. read-only
index number The index of the Condition within its containing object. read-only
indicatorColor 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. read-write
indicatorMethod ConditionIndicatorMethod The condition indicator method. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the Condition. read-write
parent The parent of the Condition (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
underlineIndicatorAppearance ConditionUnderlineIndicatorAppearance The condition underline indicator appearance. read-write
visible bool If true, the Condition is visible. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → Condition
insertLabel(
key, value)
remove(
replacingWith)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Condition
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
replacingWith)
Delete the condition.
replacingWith 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)
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Condition.
toSpecifier(
)
  → string
Retrieves the object specifier.