DataMergeField

A data merge field.

Go to Property Listing | Method Listing

Methods:

getElements, toSource, toSpecifier

Objects:

Boolean, Number, Object, SourceFieldType, String

Property Listing

Property

Type

Access

Description

fieldName

String

readonly

The name of the field.

fieldType

SourceFieldType

SourceFieldType.IMAGE_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

DataMergeField getElements ()

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.

Object of

DataMergeTextPlaceholder.field

DataMergeImagePlaceholder.field

Return

DataMergeField.getElements()

DataMergeFields.anyItem()

DataMergeFields.everyItem()

DataMergeFields.nextItem()

DataMergeFields.previousItem()

DataMergeFields.item()

DataMergeFields.[]()

DataMergeFields.itemByName()

DataMergeFields.itemByRange()

DataMergeFields.firstItem()

DataMergeFields.lastItem()

DataMergeFields.middleItem()