K4 InDesign Javascript API Documentation

DatamergeDataMergeFields

A collection of data merge fields.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

anyItem(
)
  → DataMergeField
count(
)
  → number
everyItem(
)
  → DataMergeField
firstItem(
)
  → DataMergeField
item(
index)
  → DataMergeField
itemByRange(
from, to)
  → DataMergeField
lastItem(
)
  → DataMergeField
middleItem(
)
  → DataMergeField
nextItem(
obj)
  → DataMergeField
previousItem(
obj)
  → DataMergeField
toSource(
)
  → string
anyItem(
)
  → DataMergeField
Returns any DataMergeField in the collection.
count(
)
  → number
Displays the number of elements in the DataMergeField.
everyItem(
)
  → DataMergeField
Returns every DataMergeField in the collection.
firstItem(
)
  → DataMergeField
Returns the first DataMergeField in the collection.
item(
index)
  → DataMergeField
Returns the DataMergeField with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → DataMergeField
Returns the DataMergeFields within the specified range.
from The DataMergeField, index, or name at the beginning of the range. Can accept: DataMergeField, Long Integer or String.
to The DataMergeField, index, or name at the end of the range. Can accept: DataMergeField, Long Integer or String.
lastItem(
)
  → DataMergeField
Returns the last DataMergeField in the collection.
middleItem(
)
  → DataMergeField
Returns the middle DataMergeField in the collection.
nextItem(
obj)
  → DataMergeField
Returns the DataMergeField whose index follows the specified DataMergeField in the collection.
obj DataMergeField The DataMergeField whose index comes before the desired DataMergeField.
previousItem(
obj)
  → DataMergeField
Returns the DataMergeField with the index previous to the specified index.
obj DataMergeField The index of the DataMergeField that follows the desired DataMergeField.
toSource(
)
  → string
Generates a string which, if executed, will return the DataMergeField.