InDesign2026
API 21.5.1.73
Object

DataMergeField

A data merge field.

Hierarchy

DataMerge

DataMergeField

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
String readonly The name of the field.
SourceFieldType
readonly The source field type.
Number readonly The index of the DataMergeField within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
DataMerge readonly The parent of the DataMergeField (a DataMerge).
Object read/write A property that allows setting of several properties at the same time.

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.
DataMergeField[]

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

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

String

Retrieves the object specifier.

Object of 6

Properties elsewhere that hold a DataMergeField.

Parameter of 6

Method parameters that accept a DataMergeField.

Return 11

Methods that return a DataMergeField.