InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

TextVariableInstance

A text variable instance in the text.

Hierarchy

Cell | Change | EndnoteTextFrame | Footnote | Note | Story | TextFrame | XmlStory

TextVariableInstance

Properties

NameType AccessDescription
TextVariable read/write The associated text variable.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the TextVariableInstance.
Number readonly The index of the TextVariableInstance within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String readonly The name of the TextVariableInstance.
Cell | EndnoteTextFrame | Footnote | Note | Story | TextFrame | Change | XmlStory readonly The parent of the TextVariableInstance (a XmlStory, TextFrame, EndnoteTextFrame, Story, Note, Cell, Footnote or Change).
Object read/write A property that allows setting of several properties at the same time.
String readonly The text that replaces the variable marker. Note: This property cannot be set; it can be used only to update variables. .
InsertionPoint readonly The insertion point before the table in the story containing the table.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ Text

Converts the footnote to part of the story text and places the converted text at the former location of the footnote marker in the text.

→ String

Gets the label value associated with the specified key.

key String The key.
→ TextVariableInstance[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the TextVariableInstance.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

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

→ String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a TextVariableInstance.

Event.parentEventListener.parentMutationEvent.parentTextVariable.associatedInstances

Parameter of 4

Method parameters that accept a TextVariableInstance.

TextVariableInstances.add(reference)TextVariableInstances.itemByRange(from)TextVariableInstances.nextItem(obj)TextVariableInstances.previousItem(obj)

Return 14

Methods that return a TextVariableInstance.

TextVariableInstance.getElements()TextVariableInstances.[]()TextVariableInstances.add()TextVariableInstances.anyItem()TextVariableInstances.everyItem()TextVariableInstances.firstItem()TextVariableInstances.item()TextVariableInstances.itemByID()TextVariableInstances.itemByName()TextVariableInstances.itemByRange()TextVariableInstances.lastItem()TextVariableInstances.middleItem()TextVariableInstances.nextItem()TextVariableInstances.previousItem()