InDesign2026
API 21.5.1.73
Collection of TextVariableInstance

TextVariableInstances

A collection of text variable instances.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

TextVariableInstance

Creates a text variable instance at the specified location.

to? LocationOptions The location relative to the reference object or within the containing object.
reference? Cell | Character | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Table | Text | TextColumn | TextFrame | TextStyleRange | TextVariableInstance | Word | XmlStory | Change The reference object. Note: Required only when the to parameter specifies before or after. Can accept: TextVariableInstance, XmlStory, TextFrame, EndnoteTextFrame, Story, Note, Cell, Footnote, Table, TextColumn, TextStyleRange, Text, InsertionPoint, Paragraph, Line, Word, Character or Change.
withProperties? Object Initial values for properties of the new TextVariableInstance
Number

Displays the number of elements in the TextVariableInstance.

TextVariableInstance

Returns the TextVariableInstance with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
TextVariableInstance[]

Returns the TextVariableInstances within the specified range.

from LongInteger | TextVariableInstance | String The TextVariableInstance, index, or name at the beginning of the range. Can accept: TextVariableInstance, Long Integer or String.
to LongInteger | TextVariableInstance | String The TextVariableInstance, index, or name at the end of the range. Can accept: TextVariableInstance, Long Integer or String.
TextVariableInstance

Returns the TextVariableInstance whose index follows the specified TextVariableInstance in the collection.

obj TextVariableInstance The TextVariableInstance whose index comes before the desired TextVariableInstance.
TextVariableInstance

Returns the TextVariableInstance with the index previous to the specified index.

obj TextVariableInstance The index of the TextVariableInstance that follows the desired TextVariableInstance.
String

Generates a string which, if executed, will return the TextVariableInstance.

Object of 17

Properties elsewhere that hold a TextVariableInstances.