TextVariableInstances

A collection of text variable instances.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

TextVariableInstance [] (index:Number)

Returns the TextVariableInstance with the specified index.

Parameter	Type	Description
index	Number	The index.

TextVariableInstance add ([to:LocationOptions=LocationOptions], reference:Varies Cell Character EndnoteTextFrame Footnote InsertionPoint Line Note Paragraph Story Table Text TextColumn TextFrame TextStyleRange TextVariableInstance Word XmlStory Change, withProperties:Object)

Creates a text variable instance at the specified location.

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

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object. (Optional)

(default: LocationOptions.UNKNOWN)

reference

The reference object. Note: Required only when the to parameter specifies before or after. Can accept: TextVariableInstance, XmlStory, TextFrame, EndnoteTextFrame, Story, Note, Cell, Footnote, Table, TextColumn, TextStyleRange, Text, InsertionPoint, Paragraph, Line, Word, Character or Change. (Optional)

withProperties

Object

Initial 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.

TextVariableInstance everyItem ()

Returns every TextVariableInstance in the collection.

TextVariableInstance firstItem ()

Returns the first TextVariableInstance in the collection.

TextVariableInstance item (index:Varies LongInteger String)

Returns the TextVariableInstance with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

TextVariableInstance itemByID (id:Number)

Returns the TextVariableInstance with the specified ID.

Parameter	Type	Description
id	Number	The ID.

TextVariableInstance itemByName (name:String)

Returns the TextVariableInstance with the specified name.

Parameter	Type	Description
name	String	The name.

TextVariableInstance itemByRange (from:Varies LongInteger TextVariableInstance String, to:Varies LongInteger TextVariableInstance String)

Returns the TextVariableInstances within the specified range.

Parameter	Type	Description
from	LongInteger TextVariableInstance String	The TextVariableInstance, index, or name at the beginning of the range. Can accept: TextVariableInstance, Long Integer or String.
to	LongInteger TextVariableInstance String	The TextVariableInstance, index, or name at the end of the range. Can accept: TextVariableInstance, Long Integer or String.

Parameter

Type

Description

from

LongInteger

TextVariableInstance

String

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

LongInteger

TextVariableInstance

String

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