TextFrames

A collection of text frames.

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

TextFrame add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document MasterSpread Page Spread Layer, withProperties:Object)

Create a new TextFrame

Parameter	Type	Description
layer	Layer	The layer on which to create the TextFrame. (Optional)
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	Location (Optional) (default: LocationOptions.UNKNOWN)
reference	Document MasterSpread Page Spread Layer	Before/after this TextFrame or at the beginning/end of this Document, Spread, Master Spread, Page or Layer. Can accept: Document, Spread, MasterSpread, Page or Layer. (Optional)
withProperties	Object	Initial values for properties of the new TextFrame (Optional)

TextFrame anyItem ()

Returns any TextFrame in the collection.

Number count ()

Displays the number of elements in the TextFrame.

TextFrame everyItem ()

Returns every TextFrame in the collection.

TextFrame firstItem ()

Returns the first TextFrame in the collection.

TextFrame item (index:Varies Long String)

Returns the TextFrame with the specified index or name.

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

Parameter

Type

Description

index

Long

String

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

TextFrame itemByID (id:Number)

Returns the TextFrame with the specified ID.

Parameter	Type	Description
id	Number	The ID.

TextFrame itemByName (name:String)

Returns the TextFrame with the specified name.

Parameter	Type	Description
name	String	The name.

TextFrame itemByRange (from:Varies Long TextFrame String, to:Varies Long TextFrame String)

Returns the TextFrames within the specified range.

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

Parameter

Type

Description

from

Long

TextFrame

String

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

Long

TextFrame

String

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