Class

XMLTag

 An XML markup tag.

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Hierarchy

Application | Document

XMLTag

Properties

Property	Type	Access	Description
id	number	readonly	The unique ID of the XMLTag.
index	number	readonly	The index of the XMLTag within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the XMLTag.
parent	ApplicationDocument	readonly	The parent of the XMLTag (a Application or Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
tagColor	3 Reals (0 - 255) UIColors	r/w	The 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.

Parameter	Type	Description
key	string	The 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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove (replacingWith: any)
Deletes the tag.

Parameter	Type	Description
replacingWith	String 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

ChangeGrepPreference.markupTag

ChangeTextPreference.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)

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

Array of XMLTag XMLTag.getElements ()

XMLTag XMLTags.[] (index: number)

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, 20-Jun-2010 v3.0.3d

Contents :: Index