Packagecom.adobe.indesign
Classpublic class DataMergeFields
InheritanceDataMergeFields Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
DataMergeFields
Public Methods
 MethodDefined By
  
Returns any DataMergeField in the collection.
DataMergeFields
  
count():Number
Displays the number of elements in the DataMergeField.
DataMergeFields
  
everyItem():Object
Returns every DataMergeField in the collection.
DataMergeFields
 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
  
Returns the first DataMergeField in the collection.
DataMergeFields
 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
 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
  
item(indexParam:Object = null):DataMergeField
Returns the DataMergeField with the specified index or name.
DataMergeFields
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the DataMergeFields within the specified range.
DataMergeFields
  
Returns the last DataMergeField in the collection.
DataMergeFields
  
Returns the middle DataMergeField in the collection.
DataMergeFields
  
Returns the DataMergeField whose index follows the specified DataMergeField in the collection.
DataMergeFields
  
Returns the DataMergeField with the index previous to the specified index.
DataMergeFields
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 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
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
DataMergeFields
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
DataMergeFields
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
anyItem()method
public function anyItem():DataMergeField

Returns any DataMergeField in the collection.

Returns
DataMergeField
count()method 
public function count():Number

Displays the number of elements in the DataMergeField.

Returns
Number
everyItem()method 
public function everyItem():Object

Returns every DataMergeField in the collection.

Returns
Object
firstItem()method 
public function firstItem():DataMergeField

Returns the first DataMergeField in the collection.

Returns
DataMergeField
item()method 
public function item(indexParam:Object = null):DataMergeField

Returns the DataMergeField with the specified index or name.

Parameters

indexParam:Object (default = null) — (Object) The index or name. Can accept: Long Integer or String.

Returns
DataMergeField
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

Returns the DataMergeFields within the specified range.

Parameters

fromParam:Object (default = null) — (Object) The DataMergeField, index, or name at the beginning of the range. Can accept: DataMergeField, Long Integer or String.
 
toParam:Object (default = null) — (Object) The DataMergeField, index, or name at the end of the range. Can accept: DataMergeField, Long Integer or String.

Returns
Object
lastItem()method 
public function lastItem():DataMergeField

Returns the last DataMergeField in the collection.

Returns
DataMergeField
middleItem()method 
public function middleItem():DataMergeField

Returns the middle DataMergeField in the collection.

Returns
DataMergeField
nextItem()method 
public function nextItem(objParam:DataMergeField = null):DataMergeField

Returns the DataMergeField whose index follows the specified DataMergeField in the collection.

Parameters

objParam:DataMergeField (default = null) — (DataMergeField) The DataMergeField whose index comes before the desired DataMergeField.

Returns
DataMergeField
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:DataMergeField = null):DataMergeField

Returns the DataMergeField with the index previous to the specified index.

Parameters

objParam:DataMergeField (default = null) — (DataMergeField) The index of the DataMergeField that follows the desired DataMergeField.

Returns
DataMergeField