Adobe InDesign CS4 (6.0) Object Model JS: TextVariables

InDesign CS4

Class

TextVariables

 A collection of text variables.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

TextVariable [] (index: number)
Returns the TextVariable with the specified index.

ParameterTypeDescription
indexnumberThe index.

TextVariable add ([withProperties: Object])
Creates a new TextVariable.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new TextVariable (Optional)

TextVariable anyItem ()
Returns any TextVariable in the collection.

number count ()
Displays the number of elements in the TextVariable.

Array of TextVariable everyItem ()
Returns every TextVariable in the collection.

TextVariable firstItem ()
Returns the first TextVariable in the collection.

TextVariable item (index: any)
Returns the TextVariable with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

TextVariable itemByName (name: string)
Returns the TextVariable with the specified name.

ParameterTypeDescription
namestringThe name.

Array of TextVariable itemByRange (from: any, to: any)
Returns the TextVariables within the specified range.

ParameterTypeDescription
fromLong Integer
String
TextVariable
The TextVariable, index, or name at the beginning of the range. Can accept: TextVariable, Long Integer or String.
toLong Integer
String
TextVariable
The TextVariable, index, or name at the end of the range. Can accept: TextVariable, Long Integer or String.

TextVariable lastItem ()
Returns the last TextVariable in the collection.

TextVariable middleItem ()
Returns the middle TextVariable in the collection.

TextVariable nextItem (obj: TextVariable)
Returns the TextVariable whose index follows the specified TextVariable in the collection.

ParameterTypeDescription
objTextVariableThe TextVariable whose index comes before the desired TextVariable.

TextVariable previousItem (obj: TextVariable)
Returns the TextVariable with the index previous to the specified index.

ParameterTypeDescription
objTextVariableThe index of the TextVariable that follows the desired TextVariable.

string toSource ()
Generates a string which, if executed, will return the TextVariable.

Element of

Application.textVariables

Document.textVariables

Jongware, 20-Jun-2010 v3.0.3dContents :: Index