K4 InDesign Javascript API Documentation

XMLXMLRuleProcessor

An XML rule processor.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
halted bool If true, the XML rule process has halted. read-only
id number The unique ID of the XMLRuleProcessor. read-only
index number The index of the XMLRuleProcessor 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 XMLRuleProcessor; this is an alias to the XMLRuleProcessor's label property. read-write
parent Application The parent of the XMLRuleProcessor (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
rulePaths string The XPath condition paths of the rules in the rule set. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
endProcessingRuleSet(
)
extractLabel(
key)
  → string
findNextMatch(
)
  → XMLRuleMatchData
getElements(
)
  → XMLRuleProcessor
halt(
)
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
skipChildren(
)
startProcessingRuleSet(
initialElement)
  → XMLRuleMatchData
startProcessingSubtree(
)
  → XMLRuleMatchData
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)
endProcessingRuleSet(
)
Stop processing XML rule set.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
findNextMatch(
)
  → XMLRuleMatchData
Finds the next matching XML element.
getElements(
)
  → XMLRuleProcessor
Resolves the object specifier, creating an array of object references.
halt(
)
Halt the XML rule processor.
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 XMLRuleProcessor.
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)
skipChildren(
)
Do not process XML elements (children) of the current XML element.
startProcessingRuleSet(
initialElement)
  → XMLRuleMatchData
Start processing an XML rule set.
initialElement XMLElement The XML element at which to start processing the rule set.
startProcessingSubtree(
)
  → XMLRuleMatchData
Process the XML elements of the current XML element.
toSource(
)
  → string
Generates a string which, if executed, will return the XMLRuleProcessor.
toSpecifier(
)
  → string
Retrieves the object specifier.