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

InDesign Server CS5

Class

DataMergeOption

 Data merge options. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
DataMergeOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
centerImagebool r/wIf 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.
createNewDocumentbool r/wIf true, creates a new document when records are merged.
documentSizenumber r/wThe maximum number of pages per document.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fittingOptionFitting:
Fitting.PROPORTIONAL
Fitting.FIT_CONTENT_TO_FRAME
Fitting.FIT_FRAME_TO_CONTENT
Fitting.PRESERVE_SIZES
Fitting.FILL_PROPORTIONAL
r/wInstructions for fitting content in a frame.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
linkImagesbool r/wIf true, links images to the target document. If false, embeds images in the target document.
parentApplication
Document
readonlyThe parent of the DataMergeOption (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
removeBlankLinesbool r/wIf true, removes blank lines caused by empty fields.

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)

Array of DataMergeOption 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 DataMergeOption.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.dataMergeOptions

Document.dataMergeOptions

Return

Array of DataMergeOption DataMergeOption.getElements ()

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