DataMerge

Methods:

addEventListener, exportFile, getElements, mergeRecords, removeDataSource, removeEventListener, selectDataSource, toSource, toSpecifier, updateDataSource

Objects:

Boolean, DataMergeFields, DataMergePreference, EventListeners, Events, Object, Preferences

Preferences:

DataMergePreference, Preferences

Hierarchy:

Superclass: Preference

Class: DataMerge

Property Listing

Property	Type	Access	Description
dataMergeFields	DataMergeFields DataMergeField	readonly	A collection of data merge fields.
dataMergePreferences	DataMergePreference	readonly	The data merge preference properties that define the layout and content of the target page.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
parent	Document	readonly	The parent of the DataMerge (a Document).
preferences	Preferences Preference	readonly	A collection of preferences objects.
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)

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)

undefined exportFile (to:File, using:PDFExportPreset, outputOversetReportFile:File)

Merges records and exports to PDF.

Parameter	Type	Description
to	File	The path of exported PDF file.
using	PDFExportPreset	The PDF export style to use. (Optional)
outputOversetReportFile	File	The path to the file in which to store the overset report. (Optional)

DataMerge getElements ()

Resolves the object specifier, creating an array of object references.

undefined mergeRecords (outputOversetReportFile:File)

Merges records and produces an optional overset report.

Parameter	Type	Description
outputOversetReportFile	File	The path to the file in which to store the overset report. (Optional)

undefined removeDataSource ()

Removes the data source.

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)