A collection of data merge image placeholders.
Methods
DataMergeImagePlaceholderadd (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) |
DataMergeImagePlaceholderanyItem ()
Returns any DataMergeImagePlaceholder in the collection.
number count ()
Displays the number of elements in the DataMergeImagePlaceholder.
Array of DataMergeImagePlaceholdereveryItem ()
Returns every DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholderfirstItem ()
Returns the first DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholderitem (index:
any)
Returns the DataMergeImagePlaceholder with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
DataMergeImagePlaceholderitemByName (name:
string)
Returns the DataMergeImagePlaceholder with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of DataMergeImagePlaceholderitemByRange (from:
any, to:
any)
Returns the DataMergeImagePlaceholders within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | DataMergeImagePlaceholder Long Integer String |
The DataMergeImagePlaceholder, index, or name at the beginning of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String. |
| to | DataMergeImagePlaceholder Long Integer String |
The DataMergeImagePlaceholder, index, or name at the end of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String. |
DataMergeImagePlaceholderlastItem ()
Returns the last DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholdermiddleItem ()
Returns the middle DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholdernextItem (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. |
DataMergeImagePlaceholderpreviousItem (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.
Element of:
Document.dataMergeImagePlaceholders