Text frame preferences.
Go to Property Listing | Method Listing
toSource, getElements, toSpecifier, addEventListener, removeEventListener
Application, AutoSizingReferenceEnum, AutoSizingTypeEnum, Boolean, Document, EventListeners, Events, FirstBaseline, Number, Object, ObjectStyle, String, TextFrame, VerticalJustification,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
autoSizingReferencePoint |
AutoSizingReferenceEnum.TOP_LEFT_POINT AutoSizingReferenceEnum.TOP_CENTER_POINT AutoSizingReferenceEnum.TOP_RIGHT_POINT AutoSizingReferenceEnum.LEFT_CENTER_POINT AutoSizingReferenceEnum.CENTER_POINT AutoSizingReferenceEnum.RIGHT_CENTER_POINT AutoSizingReferenceEnum.BOTTOM_LEFT_POINT AutoSizingReferenceEnum.BOTTOM_CENTER_POINT AutoSizingReferenceEnum.BOTTOM_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.OFF AutoSizingTypeEnum.HEIGHT_ONLY AutoSizingTypeEnum.WIDTH_ONLY AutoSizingTypeEnum.HEIGHT_AND_WIDTH AutoSizingTypeEnum.HEIGHT_AND_WIDTH_PROPORTIONALLY |
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 |
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
firstBaselineOffset |
FirstBaseline.ASCENT_OFFSET FirstBaseline.CAP_HEIGHT FirstBaseline.LEADING_OFFSET FirstBaseline.EMBOX_HEIGHT FirstBaseline.X_HEIGHT FirstBaseline.FIXED_HEIGHT |
read/write |
The distance between the baseline of the text and the top inset of the text frame or cell. |
|
ignoreWrap |
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 |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
minimumFirstBaselineOffset |
read/write |
The minimum distance between the baseline of the text and the top inset of the text frame or cell. |
|
|
minimumHeightForAutoSizing |
read/write |
The minimum height for auto-sizing of the text frame. |
|
|
minimumWidthForAutoSizing |
read/write |
The minimum width for auto-sizing of the text frame. |
|
|
parent |
readonly |
The parent of the TextFramePreference (a Application, Document, TextFrame or ObjectStyle). |
|
|
properties |
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 |
read/write |
The column width of the columns in the text frame. |
|
|
textColumnGutter |
read/write |
The space between columns in the text frame. |
|
|
textColumnMaxWidth |
read/write |
The maximum column width of the columns in the text frame. Use 0 to indicate no upper limit. |
|
|
useFixedColumnWidth |
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 |
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 |
read/write |
If true, minimum height value is used during the auto-sizing of text frame. |
|
|
useMinimumWidthForAutoSizing |
read/write |
If true, minimum width value is used during the auto-sizing of text frame. |
|
|
useNoLineBreaksForAutoSizing |
read/write |
If true, line-breaks are not introduced after auto sizing. |
|
|
verticalBalanceColumns |
read/write |
Vertically justify balanced across all columns. |
|
|
verticalJustification |
VerticalJustification.TOP_ALIGN VerticalJustification.CENTER_ALIGN VerticalJustification.BOTTOM_ALIGN VerticalJustification.JUSTIFY_ALIGN |
read/write |
The vertical alignment of the text content. |
|
verticalThreshold |
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. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
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, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the TextFramePreference.
String toSpecifier ()
Retrieves the object specifier.
Application.textFramePreferences
Document.textFramePreferences
ObjectStyle.textFramePreferences
TextFrame.textFramePreferences
Event.parent
EventListener.parent
MutationEvent.parent