TextVariables
A collection of text variables.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
TextVariable [] (index:Number)
Returns the TextVariable with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
TextVariable add (withProperties:Object)
Creates a new TextVariable.
|
Parameter |
Type |
Description |
|---|---|---|
|
withProperties |
Initial 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.
TextVariable everyItem ()
Returns every TextVariable in the collection.
TextVariable firstItem ()
Returns the first TextVariable in the collection.
TextVariable item (index:Varies LongInteger String)
Returns the TextVariable with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
TextVariable itemByName (name:String)
Returns the TextVariable with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
TextVariable itemByRange (from:Varies LongInteger TextVariable String, to:Varies LongInteger TextVariable String)
Returns the TextVariables within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The TextVariable, index, or name at the beginning of the range. Can accept: TextVariable, Long Integer or String. |
|
to |
LongInteger |
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The TextVariable whose index comes before the desired TextVariable. |
TextVariable previousItem (obj:TextVariable)
Returns the TextVariable with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the TextVariable that follows the desired TextVariable. |
String toSource ()
Generates a string which, if executed, will return the TextVariable.
Object of
Application.textVariables
Document.textVariables