A collection of text variables.
Methods
TextVariableadd ([withProperties:
Object])
Creates a new TextVariable.
| Parameter | Type | Description |
|---|---|---|
| withProperties | Object | Initial values for properties of the new TextVariable (Optional) |
TextVariableanyItem ()
Returns any TextVariable in the collection.
number count ()
Displays the number of elements in the TextVariable.
Array of TextVariableeveryItem ()
Returns every TextVariable in the collection.
TextVariablefirstItem ()
Returns the first TextVariable in the collection.
TextVariableitem (index:
any)
Returns the TextVariable with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
TextVariableitemByName (name:
string)
Returns the TextVariable with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of TextVariableitemByRange (from:
any, to:
any)
Returns the TextVariables within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | TextVariable Long Integer String |
The TextVariable, index, or name at the beginning of the range. Can accept: TextVariable, Long Integer or String. |
| to | TextVariable Long Integer String |
The TextVariable, index, or name at the end of the range. Can accept: TextVariable, Long Integer or String. |
TextVariablelastItem ()
Returns the last TextVariable in the collection.
TextVariablemiddleItem ()
Returns the middle TextVariable in the collection.
TextVariablenextItem (obj:
TextVariable)
Returns the TextVariable whose index follows the specified TextVariable in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | TextVariable | The TextVariable whose index comes before the desired TextVariable. |
TextVariablepreviousItem (obj:
TextVariable)
Returns the TextVariable with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | TextVariable | The 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