Class
Text frame preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
TextFramePreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| firstBaselineOffset | FirstBaseline: FirstBaseline.ASCENT_OFFSET FirstBaseline.CAP_HEIGHT FirstBaseline.LEADING_OFFSET FirstBaseline.EMBOX_HEIGHT FirstBaseline.X_HEIGHT FirstBaseline.FIXED_HEIGHT |
readonly | The distance between the baseline of the text and the top inset of the text frame or cell. |
| ignoreWrap | bool | readonly | If 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) |
readonly | 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 | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| minimumFirstBaselineOffset | Measurement Unit (Number or String) (range: 0 - 8640) | readonly | The minimum distance between the baseline of the text and the top inset of the text frame or cell. |
| parent | Application Document TextFrame |
readonly | The parent of the TextFramePreference (a Application, Document or TextFrame). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| textColumnCount | number (range: 1 - 40) | readonly | 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 | Measurement Unit (Number or String) (range: 0 - 8640) | readonly | The column width of the columns in the text frame. |
| textColumnGutter | Measurement Unit (Number or String) (range: 0 - 8640) | readonly | The space between columns in the text frame. |
| useFixedColumnWidth | bool | readonly | 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. |
| verticalBalanceColumns | bool | r/w | Vertically justify balanced across all columns. |
| verticalJustification | VerticalJustification: VerticalJustification.TOP_ALIGN VerticalJustification.CENTER_ALIGN VerticalJustification.BOTTOM_ALIGN VerticalJustification.JUSTIFY_ALIGN |
readonly | The vertical alignment of the text content. |
| verticalThreshold | Measurement Unit (Number or String) (range: 0 - 8640) | readonly | 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. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the TextFramePreference.
Element of
Application.textFramePreferences
Document.textFramePreferences
TextFrame.textFramePreferences
Return
Array of TextFramePreference TextFramePreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |