Adobe InDesign CS5 Server (7.0) Object Model JS: TextFramePreference

InDesign Server CS5

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
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.
insetSpacing Array 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.
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.
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.
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, 23-Mar-2011 v3.0.3dContents :: Index