A collection of text variable instances.
Methods
TextVariableInstanceadd ([to:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object])
Creates the TextVariableInstance at the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location relative to the reference object or within the containing object. (Optional) (default: UNKNOWN ) |
| reference | TextVariableInstance XmlStory TextFrame Story Note Cell Footnote Table TextColumn TextStyleRange Text Paragraph Line Word Character InsertionPoint |
The reference object. Note: Required only when the to parameter specifies before or after. Can accept: TextVariableInstance, XmlStory, TextFrame, Story, Note, Cell, Footnote, Table, TextColumn, TextStyleRange, Text, Paragraph, Line, Word, Character or InsertionPoint. (Optional) |
| withProperties | Object | Initial values for properties of the new TextVariableInstance (Optional) |
TextVariableInstanceanyItem ()
Returns any TextVariableInstance in the collection.
number count ()
Displays the number of elements in the TextVariableInstance.
Array of TextVariableInstanceeveryItem ()
Returns every TextVariableInstance in the collection.
TextVariableInstancefirstItem ()
Returns the first TextVariableInstance in the collection.
TextVariableInstanceitem (index:
any)
Returns the TextVariableInstance with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
TextVariableInstanceitemByID (id:
number)
Returns the TextVariableInstance with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
TextVariableInstanceitemByName (name:
string)
Returns the TextVariableInstance with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of TextVariableInstanceitemByRange (from:
any, to:
any)
Returns the TextVariableInstances within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | TextVariableInstance Long Integer String |
The TextVariableInstance, index, or name at the beginning of the range. Can accept: TextVariableInstance, Long Integer or String. |
| to | TextVariableInstance Long Integer String |
The TextVariableInstance, index, or name at the end of the range. Can accept: TextVariableInstance, Long Integer or String. |
TextVariableInstancelastItem ()
Returns the last TextVariableInstance in the collection.
TextVariableInstancemiddleItem ()
Returns the middle TextVariableInstance in the collection.
TextVariableInstancenextItem (obj:
TextVariableInstance)
Returns the TextVariableInstance whose index follows the specified TextVariableInstance in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | TextVariableInstance | The TextVariableInstance whose index comes before the desired TextVariableInstance. |
TextVariableInstancepreviousItem (obj:
TextVariableInstance)
Returns the TextVariableInstance with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | TextVariableInstance | The index of the TextVariableInstance that follows the desired TextVariableInstance. |
string toSource ()
Generates a string which, if executed, will return the TextVariableInstance.
Element of:
Cell.textVariableInstances
Character.textVariableInstances
Footnote.textVariableInstances
InsertionPoint.textVariableInstances
Line.textVariableInstances
Note.textVariableInstances
Paragraph.textVariableInstances
Story.textVariableInstances
Table.textVariableInstances
Text.textVariableInstances
TextColumn.textVariableInstances
TextFrame.textVariableInstances
TextStyleRange.textVariableInstances
Word.textVariableInstances
XmlStory.textVariableInstances