K4 InDesign Javascript API Documentation

DatamergeDataMergeTextPlaceholder

An object that can contain a data merge text field.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
field DataMergeField The data merge field to insert in the placeholder. For information, see data merge text placeholder and data merge image placeholder. read-only
index number The index of the DataMergeTextPlaceholder within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
length number The number of objects in the collection. read-only
parent Document The parent of the DataMergeTextPlaceholder (a Document). read-only
parentStory Story The story that contains the text. read-only
properties Object A property that allows setting of several properties at the same time. read-write
storyOffset InsertionPoint The insertion point before the table in the story containing the table. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → DataMergeTextPlaceholder
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → DataMergeTextPlaceholder
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the DataMergeTextPlaceholder.
toSpecifier(
)
  → string
Retrieves the object specifier.