TextVariableInstance
A text variable instance in the text.
Instance
Read Only
String name
The name of the TextVariableInstance.
Read Only
String resultText
The text that replaces the variable marker. Note: This property cannot be set; it can be used only to update variables. .
Read Only
InsertionPoint storyOffset
The insertion point before the table in the story containing the table.
Read Only
Number id
The unique ID of the TextVariableInstance.
Read Only
Boolean isValid
Returns true if the object specifier resolves to valid objects.
Read Only
Mixed parent
The parent of the TextVariableInstance (a XmlStory, TextFrame, EndnoteTextFrame, Story, Note, Cell, Footnote or Change).
Read Only
Number index
The index of the TextVariableInstance within its containing object.
Read Only
Events events
A collection of events.
Read Only
EventListeners eventListeners
A collection of event listeners.
TextVariable associatedTextVariable
The associated text variable.
String label
A property that can be set to any string.
Object properties
A property that allows setting of several properties at the same time.
Methods
remove()
Deletes the TextVariableInstance.
Text convertToText()
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.
insertLabel( String key, String value )
Sets the label to the value associated with the specified key.
Parameters
Type Name Description
String extractLabel( String key )
Gets the label value associated with the specified key.
Parameters
Type Name Description
String toSource()
Generates a string which, if executed, will return the TextVariableInstance.
TextVariableInstance getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description
Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description