TextVariableInstance
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| associatedTextVariable | TextVariable | r/w | The associated text variable. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | 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 | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | readonly | The name of the TextVariableInstance. |
| parent | CellChange Footnote Note Story TextFrame XmlStory |
readonly | The parent of the TextVariableInstance (a XmlStory, TextFrame, Story, Note, Cell, Footnote or Change). |
| properties | Object | r/w | 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. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | 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. |
Array
of TextVariableInstance getElements ()
Resolves the object specifier, creating an array of object references.
void 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. |
void remove ()
Deletes the TextVariableInstance.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the TextVariableInstance.
Element of
TextVariable.associatedInstances
Used in:
TextVariableInstance TextVariableInstances.nextItem (obj: TextVariableInstance)
TextVariableInstance TextVariableInstances.previousItem (obj: TextVariableInstance)
Return
Array of TextVariableInstance TextVariableInstance.getElements ()
TextVariableInstance TextVariableInstances.[] (index: number)
TextVariableInstance TextVariableInstances.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
TextVariableInstance TextVariableInstances.anyItem ()
Array of TextVariableInstance TextVariableInstances.everyItem ()
TextVariableInstance TextVariableInstances.firstItem ()
TextVariableInstance TextVariableInstances.item (index: varies)
TextVariableInstance TextVariableInstances.itemByID (id: number)
TextVariableInstance TextVariableInstances.itemByName (name: string)
Array of TextVariableInstance TextVariableInstances.itemByRange (from: varies, to: varies)
TextVariableInstance TextVariableInstances.lastItem ()
TextVariableInstance TextVariableInstances.middleItem ()
TextVariableInstance TextVariableInstances.nextItem (obj: TextVariableInstance)
TextVariableInstance TextVariableInstances.previousItem (obj: TextVariableInstance)
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |