Adobe InDesign CS5 Server (7.0) Object Model JS: DataMergePreference

InDesign Server CS5

Class

DataMergePreference

 Data merge preferences. Base Class: Preference

QuickLinks

addEventListener, alertMissingImages, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

DataMerge
Preference
DataMergePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
arrangeByArrangeBy:
ArrangeBy.ROWS_FIRST
ArrangeBy.COLUMNS_FIRST
r/wThe order in which to arrange multiple records on the page in the target document.
bottomMarginMeasurement Unit (Number or String) r/wThe offset value of the bottom margin in the target document.
columnSpacingMeasurement Unit (Number or String) r/wThe amount of space between columns of records in the target document.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
leftMarginMeasurement Unit (Number or String) r/wThe offset value of the left margin in the target document.
parentDataMerge readonlyThe parent of the DataMergePreference (a DataMerge).
propertiesObject r/wA property that allows setting of several properties at the same time.
recordNumbernumber r/wThe number of the record to merge. Note: Valid only when record selection is one record.
recordRangestring r/wThe range of records to merge. Note: Valid only when record selection is range.
recordSelectionRecordSelection:
RecordSelection.ALL_RECORDS
RecordSelection.ONE_RECORD
RecordSelection.RANGE
r/wThe records to merge.
recordsPerPageRecordsPerPage:
RecordsPerPage.SINGLE_RECORD
RecordsPerPage.MULTIPLE_RECORD
r/wThe number of records to place on each page in the document.
rightMarginMeasurement Unit (Number or String) r/wThe offset value of the right margin in the target document.
rowSpacingMeasurement Unit (Number or String) r/wThe amount of space between rows of records in the target document.
topMarginMeasurement Unit (Number or String) r/wThe offset value of the top margin in the target document.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

bool alertMissingImages (outputMissingImagesReportFile: File)
If true, lists missing images in the specified output file.

ParameterTypeDescription
outputMissingImagesReportFileFileThe path to the output file.

Array of DataMergePreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

DataMerge.dataMergePreferences

Return

Array of DataMergePreference DataMergePreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index