Adobe InDesign CS6 (8.0) Object Model JS: DataMergeTextPlaceholders

InDesign CS6

Class

DataMergeTextPlaceholders

 A collection of data merge text placeholders.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

DataMergeTextPlaceholder [] (index: number)
Returns the DataMergeTextPlaceholder with the specified index.

ParameterTypeDescription
indexnumberThe index.

DataMergeTextPlaceholder add (parentStory: Story, storyOffset: varies, field: DataMergeField[, withProperties: Object])
Creates a data merge text placeholder.

ParameterTypeDescription
parentStoryStoryThe story in which to insert the placeholder.
storyOffsetInsertionPoint
Long Integer
The position within the story at which to insert the placeholder, specified as an offset number or an insertion point. Can accept: InsertionPoint or Long Integer.
fieldDataMergeFieldThe field to insert.
withPropertiesObjectInitial values for properties of the new DataMergeTextPlaceholder (Optional)

DataMergeTextPlaceholder anyItem ()
Returns any DataMergeTextPlaceholder in the collection.

number count ()
Displays the number of elements in the DataMergeTextPlaceholder.

Array of DataMergeTextPlaceholder everyItem ()
Returns every DataMergeTextPlaceholder in the collection.

DataMergeTextPlaceholder firstItem ()
Returns the first DataMergeTextPlaceholder in the collection.

DataMergeTextPlaceholder item (index: varies)
Returns the DataMergeTextPlaceholder with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Array of DataMergeTextPlaceholder itemByRange (from: varies, to: varies)
Returns the DataMergeTextPlaceholders within the specified range.

ParameterTypeDescription
fromDataMergeTextPlaceholder
Long Integer
String
The DataMergeTextPlaceholder, index, or name at the beginning of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String.
toDataMergeTextPlaceholder
Long Integer
String
The DataMergeTextPlaceholder, index, or name at the end of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String.

DataMergeTextPlaceholder lastItem ()
Returns the last DataMergeTextPlaceholder in the collection.

DataMergeTextPlaceholder middleItem ()
Returns the middle DataMergeTextPlaceholder in the collection.

DataMergeTextPlaceholder nextItem (obj: DataMergeTextPlaceholder)
Returns the DataMergeTextPlaceholder whose index follows the specified DataMergeTextPlaceholder in the collection.

ParameterTypeDescription
objDataMergeTextPlaceholderThe DataMergeTextPlaceholder whose index comes before the desired DataMergeTextPlaceholder.

DataMergeTextPlaceholder previousItem (obj: DataMergeTextPlaceholder)
Returns the DataMergeTextPlaceholder with the index previous to the specified index.

ParameterTypeDescription
objDataMergeTextPlaceholderThe index of the DataMergeTextPlaceholder that follows the desired DataMergeTextPlaceholder.

string toSource ()
Generates a string which, if executed, will return the DataMergeTextPlaceholder.

Element of

Document.dataMergeTextPlaceholders

Jongware, 28-Apr-2012 v3.0.3hContents :: Index