DataMergeTextPlaceholder

An object that can contain a data merge text field.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, DataMergeField, EventListeners, Events, InsertionPoint, Number, Object, Story

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

field

DataMergeField

readonly

The data merge field to insert in the placeholder. For information, see data merge text placeholder and data merge image placeholder.

index

Number

readonly

The index of the DataMergeTextPlaceholder within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

length

Number

readonly

The number of objects in the collection.

parent

Document

readonly

The parent of the DataMergeTextPlaceholder (a Document).

parentStory

Story

readonly

The story that contains the text.

properties

Object

read/write

A property that allows setting of several properties at the same time.

storyOffset

InsertionPoint

readonly

The insertion point before the table in the story containing the table.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

DataMergeTextPlaceholder getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

DataMergeTextPlaceholders.add()

DataMergeTextPlaceholder.getElements()

DataMergeTextPlaceholders.anyItem()

DataMergeTextPlaceholders.everyItem()

DataMergeTextPlaceholders.nextItem()

DataMergeTextPlaceholders.previousItem()

DataMergeTextPlaceholders.item()

DataMergeTextPlaceholders.[]()

DataMergeTextPlaceholders.itemByRange()

DataMergeTextPlaceholders.firstItem()

DataMergeTextPlaceholders.lastItem()

DataMergeTextPlaceholders.middleItem()