Adobe InDesign CS4 (6.0) Object Model JS: DataMergeField

InDesign CS4

Class

DataMergeField

 A data merge field.

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

DataMerge
DataMergeField

Properties

PropertyTypeAccessDescription
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

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

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

Array of DataMergeField DataMergeField.getElements ()

DataMergeField DataMergeFields.[] (index: number)

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, 20-Jun-2010 v3.0.3dContents :: Index