InDesign Server2025
API 20.5.0.49
Object

DataMergeOption

Data merge options.

Preference DataMergeOption
Hierarchy

Application | Document

DataMergeOption

Properties

NameType AccessDescription
Boolean read/write If true, centers the image in the frame; preserves the frame size as well as content size and proportions. Note: If the content is larger than the frame, content around the edges is obscured by the bounding box of the frame. This doesn't work with fittingOption CONTENT_AWARE_FIT
Boolean read/write If true, creates a new document when records are merged.
Number read/write The maximum number of pages per document.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Fitting
read/write Instructions for fitting content in a frame.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Boolean read/write If true, links images to the target document. If false, embeds images in the target document.
Application | Document readonly The parent of the DataMergeOption (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write If true, removes blank lines caused by empty fields.

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.
DataMergeOption[]

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

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a DataMergeOption.

Return 1

Methods that return a DataMergeOption.