TextVariableInstance

Methods:

addEventListener, convertToText, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, InsertionPoint, Number, Object, String, TextVariable,

Property Listing

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

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

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.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

TextVariableInstance getElements ()

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

undefined insertLabel (key:String, value:String)

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

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined remove ()

Deletes the TextVariableInstance.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
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. (Optional) (default: false)