InDesign Server2025
API 20.5.0.49
Object

TextPreference

Text preferences.

Preference TextPreference
Hierarchy

Application | Document

TextPreference

Properties

NameType AccessDescription
Boolean read/write If true, moves wrapped text to the next available leading increment below the text wrap objects (skip by leading).
AddPageOptions
read/write Specifies where to insert new pages in response to overset text.
Number | String unit read/write 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)
Boolean read/write Enable auto-deletion of pages containing empty threaded text frames.
Boolean read/write If true, highlights character and paragraph styles with colored backgrounds.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, highlights custom kerned or tracked characters.
Boolean read/write If true, highlights hyphenation and justification rule violations in the text.
Boolean read/write If true, highlights paragraphs that violate keep options.
Boolean read/write If true, uses on-screen highlighting to identify kinsoku.
Boolean read/write If true, highlights missing fonts.
Boolean read/write If true, highlights substituted glyphs.
Boolean read/write If true, modifies indentation for Bulleted Paragraph and Bullets around a Text Wrap object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Boolean read/write If true, justifies text around text wrap objects.
Number 1–100 read/write 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)
Number | String unit read/write 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)
Boolean read/write Restrict the adding of pages during smart text reflow to overridden master text frames.
Boolean read/write If true, links placed text files and spreadsheet files. If false, embeds the files.
Application | Document readonly The parent of the TextPreference (a Application or Document).
Boolean read/write Preserve left-hand and right-and pages when facing pages are enabled during smart text reflow.
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write If true, Japanese composer treats quotes as half width and rotates them in vertical.
Boolean read/write If this bool is set to true, shaping of Indic & Latin characters will be done through Harfbuzz Shaping engine, instead of Lipika.
Boolean read/write If true, shows hidden characters.
Number 1–200 read/write The size of text formatted as small caps, specified as a percentage of the font size. (Range: 1 to 200)
Boolean read/write If true, enable automatic adding and deleting of pages in response to text reflow.
Boolean read/write If this is True, and if Smart text reflow is also enabled, then this will synchronously add/delete pages after text reflowing
Number -500–500 read/write The position of subscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)
Number 1–200 read/write The size of subscript characters, specified as a percentage of the font size. (Range: 0 to 200)
Number -500–500 read/write The position of superscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)
Number 1–200 read/write The size of superscript characters, specified as a percentage of the font size. (Range: 0 to 200)
Boolean read/write If true, converts straight quotes to typographic quotes.
Boolean read/write If true, uses the glyph CID to get the mojikumi class of the character.
Boolean read/write If true, reverses X and Y scaling on Roman characters in vertical text.
Boolean read/write If true, automatically selects the correct optical size.
Boolean read/write 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.
Boolean read/write 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.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
TextPreference[]

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

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

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

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a TextPreference.

Return 1

Methods that return a TextPreference.