Adobe InDesign CS2 (4.0) Object Model JS: XMLTag

InDesign CS2

Class

XMLTag

 An XML markup tag.

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Hierarchy

Application | Document
XMLTag

Properties

PropertyTypeAccessDescription
idnumber readonlyThe unique ID of the XMLTag.
indexnumber readonlyThe index of the XMLTag within its containing object.
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

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

ParameterTypeDescription
keystringThe key.

Array of Object 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: any)
Deletes the tag.

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of

DTD.rootTag

XMLElement.markupTag

XMLExportMap.markupTag

XMLImportMap.markupTag

Used in:

XMLElement XMLElements.add (markupTag: any[, xmlContent: any][, withProperties: Object])

XMLExportMap XMLExportMaps.add (mappedStyle: any, markupTag: any[, withProperties: Object])

XMLImportMap XMLImportMaps.add (markupTag: any, mappedStyle: any[, withProperties: Object])

void XMLTag.remove (replacingWith: any)

array of XMLTag XMLTags.itemByRange (from: any, to: any)

XMLTag XMLTags.nextItem (obj: XMLTag)

XMLTag XMLTags.previousItem (obj: XMLTag)

Return

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

XMLTag XMLTags.anyItem ()

Array of XMLTag XMLTags.everyItem ()

XMLTag XMLTags.firstItem ()

XMLTag XMLTags.item (index: any)

XMLTag XMLTags.itemByID (id: number)

XMLTag XMLTags.itemByName (name: string)

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

XMLTag XMLTags.lastItem ()

XMLTag XMLTags.middleItem ()

XMLTag XMLTags.nextItem (obj: XMLTag)

XMLTag XMLTags.previousItem (obj: XMLTag)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index