Package | com.adobe.indesign |
Class | public class DataMergePreference |
Inheritance | DataMergePreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
arrangeBy : ArrangeBy
The order in which to arrange multiple records on the page in the target document. | DataMergePreference | ||
bottomMargin : Object
The offset value of the bottom margin in the target document. | DataMergePreference | ||
columnSpacing : Object
The amount of space between columns of records in the target document. | DataMergePreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | DataMergePreference | ||
events : Events [override] [read-only]
A collection of events. | DataMergePreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | DataMergePreference | ||
leftMargin : Object
The offset value of the left margin in the target document. | DataMergePreference | ||
parent : Object [override] [read-only]
The parent of the DataMergePreference (a DataMerge). | DataMergePreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | DataMergePreference | ||
recordNumber : Number
The number of the record to merge. | DataMergePreference | ||
recordRange : String
The range of records to merge. | DataMergePreference | ||
recordSelection : RecordSelection
The records to merge. | DataMergePreference | ||
recordsPerPage : RecordsPerPage
The number of records to place on each page in the document. | DataMergePreference | ||
rightMargin : Object
The offset value of the right margin in the target document. | DataMergePreference | ||
rowSpacing : Object
The amount of space between rows of records in the target document. | DataMergePreference | ||
topMargin : Object
The offset value of the top margin in the target document. | DataMergePreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerDataMergePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | DataMergePreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
alertMissingImages(outputMissingImagesReportFileParam:File = null):Boolean
If true, lists missing images in the specified output file. | DataMergePreference | ||
![]() | 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. | DataMergePreference | ||
![]() | 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 | |
removeEventListenerDataMergePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | DataMergePreference | ||
![]() | 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 | |
toSpecifier():String [override]
Retrieves the object specifier. | DataMergePreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
arrangeBy | property |
arrangeBy:ArrangeBy
Since : | CS5 |
The order in which to arrange multiple records on the page in the target document.
public function get arrangeBy():ArrangeBy
public function set arrangeBy(value:ArrangeBy):void
bottomMargin | property |
bottomMargin:Object
Since : | CS5 |
The offset value of the bottom margin in the target document.
public function get bottomMargin():Object
public function set bottomMargin(value:Object):void
columnSpacing | property |
columnSpacing:Object
Since : | CS5 |
The amount of space between columns of records in the target document.
public function get columnSpacing():Object
public function set columnSpacing(value:Object):void
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
leftMargin | property |
leftMargin:Object
Since : | CS5 |
The offset value of the left margin in the target document.
public function get leftMargin():Object
public function set leftMargin(value:Object):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the DataMergePreference (a DataMerge).
public function get parent():Object
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
recordNumber | property |
recordNumber:Number
Since : | CS5 |
The number of the record to merge. Note: Valid only when record selection is one record.
public function get recordNumber():Number
public function set recordNumber(value:Number):void
recordRange | property |
recordRange:String
Since : | CS5 |
The range of records to merge. Note: Valid only when record selection is range.
public function get recordRange():String
public function set recordRange(value:String):void
recordSelection | property |
recordSelection:RecordSelection
Since : | CS5 |
The records to merge.
public function get recordSelection():RecordSelection
public function set recordSelection(value:RecordSelection):void
recordsPerPage | property |
recordsPerPage:RecordsPerPage
Since : | CS5 |
The number of records to place on each page in the document.
public function get recordsPerPage():RecordsPerPage
public function set recordsPerPage(value:RecordsPerPage):void
rightMargin | property |
rightMargin:Object
Since : | CS5 |
The offset value of the right margin in the target document.
public function get rightMargin():Object
public function set rightMargin(value:Object):void
rowSpacing | property |
rowSpacing:Object
Since : | CS5 |
The amount of space between rows of records in the target document.
public function get rowSpacing():Object
public function set rowSpacing(value:Object):void
topMargin | property |
topMargin:Object
Since : | CS5 |
The offset value of the top margin in the target document.
public function get topMargin():Object
public function set topMargin(value:Object):void
addEventListenerDataMergePreference | () | method |
public function addEventListenerDataMergePreference(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 |
alertMissingImages | () | method |
public function alertMissingImages(outputMissingImagesReportFileParam:File = null):Boolean
Since : | CS5 |
If true, lists missing images in the specified output file.
Parameters
outputMissingImagesReportFileParam:File (default = null ) — (File) The path to the output file.
|
Boolean |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerDataMergePreference | () | method |
public function removeEventListenerDataMergePreference(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 |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |