Adobe InDesign CS2 (4.0) Object Model JS: DataMerge

InDesign CS2

Class

DataMerge

 A data merge object.

QuickLinks

getElements, mergeRecords, removeDataSource, selectDataSource, toSource, toSpecifier, updateDataSource

Hierarchy

Document
DataMerge
DataMergeField | DataMergePreference

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.
parentDocument readonlyThe parent of the DataMerge (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

Array of Object 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.

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

Jongware, 27-Jun-2010 v3.0.3dContents :: Index