A data merge field.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| fieldName | string | readonly | The name of the field. |
| fieldType | SourceFieldType : TEXT_FIELD IMAGE_FIELD |
readonly | The source field type. |
| index | number | readonly | The index of the DataMergeField within its containing object. |
| 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
Array of DataMergeFieldgetElements ()
Resolves the object specifier, creating an array of object references.
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:
DataMergeFields.previousItem (
obj:
DataMergeField )
DataMergeFields.nextItem (
obj:
DataMergeField )
DataMergeImagePlaceholders.add (
placeholder:
PageItem, field:
DataMergeField [, withProperties:
Object])
DataMergeTextPlaceholders.add (
parentStory:
Story, storyOffset:
any, field:
DataMergeField [, withProperties:
Object])
Returned by:
Array of DataMergeField DataMergeField .getElements (
)
DataMergeField DataMergeFields.anyItem (
)
Array of DataMergeField DataMergeFields.everyItem (
)
DataMergeField DataMergeFields.firstItem (
)
DataMergeField DataMergeFields.item (
index:
any
)
DataMergeField DataMergeFields.itemByName (
name:
string
)
Array of DataMergeField DataMergeFields.itemByRange (
from:
any, to:
any
)
DataMergeField DataMergeFields.lastItem (
)
DataMergeField DataMergeFields.middleItem (
)
DataMergeField DataMergeFields.nextItem (
obj:
DataMergeField
)
DataMergeField DataMergeFields.previousItem (
obj:
DataMergeField
)