K4 InDesign Javascript API Documentation

PreferencesTextFramePreference

Text frame preferences.

Extends

Instance Properties

Name Description Access
autoSizingReferencePoint AutoSizingReferenceEnum 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 read-write
autoSizingType AutoSizingTypeEnum 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 read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
firstBaselineOffset FirstBaseline The distance between the baseline of the text and the top inset of the text frame or cell. read-write
ignoreWrap bool If true, ignores text wrap settings for drawn or placed objects in the text frame. read-write
insetSpacing 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). read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
minimumFirstBaselineOffset Measurement Unit (Number or String)=any The minimum distance between the baseline of the text and the top inset of the text frame or cell. read-write
minimumHeightForAutoSizing Measurement Unit (Number or String)=any The minimum height for auto-sizing of the text frame. read-write
minimumWidthForAutoSizing Measurement Unit (Number or String)=any The minimum width for auto-sizing of the text frame. read-write
parent The parent of the TextFramePreference (a Application, Document, TextFrame, EndnoteTextFrame or ObjectStyle). read-only
properties Object A property that allows setting of several properties at the same time. read-write
textColumnCount number 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. read-write
textColumnFixedWidth Measurement Unit (Number or String)=any The column width of the columns in the text frame. read-write
textColumnGutter Measurement Unit (Number or String)=any The space between columns in the text frame. read-write
textColumnMaxWidth Measurement Unit (Number or String)=any The maximum column width of the columns in the text frame. Use 0 to indicate no upper limit. read-write
useFixedColumnWidth bool 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. read-write
useFlexibleColumnWidth bool 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. read-write
useMinimumHeightForAutoSizing bool If true, minimum height value is used during the auto-sizing of text frame. read-write
useMinimumWidthForAutoSizing bool If true, minimum width value is used during the auto-sizing of text frame. read-write
useNoLineBreaksForAutoSizing bool If true, line-breaks are not introduced after auto sizing. read-write
verticalBalanceColumns bool Vertically justify balanced across all columns. read-write
verticalJustification VerticalJustification The vertical alignment of the text content. read-write
verticalThreshold Measurement Unit (Number or String)=any 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. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → TextFramePreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → TextFramePreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the TextFramePreference.
toSpecifier(
)
  → string
Retrieves the object specifier.