DataMergePreference

Data merge preferences.

Methods:

addEventListener, alertMissingImages, getElements, removeEventListener, toSource, toSpecifier

Objects:

ArrangeBy, Boolean, EventListeners, Events, Number, Object, RecordSelection, RecordsPerPage, String

Hierarchy:

Superclass: Preference

Class: DataMergePreference

Property Listing

Property

Type

Access

Description

arrangeBy

ArrangeBy

ArrangeBy.COLUMNS_FIRST

ArrangeBy.ROWS_FIRST

read/write

The order in which to arrange multiple records on the page in the target document.

bottomMargin

Number

String

read/write

The offset value of the bottom margin in the target document.

columnSpacing

Number

String

read/write

The amount of space between columns of records in the target document.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

leftMargin

Number

String

read/write

The offset value of the left margin in the target document.

parent

DataMerge

readonly

The parent of the DataMergePreference (a DataMerge).

properties

Object

read/write

A property that allows setting of several properties at the same time.

recordNumber

Number

read/write

The number of the record to merge. Note: Valid only when record selection is one record.

recordRange

String

read/write

The range of records to merge. Note: Valid only when record selection is range.

recordSelection

RecordSelection

RecordSelection.ALL_RECORDS

RecordSelection.ONE_RECORD

RecordSelection.RANGE

read/write

The records to merge.

recordsPerPage

RecordsPerPage

RecordsPerPage.MULTIPLE_RECORD

RecordsPerPage.SINGLE_RECORD

read/write

The number of records to place on each page in the document.

rightMargin

Number

String

read/write

The offset value of the right margin in the target document.

rowSpacing

Number

String

read/write

The amount of space between rows of records in the target document.

topMargin

Number

String

read/write

The offset value of the top margin in the target document.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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

File

The path to the output file.

DataMergePreference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

DataMerge.dataMergePreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

DataMergePreference.getElements()