TextTextVariables

A collection of text variables.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[withProperties])
 → TextVariable
count(
)
 → number
item(
index)
 → TextVariable
itemByName(
name)
 → TextVariable
itemByRange(
from, to)
 → TextVariable
nextItem(
obj)
 → TextVariable
toSource(
)
 → string
add(
[withProperties])
 → TextVariable
Creates a new TextVariable.
withProperties Object Initial values for properties of the new TextVariable (Optional)
anyItem(
)
 → TextVariable
Returns any TextVariable in the collection.
count(
)
 → number
Displays the number of elements in the TextVariable.
everyItem(
)
 → TextVariable
Returns every TextVariable in the collection.
firstItem(
)
 → TextVariable
Returns the first TextVariable in the collection.
item(
index)
 → TextVariable
Returns the TextVariable with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByName(
name)
 → TextVariable
Returns the TextVariable with the specified name.
name string The name.
itemByRange(
from, to)
 → TextVariable
Returns the TextVariables within the specified range.
from The TextVariable, index, or name at the beginning of the range. Can accept: TextVariable, Long Integer or String.
to The TextVariable, index, or name at the end of the range. Can accept: TextVariable, Long Integer or String.
lastItem(
)
 → TextVariable
Returns the last TextVariable in the collection.
middleItem(
)
 → TextVariable
Returns the middle TextVariable in the collection.
nextItem(
obj)
 → TextVariable
Returns the TextVariable whose index follows the specified TextVariable in the collection.
obj TextVariable The TextVariable whose index comes before the desired TextVariable.
previousItem(
obj)
 → TextVariable
Returns the TextVariable with the index previous to the specified index.
obj TextVariable The index of the TextVariable that follows the desired TextVariable.
toSource(
)
 → string
Generates a string which, if executed, will return the TextVariable.