K4 InDesign Javascript API Documentation

PreferencesDataMergeOption

Data merge options.

Extends

Instance Properties

Name Description Access
centerImage bool 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. read-write
createNewDocument bool If true, creates a new document when records are merged. read-write
documentSize number The maximum number of pages per document. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fittingOption Fitting Instructions for fitting content in a frame. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
linkImages bool If true, links images to the target document. If false, embeds images in the target document. read-write
parent The parent of the DataMergeOption (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
removeBlankLines bool If true, removes blank lines caused by empty fields. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → DataMergeOption
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
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)
getElements(
)
  → DataMergeOption
Resolves the object specifier, creating an array of object references.
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)
toSource(
)
  → string
Generates a string which, if executed, will return the DataMergeOption.
toSpecifier(
)
  → string
Retrieves the object specifier.