TextFramePreference

Text frame preferences.

Methods:

getElements, toSource, toSpecifier

Objects:

Boolean, FirstBaseline, Number, Object, String, VerticalJustification

Hierarchy:

Superclass: Preference

Class: TextFramePreference

Property Listing

Property

Type

Access

Description

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.

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.

parent

Application

Document

ObjectStyle

TextFrame

readonly

The parent of the TextFramePreference (a ObjectStyle, Application, Document or TextFrame).

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.

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.

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

TextFramePreference getElements ()

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

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.textFramePreferences

Document.textFramePreferences

ObjectStyle.textFramePreferences

TextFrame.textFramePreferences

Return

TextFramePreference.getElements()