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 [] (index:Number)

Returns the TextFrame with the specified index.

Parameter	Type	Description
index	Number	The index.

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

Creates 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	The location at which to insert the TextFrame relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
reference	Document Layer MasterSpread Page Spread PageItem	The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (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 LongInteger String)

Returns the TextFrame 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.

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 LongInteger TextFrame String, to:Varies LongInteger TextFrame String)

Returns the TextFrames within the specified range.

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

Parameter

Type

Description

from

LongInteger

TextFrame

String

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

LongInteger

TextFrame

String

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