DataMergeField
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| fieldName | string | readonly | The name of the field. |
| fieldType | SourceFieldType: SourceFieldType.TEXT_FIELD SourceFieldType.IMAGE_FIELD |
readonly | The source field type. |
| index | number | readonly | The index of the DataMergeField within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | DataMerge | readonly | The parent of the DataMergeField (a DataMerge). |
| properties | Object | r/w | A 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the DataMergeField.
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.3h | Contents :: Index |