Class
Text preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
TextPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| abutTextToTextWrap | bool | r/w | If true, moves wrapped text to the next available leading increment below the text wrap objects (skip by leading). |
| addPages | AddPageOptions: AddPageOptions.END_OF_STORY AddPageOptions.END_OF_SECTION AddPageOptions.END_OF_DOCUMENT |
r/w | Specifies where to insert new pages in response to overset text. |
| baselineShiftKeyIncrement | Measurement Unit (Number or String) (range: 0.001 - 200) | r/w | 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 | bool | r/w | Enable auto-deletion of pages containing empty threaded text frames. |
| enableStylePreviewMode | bool | r/w | If true, highlights character and paragraph styles with colored backgrounds. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| highlightCustomSpacing | bool | r/w | If true, highlights custom kerned or tracked characters. |
| highlightHjViolations | bool | r/w | If true, highlights hyphenation and justification rule violations in the text. |
| highlightKeeps | bool | r/w | If true, highlights paragraphs that violate keep options. |
| highlightKinsoku | bool | r/w | If true, uses on-screen highlighting to identify kinsoku. |
| highlightSubstitutedFonts | bool | r/w | If true, highlights missing fonts. |
| highlightSubstitutedGlyphs | bool | r/w | If true, highlights substituted glyphs. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| justifyTextWraps | bool | r/w | If true, justifies text around text wrap objects. |
| kerningKeyIncrement | number (range: 1 - 100) | r/w | 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 | Measurement Unit (Number or String) (range: 0.001 - 200) | r/w | 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 | bool | r/w | Restrict the adding of pages during smart text reflow to overridden master text frames. |
| linkTextFilesWhenImporting | bool | r/w | 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 | bool | r/w | Preserve left-hand and right-and pages when facing pages are enabled during smart text reflow. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| showInvisibles | bool | r/w | If true, shows hidden characters. |
| smallCap | number (range: 1 - 200) | r/w | The size of text formatted as small caps, specified as a percentage of the font size. (Range: 1 to 200) |
| smartTextReflow | bool | r/w | If true, enable automatic adding and deleting of pages in response to text reflow. |
| subscriptPosition | number (range: -500 - 500) | r/w | The position of subscript characters, specified as a percentage of the regular leading. (Range: -500 to 500) |
| subscriptSize | number (range: 1 - 200) | r/w | The size of subscript characters, specified as a percentage of the font size. (Range: 0 to 200) |
| superscriptPosition | number (range: -500 - 500) | r/w | The position of superscript characters, specified as a percentage of the regular leading. (Range: -500 to 500) |
| superscriptSize | number (range: 1 - 200) | r/w | The size of superscript characters, specified as a percentage of the font size. (Range: 0 to 200) |
| typographersQuotes | bool | r/w | If true, converts straight quotes to typographic quotes. |
| useCidMojikumi | bool | r/w | If true, uses the glyph CID to get the mojikumi class of the character. |
| useNewVerticalScaling | bool | r/w | If true, reverses X and Y scaling on Roman characters in vertical text. |
| useOpticalSize | bool | r/w | If true, automatically selects the correct optical size. |
| useParagraphLeading | bool | r/w | 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 | bool | r/w | 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
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 TextPreference 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 TextPreference.
Element of
Application.textPreferences
Document.textPreferences
Return
Array of TextPreference TextPreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |