Adobe InCopy CS5 (7.0) Object Model JS: XMLAttributes

InCopy CS5

Class

XMLAttributes

 A collection of XML attributes.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

XMLAttribute [] (index: number)
Returns the XMLAttribute with the specified index.

ParameterTypeDescription
indexnumberThe index.

XMLAttribute add (name: string, value: string[, withProperties: Object])
Creates a new XML attribute.

ParameterTypeDescription
namestringThe name of the attribute.
valuestringThe value of the attribute.
withPropertiesObjectInitial values for properties of the new XMLAttribute (Optional)

XMLAttribute anyItem ()
Returns any XMLAttribute in the collection.

number count ()
Displays the number of elements in the XMLAttribute.

Array of XMLAttribute everyItem ()
Returns every XMLAttribute in the collection.

XMLAttribute firstItem ()
Returns the first XMLAttribute in the collection.

XMLAttribute item (index: varies)
Returns the XMLAttribute with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

XMLAttribute itemByName (name: string)
Returns the XMLAttribute with the specified name.

ParameterTypeDescription
namestringThe name.

Array of XMLAttribute itemByRange (from: varies, to: varies)
Returns the XMLAttributes within the specified range.

ParameterTypeDescription
fromLong Integer
String
XMLAttribute
The XMLAttribute, index, or name at the beginning of the range. Can accept: XMLAttribute, Long Integer or String.
toLong Integer
String
XMLAttribute
The XMLAttribute, index, or name at the end of the range. Can accept: XMLAttribute, Long Integer or String.

XMLAttribute lastItem ()
Returns the last XMLAttribute in the collection.

XMLAttribute middleItem ()
Returns the middle XMLAttribute in the collection.

XMLAttribute nextItem (obj: XMLAttribute)
Returns the XMLAttribute whose index follows the specified XMLAttribute in the collection.

ParameterTypeDescription
objXMLAttributeThe XMLAttribute whose index comes before the desired XMLAttribute.

XMLAttribute previousItem (obj: XMLAttribute)
Returns the XMLAttribute with the index previous to the specified index.

ParameterTypeDescription
objXMLAttributeThe index of the XMLAttribute that follows the desired XMLAttribute.

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

Element of

XMLElement.xmlAttributes

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