K4 InDesign Javascript API Documentation

PreferencesDataMergePreference

Data merge preferences.

Extends

Instance Properties

Name Description Access
arrangeBy ArrangeBy The order in which to arrange multiple records on the page in the target document. read-write
bottomMargin Measurement Unit (Number or String)=any The offset value of the bottom margin in the target document. read-write
columnSpacing Measurement Unit (Number or String)=any The amount of space between columns of records in the target document. read-write
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
leftMargin Measurement Unit (Number or String)=any The offset value of the left margin in the target document. read-write
parent DataMerge The parent of the DataMergePreference (a DataMerge). read-only
properties Object A property that allows setting of several properties at the same time. read-write
recordNumber number The number of the record to merge. Note: Valid only when record selection is one record. read-write
recordRange string The range of records to merge. Note: Valid only when record selection is range. read-write
recordSelection RecordSelection The records to merge. read-write
recordsPerPage RecordsPerPage The number of records to place on each page in the document. read-write
rightMargin Measurement Unit (Number or String)=any The offset value of the right margin in the target document. read-write
rowSpacing Measurement Unit (Number or String)=any The amount of space between rows of records in the target document. read-write
topMargin Measurement Unit (Number or String)=any The offset value of the top margin in the target document. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
alertMissingImages(
outputMissingImagesReportFile)
  → bool
getElements(
)
  → DataMergePreference
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)
alertMissingImages(
outputMissingImagesReportFile)
  → bool
If true, lists missing images in the specified output file.
outputMissingImagesReportFile File The path to the output file.
getElements(
)
  → DataMergePreference
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 DataMergePreference.
toSpecifier(
)
  → string
Retrieves the object specifier.