DataMergeTextPlaceholder

An object that can contain a data merge text field.

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	bool	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	r/w	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.

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of DataMergeTextPlaceholder getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	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.

DataMergeTextPlaceholder DataMergeTextPlaceholders.nextItem (obj: DataMergeTextPlaceholder)

DataMergeTextPlaceholder DataMergeTextPlaceholders.previousItem (obj: DataMergeTextPlaceholder)

Array of DataMergeTextPlaceholder DataMergeTextPlaceholder.getElements ()

DataMergeTextPlaceholder DataMergeTextPlaceholders.[] (index: number)

DataMergeTextPlaceholder DataMergeTextPlaceholders.add (parentStory: Story, storyOffset: varies, field: DataMergeField[, withProperties: Object])

DataMergeTextPlaceholder DataMergeTextPlaceholders.anyItem ()

DataMergeTextPlaceholder DataMergeTextPlaceholders.firstItem ()

DataMergeTextPlaceholder DataMergeTextPlaceholders.item (index: varies)

Array of DataMergeTextPlaceholder DataMergeTextPlaceholders.itemByRange (from: varies, to: varies)

DataMergeTextPlaceholder DataMergeTextPlaceholders.lastItem ()

DataMergeTextPlaceholder DataMergeTextPlaceholders.middleItem ()

DataMergeTextPlaceholder DataMergeTextPlaceholders.nextItem (obj: DataMergeTextPlaceholder)

DataMergeTextPlaceholder DataMergeTextPlaceholders.previousItem (obj: DataMergeTextPlaceholder)

Jongware, 28-Apr-2012 v3.0.3i