Class

DataMerge

 A data merge object. Base Class: Preference

QuickLinks

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

Hierarchy

Document
Preference
DataMerge
DataMergeField | DataMergePreference | Event | EventListener | MutationEvent | Preference

Properties

PropertyTypeAccessDescription
dataMergeFieldsDataMergeFields readonlyA collection of data merge fields.
dataMergePreferencesDataMergePreference readonlyThe data merge preference properties that define the layout and content of the target page.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentDocument readonlyThe parent of the DataMerge (a Document).
preferencesPreferences readonlyA collection of preferences objects.
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)

void exportFile (to: File[, using: PDFExportPreset][, outputOversetReportFile: File])
Merges records and exports to PDF.

ParameterTypeDescription
toFileThe path of exported PDF file.
usingPDFExportPresetThe PDF export style to use. (Optional)
outputOversetReportFileFileThe 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.

ParameterTypeDescription
outputOversetReportFileFileThe 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.

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)

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

ParameterTypeDescription
dataSourceFileFileThe 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.

Element of

DataMergeField.parent

DataMergePreference.parent

Document.dataMergeProperties

Preference.parent

Return

Array of DataMerge DataMerge.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index