K4 InDesign Javascript API Documentation

XMLXMLRuleProcessors

A collection of XML rule processors.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
rulePaths, prefixMappingTable ​[, withProperties])
  → XMLRuleProcessor
anyItem(
)
  → XMLRuleProcessor
count(
)
  → number
everyItem(
)
  → XMLRuleProcessor
firstItem(
)
  → XMLRuleProcessor
item(
index)
  → XMLRuleProcessor
itemByID(
id)
  → XMLRuleProcessor
itemByName(
name)
  → XMLRuleProcessor
itemByRange(
from, to)
  → XMLRuleProcessor
lastItem(
)
  → XMLRuleProcessor
middleItem(
)
  → XMLRuleProcessor
nextItem(
obj)
  → XMLRuleProcessor
previousItem(
obj)
  → XMLRuleProcessor
toSource(
)
  → string
add(
rulePaths, prefixMappingTable ​[, withProperties])
  → XMLRuleProcessor
Create a new XMLRuleProcessor
rulePaths Array<string> The XPath condition paths of the rules in the rule set.
prefixMappingTable The namespace mapping table. Can accept: Array of Arrays of 2 Strings. (Optional)
withProperties Object Initial values for properties of the new XMLRuleProcessor (Optional)
anyItem(
)
  → XMLRuleProcessor
Returns any XMLRuleProcessor in the collection.
count(
)
  → number
Displays the number of elements in the XMLRuleProcessor.
everyItem(
)
  → XMLRuleProcessor
Returns every XMLRuleProcessor in the collection.
firstItem(
)
  → XMLRuleProcessor
Returns the first XMLRuleProcessor in the collection.
item(
index)
  → XMLRuleProcessor
Returns the XMLRuleProcessor with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → XMLRuleProcessor
Returns the XMLRuleProcessor with the specified ID.
id number The ID.
itemByName(
name)
  → XMLRuleProcessor
Returns the XMLRuleProcessor with the specified name.
name string The name.
itemByRange(
from, to)
  → XMLRuleProcessor
Returns the XMLRuleProcessors within the specified range.
from The XMLRuleProcessor, index, or name at the beginning of the range. Can accept: XMLRuleProcessor, Long Integer or String.
to The XMLRuleProcessor, index, or name at the end of the range. Can accept: XMLRuleProcessor, Long Integer or String.
lastItem(
)
  → XMLRuleProcessor
Returns the last XMLRuleProcessor in the collection.
middleItem(
)
  → XMLRuleProcessor
Returns the middle XMLRuleProcessor in the collection.
nextItem(
obj)
  → XMLRuleProcessor
Returns the XMLRuleProcessor whose index follows the specified XMLRuleProcessor in the collection.
obj XMLRuleProcessor The XMLRuleProcessor whose index comes before the desired XMLRuleProcessor.
previousItem(
obj)
  → XMLRuleProcessor
Returns the XMLRuleProcessor with the index previous to the specified index.
obj XMLRuleProcessor The index of the XMLRuleProcessor that follows the desired XMLRuleProcessor.
toSource(
)
  → string
Generates a string which, if executed, will return the XMLRuleProcessor.