K4 InDesign Javascript API Documentation

XMLXMLAttribute

An XML attribute.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the XMLAttribute within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the XMLAttribute. read-write
parent XMLElement The parent of the XMLAttribute (a XMLElement). read-only
properties Object A property that allows setting of several properties at the same time. read-write
value string The value of the XMLAttribute. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
convertToElement(
[located] ​[, markupTag])
  → XMLElement
getElements(
)
  → XMLAttribute
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
select(
[existingSelection])
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)
convertToElement(
[located=XMLElementLocation.ELEMENT_START] ​[, markupTag])
  → XMLElement
Converts the XML attribute to a child element of its parent element.
located XMLElementLocation The location of the new XML element within the parent XML element of the XML attribute. (Optional)
markupTag XMLTag The XML tag to apply to the new XML element. (Optional)
getElements(
)
  → XMLAttribute
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the XMLAttribute.
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)
select(
[existingSelection=SelectionOptions.REPLACE_WITH])
Selects the object.
existingSelection SelectionOptions The selection status of the XMLAttribute in relation to previously selected objects. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the XMLAttribute.
toSpecifier(
)
  → string
Retrieves the object specifier.