InDesign2026
API 21.5.1.73
Object

XMLTag

An XML markup tag.

Hierarchy

Application | Document

XMLTag

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the XMLTag.
Number readonly The index of the XMLTag within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the XMLTag.
Application | Document readonly The parent of the XMLTag (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.
3 Reals (0 - 255)[] | UIColors[]
+25 more
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.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

Gets the label value associated with the specified key.

key String The key.
XMLTag[]

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

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
void

Deletes the tag.

replacingWith XMLTag | String The tag to substitute. Can accept: XMLTag or String.
Boolean

Removes the event listener.

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

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

String

Retrieves the object specifier.

Object of 10

Properties elsewhere that hold a XMLTag.

Parameter of 9

Method parameters that accept a XMLTag.

Return 14

Methods that return a XMLTag.