Adobe InDesign CS5.5 Server (7.5) Object Model JS: XMLTags

InDesign Server CS5.5

Class

XMLTags

 A collection of XML tags.

See also XMLTag.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

XMLTag add ([name: string][, tagColor: varies][, withProperties: Object])
Creates a tag.

ParameterTypeDescription
namestringThe name of the tag. (Optional)
tagColorArray of 3 Reals (0 - 255)
UIColors
The dolor of the tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can accept: Array of 3 Reals (0 - 255) or UIColors enumerator. (Optional)
withPropertiesObjectInitial values for properties of the new XMLTag (Optional)

XMLTag anyItem ()
Returns any XMLTag in the collection.

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

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

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

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

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

XMLTag itemByID (id: number)
Returns the XMLTag with the specified ID.

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objXMLTagThe XMLTag whose index comes before the desired XMLTag.

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

ParameterTypeDescription
objXMLTagThe index of the XMLTag that follows the desired XMLTag.

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

Element of

Application.xmlTags

Document.xmlTags

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