A collection of text frames.
Methods
TextFrameadd ([layer:
Layer][, at:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object])
Creates a new TextFrame
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the TextFrame. (Optional) |
| at | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location at which to insert the TextFrame relative to the reference object or within the container object. (Optional) (default: UNKNOWN ) |
| reference | Document Spread MasterSpread Page Layer 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) |
TextFrameanyItem ()
Returns any TextFrame in the collection.
number count ()
Displays the number of elements in the TextFrame.
Array of TextFrameeveryItem ()
Returns every TextFrame in the collection.
TextFramefirstItem ()
Returns the first TextFrame in the collection.
TextFrameitem (index:
any)
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. |
TextFrameitemByID (id:
number)
Returns the TextFrame with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
TextFrameitemByName (name:
string)
Returns the TextFrame with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of TextFrameitemByRange (from:
any, to:
any)
Returns the TextFrames within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | TextFrame Long Integer String |
The TextFrame, index, or name at the beginning of the range. Can accept: TextFrame, Long Integer or String. |
| to | TextFrame Long Integer String |
The TextFrame, index, or name at the end of the range. Can accept: TextFrame, Long Integer or String. |
TextFramelastItem ()
Returns the last TextFrame in the collection.
TextFramemiddleItem ()
Returns the middle TextFrame in the collection.
TextFramenextItem (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. |
TextFramepreviousItem (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.textFrames
Document.textFrames
Footnote.textFrames
GraphicLine.textFrames
Group.textFrames
InsertionPoint.textFrames
Layer.textFrames
Line.textFrames
MasterSpread.textFrames
Oval.textFrames
Page.textFrames
PageItem.textFrames
Paragraph.textFrames
Polygon.textFrames
Rectangle.textFrames
Spread.textFrames
State.textFrames
Story.textFrames
Table.textFrames
Text.textFrames
TextColumn.textFrames
TextFrame.textFrames
TextStyleRange.textFrames
Word.textFrames