Class

DataMergeField

 A data merge field.

QuickLinks

 addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

DataMerge
DataMergeField
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
fieldNamestring readonlyThe name of the field.
fieldTypeSourceFieldType:
SourceFieldType.TEXT_FIELD
SourceFieldType.IMAGE_FIELD		 readonlyThe source field type.
indexnumber readonlyThe index of the DataMergeField within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentDataMerge readonlyThe parent of the DataMergeField (a DataMerge).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function		The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of DataMergeField getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function		The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the DataMergeField.

string toSpecifier ()
Retrieves the object specifier.

Element of

DataMergeImagePlaceholder.field

DataMergeTextPlaceholder.field

Used in:

DataMergeField DataMergeFields.nextItem (obj: DataMergeField)

DataMergeField DataMergeFields.previousItem (obj: DataMergeField)

DataMergeImagePlaceholder DataMergeImagePlaceholders.add (placeholder: PageItem, field: DataMergeField[, withProperties: Object])

DataMergeTextPlaceholder DataMergeTextPlaceholders.add (parentStory: Story, storyOffset: varies, field: DataMergeField[, withProperties: Object])

Return

Array of DataMergeField DataMergeField.getElements ()

DataMergeField DataMergeFields.[] (index: number)

DataMergeField DataMergeFields.anyItem ()

Array of DataMergeField DataMergeFields.everyItem ()

DataMergeField DataMergeFields.firstItem ()

DataMergeField DataMergeFields.item (index: varies)

Array of DataMergeField DataMergeFields.itemByRange (from: varies, to: varies)

DataMergeField DataMergeFields.lastItem ()

DataMergeField DataMergeFields.middleItem ()

DataMergeField DataMergeFields.nextItem (obj: DataMergeField)

DataMergeField DataMergeFields.previousItem (obj: DataMergeField)

Jongware, 28-Apr-2012 v3.0.3iContents :: Index