K4 InDesign Javascript API Documentation

TextTextVariableInstance

A text variable instance in the text.

Instance Properties

Name Description Access
associatedTextVariable TextVariable The associated text variable. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the TextVariableInstance. read-only
index number The index of the TextVariableInstance within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the TextVariableInstance. read-only
parent The parent of the TextVariableInstance (a XmlStory, TextFrame, EndnoteTextFrame, Story, Note, Cell, Footnote or Change). read-only
properties Object A property that allows setting of several properties at the same time. read-write
resultText string The text that replaces the variable marker. Note: This property cannot be set; it can be used only to update variables. . read-only
storyOffset InsertionPoint The insertion point before the table in the story containing the table. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
convertToText(
)
  → Text
extractLabel(
key)
  → string
getElements(
)
  → TextVariableInstance
insertLabel(
key, value)
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
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.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → TextVariableInstance
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the TextVariableInstance.
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 TextVariableInstance.
toSpecifier(
)
  → string
Retrieves the object specifier.