Adobe InDesign CS6 (8.0) Object Model JS: XMLRuleMatchData

InDesign CS6

Class

XMLRuleMatchData

 An XML element matched by a rule or rules in the current XML rule set.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

XMLRuleProcessor
XMLRuleMatchData
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
elementXMLItem readonlyAn XML element matched by a rule or rules in the current XML rule set.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the XMLRuleMatchData within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
matchRulesArray of number readonlyThe indices of matching XML rules in the rule set.
parentXMLRuleProcessor readonlyThe parent of the XMLRuleMatchData (a XMLRuleProcessor).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of XMLRuleMatchData getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Return

Array of XMLRuleMatchData XMLRuleMatchData.getElements ()

XMLRuleMatchData XMLRuleProcessor.findNextMatch ()

XMLRuleMatchData XMLRuleProcessor.startProcessingRuleSet (initialElement: XMLElement)

XMLRuleMatchData XMLRuleProcessor.startProcessingSubtree ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index