Adobe InCopy CS5 (7.0) Object Model JS: XMLAttribute

InCopy CS5

Class

XMLAttribute

 An XML attribute.

QuickLinks

addEventListener, convertToElement, getElements, remove, removeEventListener, select, toSource, toSpecifier

Hierarchy

XMLElement
XMLAttribute
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the XMLAttribute within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe name of the XMLAttribute.
parentXMLElement readonlyThe parent of the XMLAttribute (a XMLElement).
propertiesObject r/wA property that allows setting of several properties at the same time.
valuestring r/wThe value of the XMLAttribute.

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)

XMLElement convertToElement ([located: XMLElementLocation=XMLElementLocation.ELEMENT_START][, markupTag: XMLTag])
Converts the XML attribute to a child element of its parent element.

ParameterTypeDescription
locatedXMLElementLocation:
XMLElementLocation.ELEMENT_START
XMLElementLocation.ELEMENT_END
The location of the new XML element within the parent XML element of the XML attribute. (Optional) (default: XMLElementLocation.ELEMENT_START)
markupTagXMLTagThe XML tag to apply to the new XML element. (Optional)

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

void remove ()
Deletes the XMLAttribute.

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)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
The selection status of the XMLAttribute in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

XMLAttribute XMLAttributes.nextItem (obj: XMLAttribute)

XMLAttribute XMLAttributes.previousItem (obj: XMLAttribute)

Return

Array of XMLAttribute XMLAttribute.getElements ()

XMLAttribute XMLAttributes.[] (index: number)

XMLAttribute XMLAttributes.add (name: string, value: string[, withProperties: Object])

XMLAttribute XMLAttributes.anyItem ()

Array of XMLAttribute XMLAttributes.everyItem ()

XMLAttribute XMLAttributes.firstItem ()

XMLAttribute XMLAttributes.item (index: varies)

XMLAttribute XMLAttributes.itemByName (name: string)

Array of XMLAttribute XMLAttributes.itemByRange (from: varies, to: varies)

XMLAttribute XMLAttributes.lastItem ()

XMLAttribute XMLAttributes.middleItem ()

XMLAttribute XMLAttributes.nextItem (obj: XMLAttribute)

XMLAttribute XMLAttributes.previousItem (obj: XMLAttribute)

XMLAttribute XMLElement.convertToAttribute ([using: string])

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