Class

TextFrames

A collection of text frames.

QuickLinks

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

Properties

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

Methods

Instances

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

Parameter	Type	Description
index	number	The index.

TextFrame add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new TextFrame

Parameter	Type	Description
layer	Layer	The layer on which to create the TextFrame. (Optional)
at	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING 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 PageItem Spread	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.

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

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

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

Parameter	Type	Description
index	Long Integer 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.

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

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

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

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

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

Parameter	Type	Description
obj	TextFrame	The TextFrame whose index comes before the desired TextFrame.

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

Parameter	Type	Description
obj	TextFrame	The index of the TextFrame that follows the desired TextFrame.

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

Element of

Button.textFrames

Cell.textFrames

Character.parentTextFrames

Character.textFrames

CheckBox.textFrames

ComboBox.textFrames

Document.textFrames

Footnote.textFrames

GraphicLine.textFrames

Group.textFrames

InsertionPoint.parentTextFrames

InsertionPoint.textFrames

Layer.textFrames

Line.parentTextFrames

Line.textFrames

ListBox.textFrames

MasterSpread.textFrames

MultiStateObject.textFrames

Oval.textFrames

Page.textFrames

Paragraph.parentTextFrames

Paragraph.textFrames

PlaceGun.textFrames

Polygon.textFrames

RadioButton.textFrames

Rectangle.textFrames

SignatureField.textFrames

Snippet.textFrames

SplineItem.textFrames

Spread.textFrames

State.textFrames

Story.textContainers

Story.textFrames

Table.textFrames

Text.parentTextFrames

Text.textFrames

TextBox.textFrames

TextColumn.parentTextFrames

TextColumn.textFrames

TextFrame.textFrames

TextStyleRange.parentTextFrames

TextStyleRange.textFrames

Word.parentTextFrames

Word.textFrames

XmlStory.textContainers

XmlStory.textFrames

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index