K4 InDesign Javascript API Documentation

PreferencesDataMerge

A data merge object.

Extends

Instance Properties

Name Description Access
dataMergeFields DataMergeFields A collection of data merge fields. read-only
dataMergePreferences DataMergePreference The data merge preference properties that define the layout and content of the target page. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent Document The parent of the DataMerge (a Document). read-only
preferences Preferences A collection of preferences objects. read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
exportFile(
to ​[, using] ​[, outputOversetReportFile])
getElements(
)
  → DataMerge
mergeRecords(
[outputOversetReportFile])
removeDataSource(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
selectDataSource(
dataSourceFile)
toSource(
)
  → string
toSpecifier(
)
  → string
updateDataSource(
)
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
exportFile(
to ​[, using] ​[, outputOversetReportFile])
Merges records and exports to PDF.
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)
getElements(
)
  → DataMerge
Resolves the object specifier, creating an array of object references.
mergeRecords(
[outputOversetReportFile])
Merges records and produces an optional overset report.
outputOversetReportFile File The path to the file in which to store the overset report. (Optional)
removeDataSource(
)
Removes the data source.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
selectDataSource(
dataSourceFile)
Specifies the file to use as the data source.
dataSourceFile File The path to the data source file.
toSource(
)
  → string
Generates a string which, if executed, will return the DataMerge.
toSpecifier(
)
  → string
Retrieves the object specifier.
updateDataSource(
)
Updates the data source file with the most current data.