Class
Text frame preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
TextFramePreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| autoSizingReferencePoint | AutoSizingReferenceEnum: 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 |
readonly | 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: AutoSizingTypeEnum.OFF AutoSizingTypeEnum.HEIGHT_ONLY AutoSizingTypeEnum.WIDTH_ONLY AutoSizingTypeEnum.HEIGHT_AND_WIDTH AutoSizingTypeEnum.HEIGHT_AND_WIDTH_PROPORTIONALLY |
readonly | 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 | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | 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. |
| minimumHeightForAutoSizing | Measurement Unit (Number or String) | readonly | The minimum height for auto-sizing of the text frame. |
| minimumWidthForAutoSizing | Measurement Unit (Number or String) | readonly | The minimum width for auto-sizing of the text frame. |
| 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. |
| textColumnMaxWidth | Measurement Unit (Number or String) (range: 0 - 8640) | readonly | The maximum column width of the columns in the text frame. Use 0 to indicate no upper limit. |
| 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. |
| useFlexibleColumnWidth | bool | readonly | 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 | bool | readonly | If true, minimum height value is used during the auto-sizing of text frame. |
| useMinimumWidthForAutoSizing | bool | readonly | If true, minimum width value is used during the auto-sizing of text frame. |
| useNoLineBreaksForAutoSizing | bool | readonly | If true, line-breaks are not introduced after auto sizing. |
| 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, 29-Apr-2012 v3.0.3i | Contents :: Index |