Adobe InDesign CS6 Server (8.0) Object Model JS: DataMergeTextPlaceholder

InDesign Server CS6

Class

DataMergeTextPlaceholder

 An object that can contain a data merge text field.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Document
DataMergeTextPlaceholder
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
fieldDataMergeField readonlyThe data merge field to insert in the placeholder. For information, see data merge text placeholder and data merge image placeholder.
indexnumber readonlyThe index of the DataMergeTextPlaceholder within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
lengthnumber readonlyThe number of objects in the collection.
parentDocument readonlyThe parent of the DataMergeTextPlaceholder (a Document).
parentStoryStory readonlyThe story that contains the text.
propertiesObject r/wA property that allows setting of several properties at the same time.
storyOffsetInsertionPoint readonlyThe insertion point before the table in the story containing the table.

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

DataMergeTextPlaceholder DataMergeTextPlaceholders.nextItem (obj: DataMergeTextPlaceholder)

DataMergeTextPlaceholder DataMergeTextPlaceholders.previousItem (obj: DataMergeTextPlaceholder)

Return

Array of DataMergeTextPlaceholder DataMergeTextPlaceholder.getElements ()

DataMergeTextPlaceholder DataMergeTextPlaceholders.[] (index: number)

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

DataMergeTextPlaceholder DataMergeTextPlaceholders.anyItem ()

Array of DataMergeTextPlaceholder DataMergeTextPlaceholders.everyItem ()

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.3iContents :: Index