TextFramePreference

Text frame preferences.

Go to Property Listing | Method Listing

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

AutoSizingReferenceEnum, AutoSizingTypeEnum, Boolean, EventListeners, Events, FirstBaseline, Number, Object, String, StrokeStyle, Swatch, VerticalJustification

Hierarchy:

Superclass: Preference

Class: TextFramePreference

Property Listing

Property	Type	Access	Description
autoSizingReferencePoint	AutoSizingReferenceEnum AutoSizingReferenceEnum.BOTTOM_CENTER_POINT AutoSizingReferenceEnum.BOTTOM_LEFT_POINT AutoSizingReferenceEnum.BOTTOM_RIGHT_POINT AutoSizingReferenceEnum.CENTER_POINT AutoSizingReferenceEnum.LEFT_CENTER_POINT AutoSizingReferenceEnum.RIGHT_CENTER_POINT AutoSizingReferenceEnum.TOP_CENTER_POINT AutoSizingReferenceEnum.TOP_LEFT_POINT AutoSizingReferenceEnum.TOP_RIGHT_POINT	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
autoSizingType	AutoSizingTypeEnum AutoSizingTypeEnum.HEIGHT_AND_WIDTH AutoSizingTypeEnum.HEIGHT_AND_WIDTH_PROPORTIONALLY AutoSizingTypeEnum.HEIGHT_ONLY AutoSizingTypeEnum.OFF AutoSizingTypeEnum.WIDTH_ONLY	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
columnRuleBottomInset	Number (range -10000 - 10000)	read/write	Text Frame Column Rule Bottom Inset
columnRuleInsetChainOverride	Boolean	read/write	If true, enable inset chain override.
columnRuleOffset	Number (range -10000 - 10000)	read/write	Text Frame Column Rule Offset
columnRuleOverprintOverride	Boolean	read/write	If true, enable overprint override.
columnRuleOverride	Boolean	read/write	If true, enable overrides to text frame vertical column rule options.
columnRuleStrokeColor	Swatch	read/write	Text Frame Column Rule Stroke Color
columnRuleStrokeTint	Number (range 0 - 100)	read/write	Text Frame Column Rule Stroke Tint
columnRuleStrokeType	StrokeStyle	read/write	Text Frame Column Rule Stroke Type
columnRuleStrokeWidth	Number (range 0 - 10000)	read/write	Text Frame Column Rule Width
columnRuleTopInset	Number (range -10000 - 10000)	read/write	Text Frame Column Rule top inset
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
firstBaselineOffset	FirstBaseline FirstBaseline.ASCENT_OFFSET FirstBaseline.CAP_HEIGHT FirstBaseline.EMBOX_HEIGHT FirstBaseline.FIXED_HEIGHT FirstBaseline.LEADING_OFFSET FirstBaseline.X_HEIGHT	read/write	The distance between the baseline of the text and the top inset of the text frame or cell.
footnotesEnableOverrides	Boolean	read/write	If true, enable overrides to document footnote options.
footnotesMinimumSpacing	Number String	read/write	Minimum Spacing Before First Footnote
footnotesSpaceBetween	Number String	read/write	Space between footnotes.
footnotesSpanAcrossColumns	Boolean	read/write	If true, enable straddling footnotes.
ignoreWrap	Boolean	read/write	If true, ignores text wrap settings for drawn or placed objects in the text frame.
insetSpacing	Unit(0-8640points) Array of 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).
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
minimumFirstBaselineOffset	Number String	read/write	The minimum distance between the baseline of the text and the top inset of the text frame or cell.
minimumHeightForAutoSizing	Number String	read/write	The minimum height for auto-sizing of the text frame.
minimumWidthForAutoSizing	Number String	read/write	The minimum width for auto-sizing of the text frame.
parent	Document EndnoteTextFrame TextFrame Application ObjectStyle	readonly	The parent of the TextFramePreference (a Application, Document, TextFrame, EndnoteTextFrame or ObjectStyle).
properties	Object	read/write	A property that allows setting of several properties at the same time.
textColumnCount	Number (range 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.
textColumnFixedWidth	Number String	read/write	The column width of the columns in the text frame.
textColumnGutter	Number String	read/write	The space between columns in the text frame.
textColumnMaxWidth	Number String	read/write	The maximum column width of the columns in the text frame. Use 0 to indicate no upper limit.
useFixedColumnWidth	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.
useFlexibleColumnWidth	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.
useMinimumHeightForAutoSizing	Boolean	read/write	If true, minimum height value is used during the auto-sizing of text frame.
useMinimumWidthForAutoSizing	Boolean	read/write	If true, minimum width value is used during the auto-sizing of text frame.
useNoLineBreaksForAutoSizing	Boolean	read/write	If true, line-breaks are not introduced after auto sizing.
verticalBalanceColumns	Boolean	read/write	Vertically justify balanced across all columns.
verticalJustification	VerticalJustification VerticalJustification.BOTTOM_ALIGN VerticalJustification.CENTER_ALIGN VerticalJustification.JUSTIFY_ALIGN VerticalJustification.TOP_ALIGN	read/write	The vertical alignment of the text content.
verticalThreshold	Number String	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.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

TextFramePreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
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. (Optional) (default: false)