Adobe InDesign CS5 Server (7.0) Object Model JS: TextPreference

InDesign Server CS5

Class

TextPreference

 Text preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
TextPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
abutTextToTextWrapbool r/wIf true, moves wrapped text to the next available leading increment below the text wrap objects (skip by leading).
addPagesAddPageOptions:
AddPageOptions.END_OF_STORY
AddPageOptions.END_OF_SECTION
AddPageOptions.END_OF_DOCUMENT
r/wSpecifies where to insert new pages in response to overset text.
baselineShiftKeyIncrementMeasurement Unit (Number or String) (range: 0.001 - 200) r/wThe 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)
deleteEmptyPagesbool r/wEnable auto-deletion of pages containing empty threaded text frames.
enableStylePreviewModebool r/wIf true, highlights character and paragraph styles with colored backgrounds.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
highlightCustomSpacingbool r/wIf true, highlights custom kerned or tracked characters.
highlightHjViolationsbool r/wIf true, highlights hyphenation and justification rule violations in the text.
highlightKeepsbool r/wIf true, highlights paragraphs that violate keep options.
highlightKinsokubool r/wIf true, uses on-screen highlighting to identify kinsoku.
highlightSubstitutedFontsbool r/wIf true, highlights missing fonts.
highlightSubstitutedGlyphsbool r/wIf true, highlights substituted glyphs.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
justifyTextWrapsbool r/wIf true, justifies text around text wrap objects.
kerningKeyIncrementnumber (range: 1 - 100) r/wThe 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)
leadingKeyIncrementMeasurement Unit (Number or String) (range: 0.001 - 200) r/wThe 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)
limitToMasterTextFramesbool r/wRestrict the adding of pages during smart text reflow to overridden master text frames.
linkTextFilesWhenImportingbool r/wIf true, links placed text files and spreadsheet files. If false, embeds the files.
parentApplication
Document
readonlyThe parent of the TextPreference (a Application or Document).
preserveFacingPageSpreadsbool r/wPreserve left-hand and right-and pages when facing pages are enabled during smart text reflow.
propertiesObject r/wA property that allows setting of several properties at the same time.
showInvisiblesbool r/wIf true, shows hidden characters.
smallCapnumber (range: 1 - 200) r/wThe size of text formatted as small caps, specified as a percentage of the font size. (Range: 1 to 200)
smartTextReflowbool r/wIf true, enable automatic adding and deleting of pages in response to text reflow.
subscriptPositionnumber (range: -500 - 500) r/wThe position of subscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)
subscriptSizenumber (range: 1 - 200) r/wThe size of subscript characters, specified as a percentage of the font size. (Range: 0 to 200)
superscriptPositionnumber (range: -500 - 500) r/wThe position of superscript characters, specified as a percentage of the regular leading. (Range: -500 to 500)
superscriptSizenumber (range: 1 - 200) r/wThe size of superscript characters, specified as a percentage of the font size. (Range: 0 to 200)
typographersQuotesbool r/wIf true, converts straight quotes to typographic quotes.
useCidMojikumibool r/wIf true, uses the glyph CID to get the mojikumi class of the character.
useNewVerticalScalingbool r/wIf true, reverses X and Y scaling on Roman characters in vertical text.
useOpticalSizebool r/wIf true, automatically selects the correct optical size.
useParagraphLeadingbool r/wIf true, applies the leading changes made to a text range to the entire paragraph. If false, applies leading changes only to the text range.
zOrderTextWrapbool r/wIf 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.textPreferences

Document.textPreferences

Return

Array of TextPreference TextPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index