Data merge preferences.
Go to Property Listing | Method Listing
alertMissingImages, toSource, getElements, toSpecifier, addEventListener, removeEventListener
ArrangeBy, Boolean, DataMerge, EventListeners, Events, Number, Object, RecordSelection, RecordsPerPage, String,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
arrangeBy |
ArrangeBy.ROWS_FIRST ArrangeBy.COLUMNS_FIRST |
read/write |
The order in which to arrange multiple records on the page in the target document. |
|
bottomMargin |
read/write |
The offset value of the bottom margin in the target document. |
|
|
columnSpacing |
read/write |
The amount of space between columns of records in the target document. |
|
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
leftMargin |
read/write |
The offset value of the left margin in the target document. |
|
|
parent |
readonly |
The parent of the DataMergePreference (a DataMerge). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
recordNumber |
read/write |
The number of the record to merge. Note: Valid only when record selection is one record. |
|
|
recordRange |
read/write |
The range of records to merge. Note: Valid only when record selection is range. |
|
|
recordSelection |
RecordSelection.ALL_RECORDS RecordSelection.ONE_RECORD RecordSelection.RANGE |
read/write |
The records to merge. |
|
recordsPerPage |
RecordsPerPage.SINGLE_RECORD RecordsPerPage.MULTIPLE_RECORD |
read/write |
The number of records to place on each page in the document. |
|
rightMargin |
read/write |
The offset value of the right margin in the target document. |
|
|
rowSpacing |
read/write |
The amount of space between rows of records in the target document. |
|
|
topMargin |
read/write |
The offset value of the top margin in the target document. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
Boolean alertMissingImages (outputMissingImagesReportFile:File)
If true, lists missing images in the specified output file.
|
Parameter |
Type |
Description |
|---|---|---|
|
outputMissingImagesReportFile |
The path to the output file. |
DataMergePreference getElements ()
Resolves the object specifier, creating an array of object references.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the DataMergePreference.
String toSpecifier ()
Retrieves the object specifier.