K4 InDesign Javascript API Documentation

PreferencesTextPreference

Text preferences.

Extends

Instance Properties

Name Description Access
abutTextToTextWrap bool If true, moves wrapped text to the next available leading increment below the text wrap objects (skip by leading). read-write
addPages AddPageOptions Specifies where to insert new pages in response to overset text. read-write
baselineShiftKeyIncrement Measurement Unit (Number or String)=any The amount that the baseline shift increases each time the user presses the option/alt-shift-up arrow keys or decreases each time the user presses the option/alt-shift-down arrow keys. (Range: .001 to 100) read-write
deleteEmptyPages bool Enable auto-deletion of pages containing empty threaded text frames. read-write
enableStylePreviewMode bool If true, highlights character and paragraph styles with colored backgrounds. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
highlightCustomSpacing bool If true, highlights custom kerned or tracked characters. read-write
highlightHjViolations bool If true, highlights hyphenation and justification rule violations in the text. read-write
highlightKeeps bool If true, highlights paragraphs that violate keep options. read-write
highlightKinsoku bool If true, uses on-screen highlighting to identify kinsoku. read-write
highlightSubstitutedFonts bool If true, highlights missing fonts. read-write
highlightSubstitutedGlyphs bool If true, highlights substituted glyphs. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
justifyTextWraps bool If true, justifies text around text wrap objects. read-write
kerningKeyIncrement number The amount the kerning value per 1000 ems increases each time the user presses of the option/alt-right arrow keys or decreases each time the user presses the option/alt-left arrow keys. (Range: 1 to 100) read-write
leadingKeyIncrement Measurement Unit (Number or String)=any The amount that leading increases each time the user presses the option/alt-up arrow keys or decreases each time the user presses the option/alt-down arrow keys. (Range: .001 to 100) read-write
limitToMasterTextFrames bool Restrict the adding of pages during smart text reflow to overridden master text frames. read-write
linkTextFilesWhenImporting bool If true, links placed text files and spreadsheet files. If false, embeds the files. read-write
parent The parent of the TextPreference (a Application or Document). read-only
preserveFacingPageSpreads bool Preserve left-hand and right-and pages when facing pages are enabled during smart text reflow. read-write
properties Object A property that allows setting of several properties at the same time. read-write
quoteCharactersRotatedInVertical bool If true, Japanese composer treats quotes as half width and rotates them in vertical. read-write
showInvisibles bool If true, shows hidden characters. read-write
smallCap number The size of text formatted as small caps, specified as a percentage of the font size. (Range: 1 to 200) read-write
smartTextReflow bool If true, enable automatic adding and deleting of pages in response to text reflow. read-write
subscriptPosition number The position of subscript characters, specified as a percentage of the regular leading. (Range: -500 to 500) read-write
subscriptSize number The size of subscript characters, specified as a percentage of the font size. (Range: 0 to 200) read-write
superscriptPosition number The position of superscript characters, specified as a percentage of the regular leading. (Range: -500 to 500) read-write
superscriptSize number The size of superscript characters, specified as a percentage of the font size. (Range: 0 to 200) read-write
typographersQuotes bool If true, converts straight quotes to typographic quotes. read-write
useCidMojikumi bool If true, uses the glyph CID to get the mojikumi class of the character. read-write
useNewVerticalScaling bool If true, reverses X and Y scaling on Roman characters in vertical text. read-write
useOpticalSize bool If true, automatically selects the correct optical size. read-write
useParagraphLeading bool If true, applies the leading changes made to a text range to the entire paragraph. If false, applies leading changes only to the text range. read-write
zOrderTextWrap bool If true, text wrap does not affect text on layers above the layer that contains the text wrap object. If false, text wrap affects text on all visible layers. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → TextPreference
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(
)
  → TextPreference
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 TextPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.