InDesign Server2025
API 20.5.0.49
Object

XMLRuleProcessor

An XML rule processor.

Hierarchy

Application

XMLRuleProcessor

XMLRuleMatchData

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly If true, the XML rule process has halted.
Number readonly The unique ID of the XMLRuleProcessor.
Number readonly The index of the XMLRuleProcessor within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the XMLRuleProcessor; this is an alias to the XMLRuleProcessor's label property.
Application readonly The parent of the XMLRuleProcessor (a Application).
Object read/write A property that allows setting of several properties at the same time.
String[] readonly The XPath condition paths of the rules in the rule set.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
void

Stop processing XML rule set.

String

Gets the label value associated with the specified key.

key String The key.
XMLRuleProcessor[]

Resolves the object specifier, creating an array of object references.

void

Halt the XML rule processor.

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
void

Deletes the XMLRuleProcessor.

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
void

Do not process XML elements (children) of the current XML element.

XMLRuleMatchData

Start processing an XML rule set.

initialElement XMLElement The XML element at which to start processing the rule set.
XMLRuleMatchData

Process the XML elements of the current XML element.

String

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a XMLRuleProcessor.

Parameter of 3

Method parameters that accept a XMLRuleProcessor.

Return 14

Methods that return a XMLRuleProcessor.