DataMerge

A data merge object. Base Class: Preference

DataMerge

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	bool	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	r/w	A property that allows setting of several properties at the same time.

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void 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)

Array of DataMerge getElements ()
Resolves the object specifier, creating an array of object references.

void 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)

void removeDataSource ()
Removes the data source.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void selectDataSource (dataSourceFile: File)
Specifies the file to use as the data source.

Parameter	Type	Description
dataSourceFile	File	The path to the data source file.

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

string toSpecifier ()
Retrieves the object specifier.

void updateDataSource ()
Updates the data source file with the most current data.

Document.dataMergeProperties

Array of DataMerge DataMerge.getElements ()

Jongware, 28-Apr-2012 v3.0.3i