Package | com.adobe.indesign |
Class | public class DataMerge |
Inheritance | DataMerge ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerDataMerge(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | DataMerge | ||
![]() | 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 | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | ||
removeDataSource():void
Removes the data source. | DataMerge | ||
removeEventListenerDataMerge(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | DataMerge | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | 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 | ||
updateDataSource():void
Updates the data source file with the most current data. | DataMerge | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
dataMergeFields | property |
dataMergeFields:DataMergeFields
[read-only] Since : | CS5 |
A collection of data merge fields.
public function get dataMergeFields():DataMergeFields
dataMergePreferences | property |
dataMergePreferences:DataMergePreference
[read-only] Since : | CS5 |
The data merge preference properties that define the layout and content of the target page.
public function get dataMergePreferences():DataMergePreference
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the DataMerge (a Document).
public function get parent():Object
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
addEventListenerDataMerge | () | method |
public function addEventListenerDataMerge(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
exportFile | () | method |
public function exportFile(toParam:File = null, usingParam:PDFExportPreset = null, outputOversetReportFileParam:File = null):void
Since : | CS5 |
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
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
mergeRecords | () | method |
public function mergeRecords(outputOversetReportFileParam:File = null):void
Since : | CS5 |
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
Since : | CS5 |
Removes the data source.
removeEventListenerDataMerge | () | method |
public function removeEventListenerDataMerge(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
selectDataSource | () | method |
public function selectDataSource(dataSourceFileParam:File = null):void
Since : | CS5 |
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
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
updateDataSource | () | method |
public function updateDataSource():void
Since : | CS5 |
Updates the data source file with the most current data.