InDesign2026
API 21.5.1.73
Object

DataMergePreference

Data merge preferences.

Preference DataMergePreference
Hierarchy

DataMerge

DataMergePreference

Properties

NameType AccessDescription
ArrangeBy
read/write The order in which to arrange multiple records on the page in the target document.
Number | String unit read/write The offset value of the bottom margin in the target document.
Number | String unit read/write The amount of space between columns of records in the target document.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Number | String unit read/write The offset value of the left margin in the target document.
DataMerge readonly The parent of the DataMergePreference (a DataMerge).
Object read/write A property that allows setting of several properties at the same time.
Number read/write The number of the record to merge. Note: Valid only when record selection is one record.
String read/write The range of records to merge. Note: Valid only when record selection is range.
RecordSelection
read/write The records to merge.
RecordsPerPage
read/write The number of records to place on each page in the document.
Number | String unit read/write The offset value of the right margin in the target document.
Number | String unit read/write The amount of space between rows of records in the target document.
Number | String unit read/write The offset value of the top margin in the target document.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
Boolean

If true, lists missing images in the specified output file.

outputMissingImagesReportFile File The path to the output file.
DataMergePreference[]

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

Boolean

Removes the event listener.

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.
String

Generates a string which, if executed, will return the DataMergePreference.

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a DataMergePreference.

Return 1

Methods that return a DataMergePreference.