XMLTag

An XML markup tag.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, String, UIColors,

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the XMLTag.

index

Number

readonly

The index of the XMLTag within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the XMLTag.

parent

Application

Document

readonly

The parent of the XMLTag (a Application or Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

tagColor

Array of 3 Reals (0 - 255)

UIColors

read/write

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.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

XMLTag getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined remove (replacingWith:Varies XMLTag String)

Deletes the tag.

Parameter

Type

Description

replacingWith

XMLTag

String

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

XMLElement.markupTag

XMLImportMap.markupTag

XMLExportMap.markupTag

Event.parent

EventListener.parent

MutationEvent.parent

DTD.rootTag

Return

XMLTags.add()

XMLTag.getElements()

XMLTags.anyItem()

XMLTags.everyItem()

XMLTags.nextItem()

XMLTags.previousItem()

XMLTags.itemByID()

XMLTags.item()

XMLTags.[]()

XMLTags.itemByName()

XMLTags.itemByRange()

XMLTags.firstItem()

XMLTags.lastItem()

XMLTags.middleItem()