Adobe InDesign CS6 (8.0) Object Model JS: TextFramePreference

InDesign CS6

Class

TextFramePreference

 Text frame preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document | ObjectStyle | TextFrame
Preference
TextFramePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
autoSizingReferencePointAutoSizingReferenceEnum:
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
r/wThe 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
autoSizingTypeAutoSizingTypeEnum:
AutoSizingTypeEnum.OFF
AutoSizingTypeEnum.HEIGHT_ONLY
AutoSizingTypeEnum.WIDTH_ONLY
AutoSizingTypeEnum.HEIGHT_AND_WIDTH
AutoSizingTypeEnum.HEIGHT_AND_WIDTH_PROPORTIONALLY
r/wAuto-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
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
firstBaselineOffsetFirstBaseline:
FirstBaseline.ASCENT_OFFSET
FirstBaseline.CAP_HEIGHT
FirstBaseline.LEADING_OFFSET
FirstBaseline.EMBOX_HEIGHT
FirstBaseline.X_HEIGHT
FirstBaseline.FIXED_HEIGHT
r/wThe distance between the baseline of the text and the top inset of the text frame or cell.
ignoreWrapbool r/wIf true, ignores text wrap settings for drawn or placed objects in the text frame.
insetSpacingArray of 4 Units (0 - 8640 points)
Unit (0 - 8640 points)
r/wThe 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).
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
minimumFirstBaselineOffsetMeasurement Unit (Number or String) (range: 0 - 8640) r/wThe minimum distance between the baseline of the text and the top inset of the text frame or cell.
minimumHeightForAutoSizingMeasurement Unit (Number or String) r/wThe minimum height for auto-sizing of the text frame.
minimumWidthForAutoSizingMeasurement Unit (Number or String) r/wThe minimum width for auto-sizing of the text frame.
parentApplication
Document
ObjectStyle
TextFrame
readonlyThe parent of the TextFramePreference (a Application, Document, TextFrame or ObjectStyle).
propertiesObject r/wA property that allows setting of several properties at the same time.
textColumnCountnumber (range: 1 - 40) r/wThe 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.
textColumnFixedWidthMeasurement Unit (Number or String) (range: 0 - 8640) r/wThe column width of the columns in the text frame.
textColumnGutterMeasurement Unit (Number or String) (range: 0 - 8640) r/wThe space between columns in the text frame.
textColumnMaxWidthMeasurement Unit (Number or String) (range: 0 - 8640) r/wThe maximum column width of the columns in the text frame. Use 0 to indicate no upper limit.
useFixedColumnWidthbool r/wIf 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.
useFlexibleColumnWidthbool r/wIf 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.
useMinimumHeightForAutoSizingbool r/wIf true, minimum height value is used during the auto-sizing of text frame.
useMinimumWidthForAutoSizingbool r/wIf true, minimum width value is used during the auto-sizing of text frame.
useNoLineBreaksForAutoSizingbool r/wIf true, line-breaks are not introduced after auto sizing.
verticalBalanceColumnsbool r/wVertically justify balanced across all columns.
verticalJustificationVerticalJustification:
VerticalJustification.TOP_ALIGN
VerticalJustification.CENTER_ALIGN
VerticalJustification.BOTTOM_ALIGN
VerticalJustification.JUSTIFY_ALIGN
r/wThe vertical alignment of the text content.
verticalThresholdMeasurement Unit (Number or String) (range: 0 - 8640) r/wThe 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

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of TextFramePreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.textFramePreferences

Document.textFramePreferences

ObjectStyle.textFramePreferences

TextFrame.textFramePreferences

Return

Array of TextFramePreference TextFramePreference.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index