InDesign2026
API 21.5.1.73

DataMergeTextPlaceholders

A collection of data merge text placeholders.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

→ DataMergeTextPlaceholder

Creates a data merge text placeholder.

parentStory Story The story in which to insert the placeholder.
storyOffset InsertionPoint | LongInteger 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
→ Number

Displays the number of elements in the DataMergeTextPlaceholder.

→ DataMergeTextPlaceholder

Returns the DataMergeTextPlaceholder with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
→ DataMergeTextPlaceholder[]

Returns the DataMergeTextPlaceholders within the specified range.

from DataMergeTextPlaceholder | LongInteger | String The DataMergeTextPlaceholder, index, or name at the beginning of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String.
to DataMergeTextPlaceholder | LongInteger | String The DataMergeTextPlaceholder, index, or name at the end of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String.
→ DataMergeTextPlaceholder

Returns the DataMergeTextPlaceholder whose index follows the specified DataMergeTextPlaceholder in the collection.

obj DataMergeTextPlaceholder The DataMergeTextPlaceholder whose index comes before the desired DataMergeTextPlaceholder.
→ DataMergeTextPlaceholder

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

obj DataMergeTextPlaceholder The index of the DataMergeTextPlaceholder that follows the desired DataMergeTextPlaceholder.
→ String

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

Object of 1

Properties elsewhere that hold a DataMergeTextPlaceholders.