InDesign2026
API 21.5.1.73
Object

TextFramePreference

Text frame preferences.

Preference TextFramePreference
Hierarchy

Application | Document | EndnoteTextFrame | ObjectStyle | TextFrame

TextFramePreference

Properties

NameType AccessDescription
AutoSizingReferenceEnum
read/write The reference point for auto sizing of text frame. Reference point is automatically adjusted to the suitable value depending on the auto-sizing type value. As an example, top left reference point becomes top center for height only dimension
AutoSizingTypeEnum
read/write Auto-sizing type of text frame. Based on type, reference value is automatically adjusted. For example, for height only type, top-left reference point becomes top-center. Recommended to change auto-sizing type, after setting other auto-sizing attributes
Number -10000–10000 read/write Text Frame Column Rule Bottom Inset
Boolean read/write If true, enable inset chain override.
Number -10000–10000 read/write Text Frame Column Rule Offset
Boolean read/write If true, enable overprint override.
Boolean read/write If true, enable overrides to text frame vertical column rule options.
Swatch read/write Text Frame Column Rule Stroke Color
Number 0–100 read/write Text Frame Column Rule Stroke Tint
StrokeStyle read/write Text Frame Column Rule Stroke Type
Number 0–10000 read/write Text Frame Column Rule Width
Number -10000–10000 read/write Text Frame Column Rule top inset
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
FirstBaseline
read/write The distance between the baseline of the text and the top inset of the text frame or cell.
Boolean read/write If true, enable overrides to document footnote options.
Number | String unit read/write Minimum Spacing Before First Footnote
Number | String unit read/write Space between footnotes.
Boolean read/write If true, enable straddling footnotes.
Boolean read/write If true, ignores text wrap settings for drawn or placed objects in the text frame.
Unit(0-8640points)[] | 4 Units (0 - 8640 points)[] read/write The amount to offset text from the edges of the text frame, specified either as a single value applied uniformly to all sides of the text frame or as an array of 4 values in the format [top inset, left inset, bottom inset, right inset]. Can return: Unit (0 - 8640 points) or Array of 4 Units (0 - 8640 points).
Boolean readonly Returns true if the object specifier resolves to valid objects.
Number | String unit read/write The minimum distance between the baseline of the text and the top inset of the text frame or cell.
Number | String unit read/write The minimum height for auto-sizing of the text frame.
Number | String unit read/write The minimum width for auto-sizing of the text frame.
Document | EndnoteTextFrame | TextFrame | Application | ObjectStyle readonly The parent of the TextFramePreference (a Application, Document, TextFrame, EndnoteTextFrame or ObjectStyle).
Object read/write A property that allows setting of several properties at the same time.
Number 1–40 read/write The number of columns in the text frame. Note: Depending on the value of use fixed column width, the number of columns can change automatically when the text frame size changes.
Number | String unit read/write The column width of the columns in the text frame.
Number | String unit read/write The space between columns in the text frame.
Number | String unit read/write The maximum column width of the columns in the text frame. Use 0 to indicate no upper limit.
Boolean read/write If true, maintains column width when the text frame is resized. If false, causes columns to resize when the text frame is resized. Note: When true, resizing the frame can change the number of columns in the frame.
Boolean read/write If true, maintains column width between a min and max range when the text frame is resized. If false, causes columns to resize when the text frame is resized. Note: When true, resizing the frame can change the number of columns in the frame.
Boolean read/write If true, minimum height value is used during the auto-sizing of text frame.
Boolean read/write If true, minimum width value is used during the auto-sizing of text frame.
Boolean read/write If true, line-breaks are not introduced after auto sizing.
Boolean read/write Vertically justify balanced across all columns.
VerticalJustification
read/write The vertical alignment of the text content.
Number | String unit read/write The maximum amount of vertical space between two paragraphs. Note: Valid only when vertical justification is justified; the specified amount is applied in addition to the space before or space after values defined for the paragraph.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
TextFramePreference[]

Resolves the object specifier, creating an array of object references.

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

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

String

Retrieves the object specifier.

Object of 8

Properties elsewhere that hold a TextFramePreference.

Return 1

Methods that return a TextFramePreference.