K4 InDesign Javascript API Documentation

PreflightPreflightRuleInstance

A preflight rule instance.

Extends

Instance Properties

Name Description Access
description string The description of the PreflightRuleInstance. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
flag PreflightRuleFlag Indicates whether or not the preflight rule is disabled, set for error, warning, or information level feedback. read-write
id string The rule ID for this rule. read-only
index number The index of the PreflightRuleInstance 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 PreflightRuleInstance. read-only
parent PreflightProfile The parent of the PreflightRuleInstance (a PreflightProfile). read-only
properties Object A property that allows setting of several properties at the same time. read-write
ruleDataObjects RuleDataObjects A collection of prefight rule data objects. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → PreflightRuleInstance
insertLabel(
key, value)
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)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → PreflightRuleInstance
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(
)
Deletes the PreflightRuleInstance.
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 PreflightRuleInstance.
toSpecifier(
)
  → string
Retrieves the object specifier.