Packagecom.adobe.indesign
Classpublic class TextVariables
InheritanceTextVariables 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.
TextVariables
Public Methods
 MethodDefined By
  
add(withPropertiesParam:Object = null):TextVariable
Creates a new TextVariable.
TextVariables
  
Returns any TextVariable in the collection.
TextVariables
  
count():Number
Displays the number of elements in the TextVariable.
TextVariables
  
everyItem():Object
Returns every TextVariable in the collection.
TextVariables
 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 TextVariable in the collection.
TextVariables
 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):TextVariable
Returns the TextVariable with the specified index or name.
TextVariables
  
itemByName(nameParam:String = null):TextVariable
Returns the TextVariable with the specified name.
TextVariables
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the TextVariables within the specified range.
TextVariables
  
Returns the last TextVariable in the collection.
TextVariables
  
Returns the middle TextVariable in the collection.
TextVariables
  
Returns the TextVariable whose index follows the specified TextVariable in the collection.
TextVariables
  
Returns the TextVariable with the index previous to the specified index.
TextVariables
 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
TextVariables
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
TextVariables
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(withPropertiesParam:Object = null):TextVariable

Creates a new TextVariable.

Parameters

withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new TextVariable (Optional)

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

Returns any TextVariable in the collection.

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

Displays the number of elements in the TextVariable.

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

Returns every TextVariable in the collection.

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

Returns the first TextVariable in the collection.

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

Returns the TextVariable with the specified index or name.

Parameters

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

Returns
TextVariable
itemByName()method 
public function itemByName(nameParam:String = null):TextVariable

Returns the TextVariable with the specified name.

Parameters

nameParam:String (default = null) — (String) The name.

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

Returns the TextVariables within the specified range.

Parameters

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

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

Returns the last TextVariable in the collection.

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

Returns the middle TextVariable in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
TextVariable