Adobe InDesign CS5 Server (7.0) Object Model JS: XMLRuleProcessors

InDesign Server CS5

Class

XMLRuleProcessors

 A collection of XML rule processors.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

XMLRuleProcessor [] (index: number)
Returns the XMLRuleProcessor with the specified index.

ParameterTypeDescription
indexnumberThe index.

XMLRuleProcessor add (rulePaths: Array of string[, prefixMappingTable: Array of varies][, withProperties: Object])
Create a new XMLRuleProcessor

ParameterTypeDescription
rulePaths Array of stringThe XPath condition paths of the rules in the rule set.
prefixMappingTable Array of :
Array of Arrays of 2 Strings
The namespace mapping table. Can accept: Array of Arrays of 2 Strings. (Optional)
withPropertiesObjectInitial values for properties of the new XMLRuleProcessor (Optional)

XMLRuleProcessor anyItem ()
Returns any XMLRuleProcessor in the collection.

number count ()
Displays the number of elements in the XMLRuleProcessor.

Array of XMLRuleProcessor everyItem ()
Returns every XMLRuleProcessor in the collection.

XMLRuleProcessor firstItem ()
Returns the first XMLRuleProcessor in the collection.

XMLRuleProcessor item (index: varies)
Returns the XMLRuleProcessor with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

XMLRuleProcessor itemByID (id: number)
Returns the XMLRuleProcessor with the specified ID.

ParameterTypeDescription
idnumberThe ID.

XMLRuleProcessor itemByName (name: string)
Returns the XMLRuleProcessor with the specified name.

ParameterTypeDescription
namestringThe name.

Array of XMLRuleProcessor itemByRange (from: varies, to: varies)
Returns the XMLRuleProcessors within the specified range.

ParameterTypeDescription
fromLong Integer
String
XMLRuleProcessor
The XMLRuleProcessor, index, or name at the beginning of the range. Can accept: XMLRuleProcessor, Long Integer or String.
toLong Integer
String
XMLRuleProcessor
The XMLRuleProcessor, index, or name at the end of the range. Can accept: XMLRuleProcessor, Long Integer or String.

XMLRuleProcessor lastItem ()
Returns the last XMLRuleProcessor in the collection.

XMLRuleProcessor middleItem ()
Returns the middle XMLRuleProcessor in the collection.

XMLRuleProcessor nextItem (obj: XMLRuleProcessor)
Returns the XMLRuleProcessor whose index follows the specified XMLRuleProcessor in the collection.

ParameterTypeDescription
objXMLRuleProcessorThe XMLRuleProcessor whose index comes before the desired XMLRuleProcessor.

XMLRuleProcessor previousItem (obj: XMLRuleProcessor)
Returns the XMLRuleProcessor with the index previous to the specified index.

ParameterTypeDescription
objXMLRuleProcessorThe index of the XMLRuleProcessor that follows the desired XMLRuleProcessor.

string toSource ()
Generates a string which, if executed, will return the XMLRuleProcessor.

Element of

Application.xmlRuleProcessors

Jongware, 23-Mar-2011 v3.0.3dContents :: Index