Packagecom.adobe.indesign
Classpublic class DataMerge
InheritanceDataMerge Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  dataMergeFields : DataMergeFields
[read-only] A collection of data merge fields.
DataMerge
  dataMergePreferences : DataMergePreference
[read-only] The data merge preference properties that define the layout and content of the target page.
DataMerge
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
DataMerge
  events : Events
[override] [read-only] A collection of events.
DataMerge
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
DataMerge
  parent : Object
[override] [read-only] The parent of the DataMerge (a Document).
DataMerge
  preferences : Preferences
[read-only] A collection of preferences objects.
DataMerge
  properties : Object
[override] A property that allows setting of several properties at the same time.
DataMerge
Public Methods
 MethodDefined By
  
addEventListenerDataMerge(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
DataMerge
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
exportFile(toParam:File = null, usingParam:PDFExportPreset = null, outputOversetReportFileParam:File = null):void
Merges records and exports to PDF.
DataMerge
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
DataMerge
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
mergeRecords(outputOversetReportFileParam:File = null):void
Merges records and produces an optional overset report.
DataMerge
  
Removes the data source.
DataMerge
  
removeEventListenerDataMerge(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
DataMerge
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
selectDataSource(dataSourceFileParam:File = null):void
Specifies the file to use as the data source.
DataMerge
  
toSpecifier():String
[override] Retrieves the object specifier.
DataMerge
  
Updates the data source file with the most current data.
DataMerge
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
dataMergeFieldsproperty
dataMergeFields:DataMergeFields  [read-only]

A collection of data merge fields.


Implementation
    public function get dataMergeFields():DataMergeFields
dataMergePreferencesproperty 
dataMergePreferences:DataMergePreference  [read-only]

The data merge preference properties that define the layout and content of the target page.


Implementation
    public function get dataMergePreferences():DataMergePreference
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Object  [read-only] [override]

The parent of the DataMerge (a Document).


Implementation
    public function get parent():Object
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
propertiesproperty 
properties:Object[override]

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
Method Detail
addEventListenerDataMerge()method
public function addEventListenerDataMerge(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
exportFile()method 
public function exportFile(toParam:File = null, usingParam:PDFExportPreset = null, outputOversetReportFileParam:File = null):void

Merges records and exports to PDF.

Parameters

toParam:File (default = null) — (File) The path of exported PDF file.
 
usingParam:PDFExportPreset (default = null) — (PDFExportPreset) The PDF export style to use. (Optional)
 
outputOversetReportFileParam:File (default = null) — (File) The path to the file in which to store the overset report. (Optional)

getElements()method 
override public function getElements():Object

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

Returns
Object
mergeRecords()method 
public function mergeRecords(outputOversetReportFileParam:File = null):void

Merges records and produces an optional overset report.

Parameters

outputOversetReportFileParam:File (default = null) — (File) The path to the file in which to store the overset report. (Optional)

removeDataSource()method 
public function removeDataSource():void

Removes the data source.

removeEventListenerDataMerge()method 
public function removeEventListenerDataMerge(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
selectDataSource()method 
public function selectDataSource(dataSourceFileParam:File = null):void

Specifies the file to use as the data source.

Parameters

dataSourceFileParam:File (default = null) — (File) The path to the data source file.

toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String
updateDataSource()method 
public function updateDataSource():void

Updates the data source file with the most current data.