Adobe InDesign CS5 Server (7.0) Object Model JS: DataMergeImagePlaceholder

InDesign Server CS5

Class

DataMergeImagePlaceholder

 An object that can contain a date merge image field.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Document
DataMergeImagePlaceholder
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents 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 DataMergeImagePlaceholder within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentDocument readonlyThe parent of the DataMergeImagePlaceholder (a Document).
placeholderPageItemPageItem readonlyThe page item on which to place the placeholder.
propertiesObject r/wA property that allows setting of several properties at the same time.

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 DataMergeImagePlaceholder 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 DataMergeImagePlaceholder.

string toSpecifier ()
Retrieves the object specifier.

Used in:

DataMergeImagePlaceholder DataMergeImagePlaceholders.nextItem (obj: DataMergeImagePlaceholder)

DataMergeImagePlaceholder DataMergeImagePlaceholders.previousItem (obj: DataMergeImagePlaceholder)

Return

Array of DataMergeImagePlaceholder DataMergeImagePlaceholder.getElements ()

DataMergeImagePlaceholder DataMergeImagePlaceholders.[] (index: number)

DataMergeImagePlaceholder DataMergeImagePlaceholders.add (placeholder: PageItem, field: DataMergeField[, withProperties: Object])

DataMergeImagePlaceholder DataMergeImagePlaceholders.anyItem ()

Array of DataMergeImagePlaceholder DataMergeImagePlaceholders.everyItem ()

DataMergeImagePlaceholder DataMergeImagePlaceholders.firstItem ()

DataMergeImagePlaceholder DataMergeImagePlaceholders.item (index: varies)

Array of DataMergeImagePlaceholder DataMergeImagePlaceholders.itemByRange (from: varies, to: varies)

DataMergeImagePlaceholder DataMergeImagePlaceholders.lastItem ()

DataMergeImagePlaceholder DataMergeImagePlaceholders.middleItem ()

DataMergeImagePlaceholder DataMergeImagePlaceholders.nextItem (obj: DataMergeImagePlaceholder)

DataMergeImagePlaceholder DataMergeImagePlaceholders.previousItem (obj: DataMergeImagePlaceholder)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index