K4 InDesign Javascript API Documentation

PreflightRuleDataObject

A preflight rule data object.

Instance Properties

Name Description Access
dataType RuleDataType The type of data. read-only
dataValue The value for this data object. Can return: String, Real, Long Integer, Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of Strings, Reals, Long Integers, Short Integers, Booleans or Objects. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id string The ID for this rule data object. read-only
index number The index of the RuleDataObject within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the RuleDataObject. read-only
parent The parent of the RuleDataObject (a PreflightProfileRule or PreflightRuleInstance). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → RuleDataObject
remove(
)
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)
getElements(
)
  → RuleDataObject
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the RuleDataObject.
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 RuleDataObject.
toSpecifier(
)
  → string
Retrieves the object specifier.