Class

TextVariableInstances

 A collection of text variable instances.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

TextVariableInstance [] (index: number)
Returns the TextVariableInstance with the specified index.

ParameterTypeDescription
indexnumberThe index.

TextVariableInstance add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a text variable instance at the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object. (Optional) (default: LocationOptions.UNKNOWN)
referenceCell
Change
Character
Footnote
InsertionPoint
Line
Note
Paragraph
Story
Table
Text
TextColumn
TextFrame
TextStyleRange
TextVariableInstance
Word
XmlStory
The reference object. Note: Required only when the to parameter specifies before or after. Can accept: TextVariableInstance, XmlStory, TextFrame, Story, Note, Cell, Footnote, Table, TextColumn, TextStyleRange, Text, InsertionPoint, Paragraph, Line, Word, Character or Change. (Optional)
withPropertiesObjectInitial values for properties of the new TextVariableInstance (Optional)

TextVariableInstance anyItem ()
Returns any TextVariableInstance in the collection.

number count ()
Displays the number of elements in the TextVariableInstance.

Array of TextVariableInstance everyItem ()
Returns every TextVariableInstance in the collection.

TextVariableInstance firstItem ()
Returns the first TextVariableInstance in the collection.

TextVariableInstance item (index: varies)
Returns the TextVariableInstance with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

TextVariableInstance itemByID (id: number)
Returns the TextVariableInstance with the specified ID.

ParameterTypeDescription
idnumberThe ID.

TextVariableInstance itemByName (name: string)
Returns the TextVariableInstance with the specified name.

ParameterTypeDescription
namestringThe name.

Array of TextVariableInstance itemByRange (from: varies, to: varies)
Returns the TextVariableInstances within the specified range.

ParameterTypeDescription
fromLong Integer
String
TextVariableInstance
The TextVariableInstance, index, or name at the beginning of the range. Can accept: TextVariableInstance, Long Integer or String.
toLong Integer
String
TextVariableInstance
The TextVariableInstance, index, or name at the end of the range. Can accept: TextVariableInstance, Long Integer or String.

TextVariableInstance lastItem ()
Returns the last TextVariableInstance in the collection.

TextVariableInstance middleItem ()
Returns the middle TextVariableInstance in the collection.

TextVariableInstance nextItem (obj: TextVariableInstance)
Returns the TextVariableInstance whose index follows the specified TextVariableInstance in the collection.

ParameterTypeDescription
objTextVariableInstanceThe TextVariableInstance whose index comes before the desired TextVariableInstance.

TextVariableInstance previousItem (obj: TextVariableInstance)
Returns the TextVariableInstance with the index previous to the specified index.

ParameterTypeDescription
objTextVariableInstanceThe index of the TextVariableInstance that follows the desired TextVariableInstance.

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

Element of

Cell.textVariableInstances

Change.textVariableInstances

Character.textVariableInstances

Footnote.textVariableInstances

InsertionPoint.textVariableInstances

Line.textVariableInstances

Note.textVariableInstances

Paragraph.textVariableInstances

Story.textVariableInstances

Table.textVariableInstances

Text.textVariableInstances

TextColumn.textVariableInstances

TextFrame.textVariableInstances

TextStyleRange.textVariableInstances

Word.textVariableInstances

XmlStory.textVariableInstances

Jongware, 28-Apr-2012 v3.0.3hContents :: Index