DataMergeOption

Data merge options.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Fitting, Number, Object

Hierarchy:

Superclass: Preference

Class: DataMergeOption

Property Listing

Property

Type

Access

Description

centerImage

Boolean

read/write

If true, centers the image in the frame; preserves the frame size as well as content size and proportions. Note: If the content is larger than the frame, content around the edges is obscured by the bounding box of the frame. This doesn't work with fittingOption CONTENT_AWARE_FIT

createNewDocument

Boolean

read/write

If true, creates a new document when records are merged.

documentSize

Number

read/write

The maximum number of pages per document.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

fittingOption

Fitting

Fitting.CONTENT_AWARE_FITTING

Fitting.FILL_PROPORTIONAL

Fitting.FIT_CONTENT_TO_FRAME

Fitting.FIT_FRAME_TO_CONTENT

Fitting.HONOUR_EXISTING_STYLE

Fitting.PRESERVE_SIZES

Fitting.PROPORTIONAL

read/write

Instructions for fitting content in a frame.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

linkImages

Boolean

read/write

If true, links images to the target document. If false, embeds images in the target document.

parent

Application

Document

readonly

The parent of the DataMergeOption (a Application or Document).

properties

Object

read/write

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

removeBlankLines

Boolean

read/write

If true, removes blank lines caused by empty fields.

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)

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.dataMergeOptions

Document.dataMergeOptions

Event.parent

EventListener.parent

MutationEvent.parent

Return

DataMergeOption.getElements()