K4 InDesign Javascript API Documentation

DatamergeDataMergeTextPlaceholders

A collection of data merge text placeholders.

Instance Properties

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

Methods

add(
parentStory, storyOffset, field ​[, withProperties])
  → DataMergeTextPlaceholder
anyItem(
)
  → DataMergeTextPlaceholder
count(
)
  → number
everyItem(
)
  → DataMergeTextPlaceholder
firstItem(
)
  → DataMergeTextPlaceholder
item(
index)
  → DataMergeTextPlaceholder
itemByRange(
from, to)
  → DataMergeTextPlaceholder
lastItem(
)
  → DataMergeTextPlaceholder
middleItem(
)
  → DataMergeTextPlaceholder
nextItem(
obj)
  → DataMergeTextPlaceholder
previousItem(
obj)
  → DataMergeTextPlaceholder
toSource(
)
  → string
add(
parentStory, storyOffset, field ​[, withProperties])
  → DataMergeTextPlaceholder
Creates a data merge text placeholder.
parentStory Story The story in which to insert the placeholder.
storyOffset 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.
field DataMergeField The field to insert.
withProperties Object Initial values for properties of the new DataMergeTextPlaceholder (Optional)
anyItem(
)
  → DataMergeTextPlaceholder
Returns any DataMergeTextPlaceholder in the collection.
count(
)
  → number
Displays the number of elements in the DataMergeTextPlaceholder.
everyItem(
)
  → DataMergeTextPlaceholder
Returns every DataMergeTextPlaceholder in the collection.
firstItem(
)
  → DataMergeTextPlaceholder
Returns the first DataMergeTextPlaceholder in the collection.
item(
index)
  → DataMergeTextPlaceholder
Returns the DataMergeTextPlaceholder with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → DataMergeTextPlaceholder
Returns the DataMergeTextPlaceholders within the specified range.
from The DataMergeTextPlaceholder, index, or name at the beginning of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String.
to The DataMergeTextPlaceholder, index, or name at the end of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String.
lastItem(
)
  → DataMergeTextPlaceholder
Returns the last DataMergeTextPlaceholder in the collection.
middleItem(
)
  → DataMergeTextPlaceholder
Returns the middle DataMergeTextPlaceholder in the collection.
nextItem(
obj)
  → DataMergeTextPlaceholder
Returns the DataMergeTextPlaceholder whose index follows the specified DataMergeTextPlaceholder in the collection.
obj DataMergeTextPlaceholder The DataMergeTextPlaceholder whose index comes before the desired DataMergeTextPlaceholder.
previousItem(
obj)
  → DataMergeTextPlaceholder
Returns the DataMergeTextPlaceholder with the index previous to the specified index.
obj DataMergeTextPlaceholder The index of the DataMergeTextPlaceholder that follows the desired DataMergeTextPlaceholder.
toSource(
)
  → string
Generates a string which, if executed, will return the DataMergeTextPlaceholder.