K4 InDesign Javascript API Documentation

TextTextVariable

A text variable definition in a document.

Instance Properties

Name Description Access
associatedInstances TextVariableInstance Variable instances associated with the text variable. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the TextVariable within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the TextVariable. read-write
parent The parent of the TextVariable (a Application or Document). read-only
preferences Preferences A collection of preferences objects. read-only
properties Object A property that allows setting of several properties at the same time. read-write
variableOptions The preferences associated with the text variable. Can return: PageNumberVariablePreference, ChapterNumberVariablePreference, DateVariablePreference, FileNameVariablePreference, MatchCharacterStylePreference, MatchParagraphStylePreference, CustomTextVariablePreference or CaptionMetadataVariablePreference. read-only
variableType VariableTypes The variable type. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
convertToText(
)
  → Text
getElements(
)
  → TextVariable
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
convertToText(
)
  → Text
Convert all of this variable's instances to text.
getElements(
)
  → TextVariable
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the TextVariable.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the TextVariable.
toSpecifier(
)
  → string
Retrieves the object specifier.