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

Creates a data merge text placeholder.

Parameters

parentStoryParam:Story (default = null) — (Story) The story in which to insert the placeholder.
 
storyOffsetParam:Object (default = null) — (Object) The position within the story at which to insert the placeholder, specified as an offset number or an insertion point. Can accept: InsertionPoint or Long Integer.
 
fieldParam:DataMergeField (default = null) — (DataMergeField) The field to insert.
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new DataMergeTextPlaceholder (Optional)

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

Returns any DataMergeTextPlaceholder in the collection.

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

Displays the number of elements in the DataMergeTextPlaceholder.

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

Returns every DataMergeTextPlaceholder in the collection.

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

Returns the first DataMergeTextPlaceholder in the collection.

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

Returns the DataMergeTextPlaceholder with the specified index or name.

Parameters

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

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

Returns the DataMergeTextPlaceholders within the specified range.

Parameters

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

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

Returns the last DataMergeTextPlaceholder in the collection.

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

Returns the middle DataMergeTextPlaceholder in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
DataMergeTextPlaceholder