Packagecom.adobe.indesign
Classpublic class DataMergeImagePlaceholders
InheritanceDataMergeImagePlaceholders 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.
DataMergeImagePlaceholders
Public Methods
 MethodDefined By
  
add(placeholderParam:PageItem = null, fieldParam:DataMergeField = null, withPropertiesParam:Object = null):DataMergeImagePlaceholder
Creates a data merge image placeholder.
DataMergeImagePlaceholders
  
Returns any DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholders
  
count():Number
Displays the number of elements in the DataMergeImagePlaceholder.
DataMergeImagePlaceholders
  
everyItem():Object
Returns every DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholders
 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 DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholders
 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):DataMergeImagePlaceholder
Returns the DataMergeImagePlaceholder with the specified index or name.
DataMergeImagePlaceholders
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the DataMergeImagePlaceholders within the specified range.
DataMergeImagePlaceholders
  
Returns the last DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholders
  
Returns the middle DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholders
  
Returns the DataMergeImagePlaceholder whose index follows the specified DataMergeImagePlaceholder in the collection.
DataMergeImagePlaceholders
  
Returns the DataMergeImagePlaceholder with the index previous to the specified index.
DataMergeImagePlaceholders
 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
DataMergeImagePlaceholders
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
DataMergeImagePlaceholders
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(placeholderParam:PageItem = null, fieldParam:DataMergeField = null, withPropertiesParam:Object = null):DataMergeImagePlaceholder

Creates a data merge image placeholder.

Parameters

placeholderParam:PageItem (default = null) — (PageItem) The page item on which to place the placeholder.
 
fieldParam:DataMergeField (default = null) — (DataMergeField) The data merge field to insert.
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new DataMergeImagePlaceholder (Optional)

Returns
DataMergeImagePlaceholder
anyItem()method 
public function anyItem():DataMergeImagePlaceholder

Returns any DataMergeImagePlaceholder in the collection.

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

Displays the number of elements in the DataMergeImagePlaceholder.

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

Returns every DataMergeImagePlaceholder in the collection.

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

Returns the first DataMergeImagePlaceholder in the collection.

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

Returns the DataMergeImagePlaceholder with the specified index or name.

Parameters

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

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

Returns the DataMergeImagePlaceholders within the specified range.

Parameters

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

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

Returns the last DataMergeImagePlaceholder in the collection.

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

Returns the middle DataMergeImagePlaceholder in the collection.

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

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

Parameters

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

Returns
DataMergeImagePlaceholder
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:DataMergeImagePlaceholder = null):DataMergeImagePlaceholder

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

Parameters

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

Returns
DataMergeImagePlaceholder