Packagecom.adobe.indesign
Classpublic class DataMergePreference
InheritanceDataMergePreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
Public Methods
 MethodDefined By
  
addEventListenerDataMergePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
DataMergePreference
 Inherited
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
 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.
DataMergePreference
 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
  
removeEventListenerDataMergePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
DataMergePreference
 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
  
toSpecifier():String
[override] Retrieves the object specifier.
DataMergePreference
 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
arrangeByproperty
arrangeBy:ArrangeBy

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


Implementation
    public function get arrangeBy():ArrangeBy
    public function set arrangeBy(value:ArrangeBy):void
bottomMarginproperty 
bottomMargin:Object

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


Implementation
    public function get bottomMargin():Object
    public function set bottomMargin(value:Object):void
columnSpacingproperty 
columnSpacing:Object

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


Implementation
    public function get columnSpacing():Object
    public function set columnSpacing(value:Object):void
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
leftMarginproperty 
leftMargin:Object

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


Implementation
    public function get leftMargin():Object
    public function set leftMargin(value:Object):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the DataMergePreference (a DataMerge).


Implementation
    public function get parent():Object
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
recordNumberproperty 
recordNumber:Number

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


Implementation
    public function get recordNumber():Number
    public function set recordNumber(value:Number):void
recordRangeproperty 
recordRange:String

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


Implementation
    public function get recordRange():String
    public function set recordRange(value:String):void
recordSelectionproperty 
recordSelection:RecordSelection

The records to merge.


Implementation
    public function get recordSelection():RecordSelection
    public function set recordSelection(value:RecordSelection):void
recordsPerPageproperty 
recordsPerPage:RecordsPerPage

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


Implementation
    public function get recordsPerPage():RecordsPerPage
    public function set recordsPerPage(value:RecordsPerPage):void
rightMarginproperty 
rightMargin:Object

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


Implementation
    public function get rightMargin():Object
    public function set rightMargin(value:Object):void
rowSpacingproperty 
rowSpacing:Object

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


Implementation
    public function get rowSpacing():Object
    public function set rowSpacing(value:Object):void
topMarginproperty 
topMargin:Object

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


Implementation
    public function get topMargin():Object
    public function set topMargin(value:Object):void
Method Detail
addEventListenerDataMergePreference()method
public function addEventListenerDataMergePreference(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
alertMissingImages()method 
public function alertMissingImages(outputMissingImagesReportFileParam:File = null):Boolean

If true, lists missing images in the specified output file.

Parameters

outputMissingImagesReportFileParam:File (default = null) — (File) The path to the output file.

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

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

Returns
Object
removeEventListenerDataMergePreference()method 
public function removeEventListenerDataMergePreference(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
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String