DataMergeImagePlaceholder

An object that can contain a date merge image field.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, DataMergeField, EventListeners, Events, Number, Object, PageItem

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 DataMergeImagePlaceholder within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Document

readonly

The parent of the DataMergeImagePlaceholder (a Document).

placeholderPageItem

PageItem

readonly

The page item on which to place the placeholder.

properties

Object

read/write

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

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)

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

DataMergeImagePlaceholders.add()

DataMergeImagePlaceholder.getElements()

DataMergeImagePlaceholders.anyItem()

DataMergeImagePlaceholders.everyItem()

DataMergeImagePlaceholders.nextItem()

DataMergeImagePlaceholders.previousItem()

DataMergeImagePlaceholders.item()

DataMergeImagePlaceholders.[]()

DataMergeImagePlaceholders.itemByRange()

DataMergeImagePlaceholders.firstItem()

DataMergeImagePlaceholders.lastItem()

DataMergeImagePlaceholders.middleItem()