TextVariableInstance

A text variable instance in the text.

Go to Property Listing | Method Listing

Methods:

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

Objects:

Boolean, InsertionPoint, Number, Object, String, TextVariable,

Property Listing

Property	Type	Access	Description
associatedTextVariable	TextVariable	read/write	The associated text variable.
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 Footnote Note Story XmlStory Change TextFrame	readonly	The parent of the TextVariableInstance (a TextFrame, Story, Note, Cell, Footnote, XmlStory 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

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.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

TextVariable.associatedInstances