DataMergeField

A data merge field.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, SourceFieldType, String

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

fieldName

String

readonly

The name of the field.

fieldType

SourceFieldType

SourceFieldType.IMAGE_FIELD

SourceFieldType.QRCODE_FIELD

SourceFieldType.TEXT_FIELD

readonly

The source field type.

index

Number

readonly

The index of the DataMergeField within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

DataMerge

readonly

The parent of the DataMergeField (a DataMerge).

properties

Object

read/write

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

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)

DataMergeField getElements ()

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

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

String toSpecifier ()

Retrieves the object specifier.

Object of

DataMergeTextPlaceholder.field

DataMergeImagePlaceholder.field

DataMergeQrcodePlaceholder.field

Event.parent

EventListener.parent

MutationEvent.parent

Return

DataMergeField.getElements()

DataMergeFields.anyItem()

DataMergeFields.everyItem()

DataMergeFields.nextItem()

DataMergeFields.previousItem()

DataMergeFields.item()

DataMergeFields.[]()

DataMergeFields.itemByRange()

DataMergeFields.firstItem()

DataMergeFields.lastItem()

DataMergeFields.middleItem()