Packagecom.adobe.indesign
Classpublic class TextVariable
InheritanceTextVariable Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  associatedInstances : Object
[read-only] Variable instances associated with the text variable.
TextVariable
  eventListeners : EventListeners
[read-only] A collection of event listeners.
TextVariable
  events : Events
[read-only] A collection of events.
TextVariable
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the TextVariable within its containing object.
TextVariable
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
TextVariable
  name : String
The name of the TextVariable.
TextVariable
  parent : Object
[read-only] The parent of the TextVariable (a Application or Document).
TextVariable
  preferences : Preferences
[read-only] A collection of preferences objects.
TextVariable
  properties : Object
A property that allows setting of several properties at the same time.
TextVariable
  variableOptions : Object
[read-only] The preferences associated with the text variable.
TextVariable
  variableType : VariableTypes
The variable type.
TextVariable
Public Methods
 MethodDefined By
  
addEventListenerTextVariable(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
TextVariable
  
convertToText():Object
Convert all of this variable's instances to text.
TextVariable
 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
Resolves the object specifier, creating an array of object references.
TextVariable
 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
  
remove():void
Deletes the TextVariable.
TextVariable
  
removeEventListenerTextVariable(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TextVariable
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
TextVariable
 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
associatedInstancesproperty
associatedInstances:Object  [read-only]

Variable instances associated with the text variable.


Implementation
    public function get associatedInstances():Object
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
indexproperty 
index:Number  [read-only]

The index of the TextVariable within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
nameproperty 
name:String

The name of the TextVariable.


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

The parent of the TextVariable (a Application or Document).


Implementation
    public function get parent():Object
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
propertiesproperty 
properties:Object

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
variableOptionsproperty 
variableOptions:Object  [read-only]

The preferences associated with the text variable. Can return: PageNumberVariablePreference, ChapterNumberVariablePreference, DateVariablePreference, FileNameVariablePreference, MatchCharacterStylePreference, MatchParagraphStylePreference, CustomTextVariablePreference or CaptionMetadataVariablePreference.


Implementation
    public function get variableOptions():Object
variableTypeproperty 
variableType:VariableTypes

The variable type.


Implementation
    public function get variableType():VariableTypes
    public function set variableType(value:VariableTypes):void
Method Detail
addEventListenerTextVariable()method
public function addEventListenerTextVariable(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
convertToText()method 
public function convertToText():Object

Convert all of this variable's instances to text.

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

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

Returns
Object
remove()method 
public function remove():void

Deletes the TextVariable.

removeEventListenerTextVariable()method 
public function removeEventListenerTextVariable(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 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String