K4 InDesign Javascript API Documentation

TextConditionSet

A condition set 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 ConditionSet. read-only
index number The index of the ConditionSet within its containing object. read-only
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 ConditionSet. read-write
parent The parent of the ConditionSet (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
setConditions List of conditions and visibilities in the set. Can return: Ordered array containing condition:Condition, visibility:Boolean. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → ConditionSet
insertLabel(
key, value)
redefine(
)
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(
)
  → ConditionSet
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.
redefine(
)
Redefine a condition set with the currently existing conditions and visibilities.
remove(
replacingWith)
Delete a condition set for conditional text.
replacingWith 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)
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 ConditionSet.
toSpecifier(
)
  → string
Retrieves the object specifier.