InDesign2026
API 21.5.1.73
Collection of TextVariable

TextVariables

A collection of text variables.

Properties

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

Methods

TextVariable

Returns the TextVariable with the specified index.

index Number The index.
TextVariable

Creates a new TextVariable.

withProperties? Object Initial values for properties of the new TextVariable
TextVariable

Returns any TextVariable in the collection.

Number

Displays the number of elements in the TextVariable.

TextVariable[]

Returns every TextVariable in the collection.

TextVariable

Returns the first TextVariable in the collection.

TextVariable

Returns the TextVariable with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
TextVariable

Returns the TextVariable with the specified name.

name String The name.
TextVariable[]

Returns the TextVariables within the specified range.

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

Returns the last TextVariable in the collection.

TextVariable

Returns the middle TextVariable in the collection.

TextVariable

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

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

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

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

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

Object of 2

Properties elsewhere that hold a TextVariables.