InDesign Server2025
API 20.5.0.49
Collection of TextFrame

TextFrames

A collection of text frames.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

TextFrame

Returns the TextFrame with the specified index.

index Number The index.
TextFrame

Creates a new TextFrame

layer? Layer The layer on which to create the TextFrame.
at? LocationOptions The location at which to insert the TextFrame relative to the reference object or within the container object.
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.
withProperties? Object Initial values for properties of the new TextFrame
TextFrame

Returns any TextFrame in the collection.

Number

Displays the number of elements in the TextFrame.

TextFrame[]

Returns every TextFrame in the collection.

TextFrame

Returns the first TextFrame in the collection.

TextFrame

Returns the TextFrame with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
TextFrame

Returns the TextFrame with the specified ID.

id Number The ID.
TextFrame

Returns the TextFrame with the specified name.

name String The name.
TextFrame[]

Returns the TextFrames within the specified range.

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

Returns the last TextFrame in the collection.

TextFrame

Returns the middle TextFrame in the collection.

TextFrame

Returns the TextFrame whose index follows the specified TextFrame in the collection.

obj TextFrame The TextFrame whose index comes before the desired TextFrame.
TextFrame

Returns the TextFrame with the index previous to the specified index.

obj TextFrame The index of the TextFrame that follows the desired TextFrame.
String

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

Object of 47

Properties elsewhere that hold a TextFrames.