Adobe InDesign CS5 Server (7.0) Object Model JS: XMLTag

InDesign Server CS5

Class

XMLTag

 An XML markup tag.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
XMLTag
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the XMLTag.
indexnumber readonlyThe index of the XMLTag within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the XMLTag.
parentApplicationDocument readonlyThe parent of the XMLTag (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
tagColor3 Reals (0 - 255)
UIColors
r/wThe color 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 return: Array of 3 Reals (0 - 255) or UIColors enumerator.

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)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

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

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove (replacingWith: varies)
Deletes the tag.

ParameterTypeDescription
replacingWithString
XMLTag
The tag to substitute. Can accept: XMLTag or String.

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)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

ChangeGrepPreference.markupTag

ChangeTextPreference.markupTag

ChangeTransliteratePreference.markupTag

DTD.rootTag

XMLElement.markupTag

XMLExportMap.markupTag

XMLImportMap.markupTag

Used in:

XMLElement XMLAttribute.convertToElement ([located: XMLElementLocation=XMLElementLocation.ELEMENT_START][, markupTag: XMLTag])

Table XMLElement.convertElementToTable (rowTag: XMLTag, cellTag: XMLTag)

XMLTag XMLTags.nextItem (obj: XMLTag)

XMLTag XMLTags.previousItem (obj: XMLTag)

Return

Array of XMLTag XMLTag.getElements ()

XMLTag XMLTags.[] (index: number)

XMLTag XMLTags.add ([name: string][, tagColor: varies][, withProperties: Object])

XMLTag XMLTags.anyItem ()

Array of XMLTag XMLTags.everyItem ()

XMLTag XMLTags.firstItem ()

XMLTag XMLTags.item (index: varies)

XMLTag XMLTags.itemByID (id: number)

XMLTag XMLTags.itemByName (name: string)

Array of XMLTag XMLTags.itemByRange (from: varies, to: varies)

XMLTag XMLTags.lastItem ()

XMLTag XMLTags.middleItem ()

XMLTag XMLTags.nextItem (obj: XMLTag)

XMLTag XMLTags.previousItem (obj: XMLTag)

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