TextPreference

Text preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

AddPageOptions, Boolean, EventListeners, Events, Number, Object, String

Hierarchy:

Superclass: Preference

Class: TextPreference

Property Listing

Property

Type

Access

Description

abutTextToTextWrap

Boolean

read/write

If true, moves wrapped text to the next available leading increment below the text wrap objects (skip by leading).

addPages

AddPageOptions

AddPageOptions.END_OF_DOCUMENT

AddPageOptions.END_OF_SECTION

AddPageOptions.END_OF_STORY

read/write

Specifies where to insert new pages in response to overset text.

baselineShiftKeyIncrement

Number

String

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)

deleteEmptyPages

Boolean

read/write

Enable auto-deletion of pages containing empty threaded text frames.

enableStylePreviewMode

Boolean

read/write

If true, highlights character and paragraph styles with colored backgrounds.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

highlightCustomSpacing

Boolean

read/write

If true, highlights custom kerned or tracked characters.

highlightHjViolations

Boolean

read/write

If true, highlights hyphenation and justification rule violations in the text.

highlightKeeps

Boolean

read/write

If true, highlights paragraphs that violate keep options.

highlightKinsoku

Boolean

read/write

If true, uses on-screen highlighting to identify kinsoku.

highlightSubstitutedFonts

Boolean

read/write

If true, highlights missing fonts.

highlightSubstitutedGlyphs

Boolean

read/write

If true, highlights substituted glyphs.

honourTextIndentsWithTextWrap

Boolean

read/write

If true, modifies indentation for Bulleted Paragraph and Bullets around a Text Wrap object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

justifyTextWraps

Boolean

read/write

If true, justifies text around text wrap objects.

kerningKeyIncrement

Number (range 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)

leadingKeyIncrement

Number

String

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)

limitToMasterTextFrames

Boolean

read/write

Restrict the adding of pages during smart text reflow to overridden master text frames.

linkTextFilesWhenImporting

Boolean

read/write

If true, links placed text files and spreadsheet files. If false, embeds the files.

parent

Application

Document

readonly

The parent of the TextPreference (a Application or Document).

preserveFacingPageSpreads

Boolean

read/write

Preserve left-hand and right-and pages when facing pages are enabled during smart text reflow.

properties

Object

read/write

A property that allows setting of several properties at the same time.

quoteCharactersRotatedInVertical

Boolean

read/write

If true, Japanese composer treats quotes as half width and rotates them in vertical.

shapeIndicAndLatinWithHarbuzz

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.

showInvisibles

Boolean

read/write

If true, shows hidden characters.

smallCap

Number (range 1 - 200)

read/write

The size of text formatted as small caps, specified as a percentage of the font size. (Range: 1 to 200)

smartTextReflow

Boolean

read/write

If true, enable automatic adding and deleting of pages in response to text reflow.

smartTextReflowSync

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

subscriptPosition

Number (range -500 - 500)

read/write

The position of subscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)

subscriptSize

Number (range 1 - 200)

read/write

The size of subscript characters, specified as a percentage of the font size. (Range: 0 to 200)

superscriptPosition

Number (range -500 - 500)

read/write

The position of superscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)

superscriptSize

Number (range 1 - 200)

read/write

The size of superscript characters, specified as a percentage of the font size. (Range: 0 to 200)

typographersQuotes

Boolean

read/write

If true, converts straight quotes to typographic quotes.

useCidMojikumi

Boolean

read/write

If true, uses the glyph CID to get the mojikumi class of the character.

useNewVerticalScaling

Boolean

read/write

If true, reverses X and Y scaling on Roman characters in vertical text.

useOpticalSize

Boolean

read/write

If true, automatically selects the correct optical size.

useParagraphLeading

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.

zOrderTextWrap

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.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

TextPreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.textPreferences

Document.textPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

TextPreference.getElements()