Adobe InCopy CS5 (7.0) Object Model JS: XMLAttribute

InCopy CS5

previous page next page

Class

XMLAttribute

An XML attribute.

QuickLinks

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

Hierarchy

XMLElement

XMLAttribute

Event | EventListener | MutationEvent

Properties

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

Methods

Instances

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

Parameter	Type	Description
located	XMLElementLocation: 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)
markupTag	XMLTag	The 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.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

Parameter	Type	Description
existingSelection	SelectionOptions: 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.