Class

DataMergeField

 A data merge field.

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

DataMerge

DataMergeField

Properties

Property	Type	Access	Description
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.
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

Array of Object 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.

Element of

DataMergeImagePlaceholder.field

DataMergeTextPlaceholder.field

Used in:

array of DataMergeField DataMergeFields.itemByRange (from: any, to: any)

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: any, field: DataMergeField[, withProperties: Object])

Return

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)

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index