Adobe InDesign CS2 (4.0) Object Model JS: DataMergeImagePlaceholders

InDesign CS2

Class

DataMergeImagePlaceholders

 A collection of data merge image placeholders.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

DataMergeImagePlaceholder add (placeholder: PageItem, field: DataMergeField[, withProperties: Object])
Creates a data merge image placeholder.

ParameterTypeDescription
placeholderPageItemThe page item on which to place the placeholder.
fieldDataMergeFieldThe data merge field to insert.
withPropertiesObjectInitial values for properties of the new DataMergeImagePlaceholder (Optional)

DataMergeImagePlaceholder anyItem ()
Returns any DataMergeImagePlaceholder in the collection.

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

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

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

DataMergeImagePlaceholder item (index: any)
Returns the DataMergeImagePlaceholder with the specified index or name.

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

DataMergeImagePlaceholder itemByName (name: string)
Returns the DataMergeImagePlaceholder with the specified name.

ParameterTypeDescription
namestringThe name.

Array of DataMergeImagePlaceholder itemByRange (from: any, to: any)
Returns the DataMergeImagePlaceholders within the specified range.

ParameterTypeDescription
fromDataMergeImagePlaceholder
Long
String
The DataMergeImagePlaceholder, index, or name at the beginning of the range. Can accept: DataMergeImagePlaceholder, Long or String.
toDataMergeImagePlaceholder
Long
String
The DataMergeImagePlaceholder, index, or name at the end of the range. Can accept: DataMergeImagePlaceholder, Long or String.

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

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

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

ParameterTypeDescription
objDataMergeImagePlaceholderThe DataMergeImagePlaceholder whose index comes before the desired DataMergeImagePlaceholder.

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

ParameterTypeDescription
objDataMergeImagePlaceholderThe index of the DataMergeImagePlaceholder that follows the desired DataMergeImagePlaceholder.

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

Element of

Document.dataMergeImagePlaceholders

Jongware, 27-Jun-2010 v3.0.3dContents :: Index