DataMergeImagePlaceholders

A collection of data merge image placeholders.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

DataMergeImagePlaceholder [] (index:Number)

Returns the DataMergeImagePlaceholder with the specified index.

Parameter	Type	Description
index	Number	The index.

DataMergeImagePlaceholder add (placeholder:PageItem, field:DataMergeField, withProperties:Object)

Creates a data merge image placeholder.

Parameter	Type	Description
placeholder	PageItem	The page item on which to place the placeholder.
field	DataMergeField	The data merge field to insert.
withProperties	Object	Initial 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.

DataMergeImagePlaceholder everyItem ()

Returns every DataMergeImagePlaceholder in the collection.

DataMergeImagePlaceholder firstItem ()

Returns the first DataMergeImagePlaceholder in the collection.

DataMergeImagePlaceholder item (index:Varies LongInteger String)

Returns the DataMergeImagePlaceholder with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

DataMergeImagePlaceholder itemByRange (from:Varies DataMergeImagePlaceholder LongInteger String, to:Varies DataMergeImagePlaceholder LongInteger String)

Returns the DataMergeImagePlaceholders within the specified range.

Parameter	Type	Description
from	DataMergeImagePlaceholder LongInteger String	The DataMergeImagePlaceholder, index, or name at the beginning of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String.
to	DataMergeImagePlaceholder LongInteger String	The DataMergeImagePlaceholder, index, or name at the end of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String.

Parameter

Type

Description

from

DataMergeImagePlaceholder

LongInteger

String

The DataMergeImagePlaceholder, index, or name at the beginning of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String.

DataMergeImagePlaceholder

LongInteger

String

The DataMergeImagePlaceholder, index, or name at the end of the range. Can accept: DataMergeImagePlaceholder, Long Integer 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.

Parameter	Type	Description
obj	DataMergeImagePlaceholder	The DataMergeImagePlaceholder whose index comes before the desired DataMergeImagePlaceholder.

DataMergeImagePlaceholder previousItem (obj:DataMergeImagePlaceholder)

Returns the DataMergeImagePlaceholder with the index previous to the specified index.

Parameter	Type	Description
obj	DataMergeImagePlaceholder	The index of the DataMergeImagePlaceholder that follows the desired DataMergeImagePlaceholder.

String toSource ()

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

Object of

Document.dataMergeImagePlaceholders