Class
Find text preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
FindTextPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allowArbitraryHyphenation | Boolean NothingEnum |
r/w | If true, words unassociated with a hyphenation dictionary can break to the next line on any character. Can return: Boolean or NothingEnum enumerator. |
| appliedCharacterStyle | CharacterStyle NothingEnum String |
r/w | The character style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: CharacterStyle. |
| appliedConditions | NothingEnum Strings |
r/w | The conditions to search for or change to. Specify the "nothing" enum for "Any" or an empty list for "[Unconditional]". Can return: Array of Strings or NothingEnum enumerator. Can also accept: Array of Conditions. |
| appliedFont | Font NothingEnum String |
r/w | The font applied to the FindTextPreference, specified as either a font object or the name of font family. Can return: Font, String or NothingEnum enumerator. |
| appliedLanguage | Language LanguageWithVendors NothingEnum String |
r/w | The language to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Language or LanguageWithVendors. |
| appliedNumberingList | NothingEnum NumberingList String |
r/w | The list to be part of. Can return: NumberingList, String or NothingEnum enumerator. |
| appliedParagraphStyle | NothingEnum ParagraphStyle String |
r/w | The paragraph style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: ParagraphStyle. |
| autoLeading | NothingEnum Real |
r/w | The percent of the type size to use for auto leading. (Range: 0 to 500). Can return: Real or NothingEnum enumerator. |
| autoTcy | NothingEnum Short Integer |
r/w | The number of half-width characters at or below which the characters automatically run horizontally in vertical text. Can return: Short Integer or NothingEnum enumerator. |
| autoTcyIncludeRoman | Boolean NothingEnum |
r/w | If true, auto tcy includes Roman characters. Can return: Boolean or NothingEnum enumerator. |
| balanceRaggedLines | BalanceLinesStyle Boolean NothingEnum |
r/w | If true or set to an enumeration value, balances ragged lines. Note: Not valid with a single-line text composer. Can return: Boolean, BalanceLinesStyle enumerator or NothingEnum enumerator. |
| baselineShift | NothingEnum Unit |
r/w | The baseline shift applied to the text. Can return: Unit or NothingEnum enumerator. |
| bulletChar | Bullet NothingEnum |
readonly | Bullet character. Can return: Bullet or NothingEnum enumerator. |
| bulletsAndNumberingListType | ListType NothingEnum |
r/w | List type for bullets and numbering. Can return: ListType enumerator or NothingEnum enumerator. |
| bulletsCharacterStyle | CharacterStyle NothingEnum String |
r/w | The character style to be used for the text after string. Can return: CharacterStyle, String or NothingEnum enumerator. |
| bulletsTextAfter | NothingEnum String |
r/w | The text after string expression for bullets. Can return: String or NothingEnum enumerator. |
| bunriKinshi | Boolean NothingEnum |
r/w | If true, adds the double period (..), ellipse (...), and double hyphen (--) to the selected kinsoku set. Note: Valid only when a kinsoku set is in effect. Can return: Boolean or NothingEnum enumerator. |
| capitalization | Capitalization NothingEnum |
r/w | The capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator. |
| characterAlignment | CharacterAlignment NothingEnum |
r/w | The alignment of small characters to the largest character in the line. Can return: CharacterAlignment enumerator or NothingEnum enumerator. |
| characterDirection | CharacterDirectionOptions NothingEnum |
r/w | The direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator. |
| characterRotation | NothingEnum Real |
r/w | The rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise. Can return: Real or NothingEnum enumerator. |
| cjkGridTracking | Boolean NothingEnum |
r/w | If true, uses grid tracking to track non-Roman characters in CJK grids. Can return: Boolean or NothingEnum enumerator. |
| composer | NothingEnum String |
r/w | The text composer to use to compose the text. Can return: String or NothingEnum enumerator. |
| diacriticPosition | DiacriticPositionOptions NothingEnum |
r/w | Position of diacriticical characters. Can return: DiacriticPositionOptions enumerator or NothingEnum enumerator. |
| digitsType | DigitsTypeOptions NothingEnum |
r/w | The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum enumerator. |
| dropCapCharacters | NothingEnum Short Integer (0 - 150) |
r/w | The number of characters to drop cap. Can return: Short Integer (0 - 150) or NothingEnum enumerator. |
| dropCapLines | NothingEnum Short Integer (0 - 25) |
r/w | The number of lines to drop cap. Can return: Short Integer (0 - 25) or NothingEnum enumerator. |
| dropcapDetail | Long Integer NothingEnum |
r/w | Details about the drop cap based on the glyph outlines. 1 = left side bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. Can return: Long Integer or NothingEnum enumerator. |
| endJoin | NothingEnum OutlineJoin |
r/w | The stroke join type applied to the characters of the text. Can return: OutlineJoin enumerator or NothingEnum enumerator. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| fillColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink), applied as a fill color, to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Swatch. |
| fillTint | NothingEnum Real |
r/w | The tint (as a percentage) of the fill color of the FindTextPreference. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: Real or NothingEnum enumerator. |
| findWhat | NothingEnum String |
r/w | The FindTextPreference to find. Can return: String or NothingEnum enumerator. |
| firstLineIndent | NothingEnum Unit |
r/w | The amount to indent the first line. Can return: Unit or NothingEnum enumerator. |
| fontStyle | NothingEnum String |
r/w | The name of the font style. Can return: String or NothingEnum enumerator. |
| glyphForm | AlternateGlyphForms NothingEnum |
r/w | The glyph variant to substitute for standard glyphs. Can return: AlternateGlyphForms enumerator or NothingEnum enumerator. |
| gradientFillAngle | NothingEnum Real |
r/w | The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. |
| gradientFillLength | NothingEnum Real |
r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. Can return: Real or NothingEnum enumerator. |
| gradientFillStart | 2 Units NothingEnum |
r/w | The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator. |
| gradientStrokeAngle | NothingEnum Real |
r/w | The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. |
| gradientStrokeLength | NothingEnum Real |
r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. Can return: Real or NothingEnum enumerator. |
| gradientStrokeStart | 2 Units NothingEnum |
r/w | The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator. |
| gridAlignment | GridAlignment NothingEnum |
r/w | The alignment to the frame grid or baseline grid. Can return: GridAlignment enumerator or NothingEnum enumerator. |
| gridGyoudori | NothingEnum Short Integer |
r/w | The manual gyoudori setting. Can return: Short Integer or NothingEnum enumerator. |
| horizontalScale | NothingEnum Real |
r/w | The horizontal scaling applied to the FindTextPreference. Can return: Real or NothingEnum enumerator. |
| hyphenateAcrossColumns | Boolean NothingEnum |
r/w | If true, allows the last word in a text column to be hyphenated. Can return: Boolean or NothingEnum enumerator. |
| hyphenateLastWord | Boolean NothingEnum |
r/w | If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. Can return: Boolean or NothingEnum enumerator. |
| ignoreEdgeAlignment | Boolean NothingEnum |
r/w | If true, ignores optical edge alignment for the paragraph. Can return: Boolean or NothingEnum enumerator. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| jidori | NothingEnum Short Integer |
r/w | The number of grid squares in which to arrange the text. . Can return: Short Integer or NothingEnum enumerator. |
| justification | Justification NothingEnum |
r/w | The paragraph alignment. Can return: Justification enumerator or NothingEnum enumerator. |
| kashidas | KashidasOptions NothingEnum |
r/w | Use of Kashidas for justification. Can return: KashidasOptions enumerator or NothingEnum enumerator. |
| keepAllLinesTogether | Boolean NothingEnum |
r/w | If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. Can return: Boolean or NothingEnum enumerator. |
| keepFirstLines | NothingEnum Short Integer (1 - 50) |
r/w | The minimum number of lines to keep together in a paragraph before allowing a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. |
| keepLastLines | NothingEnum Short Integer (1 - 50) |
r/w | The minimum number of lines to keep together in a paragraph after a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. |
| keepLinesTogether | Boolean NothingEnum |
r/w | If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. Can return: Boolean or NothingEnum enumerator. |
| keepRuleAboveInFrame | Boolean NothingEnum |
r/w | If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true. Can return: Boolean or NothingEnum enumerator. |
| keepWithNext | NothingEnum Short Integer (0 - 5) |
r/w | The minimum number of lines to keep with the next paragraph. Can return: Short Integer (0 - 5) or NothingEnum enumerator. |
| keepWithPrevious | Boolean NothingEnum |
r/w | If the first line in the paragraph should be kept with the last line of previous paragraph. Can return: Boolean or NothingEnum enumerator. |
| kentenAlignment | KentenAlignment NothingEnum |
r/w | The alignment of kenten characters relative to the parent characters. . Can return: KentenAlignment enumerator or NothingEnum enumerator. |
| kentenCharacterSet | KentenCharacterSet NothingEnum |
r/w | The character set used for the custom kenten character. Note: Valid only when kenten kind is custom. . Can return: KentenCharacterSet enumerator or NothingEnum enumerator. |
| kentenCustomCharacter | NothingEnum String |
r/w | The character used for kenten. Note: Valid only when kenten kind is custom. Can return: String or NothingEnum enumerator. |
| kentenFillColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch, String or NothingEnum enumerator. |
| kentenFont | Font NothingEnum String |
r/w | The font to use for kenten characters. Can return: Font, String or NothingEnum enumerator. |
| kentenFontSize | NothingEnum Real |
r/w | The size (in points) of kenten characters. Can return: Real or NothingEnum enumerator. |
| kentenFontStyle | NothingEnum String |
r/w | The font style of kenten characters. Can return: String or NothingEnum enumerator. |
| kentenKind | KentenCharacter NothingEnum |
r/w | The style of kenten characters. Can return: KentenCharacter enumerator or NothingEnum enumerator. |
| kentenOverprintFill | AdornmentOverprint NothingEnum |
r/w | The method of overprinting the kenten fill. Can return: AdornmentOverprint enumerator or NothingEnum enumerator. |
| kentenOverprintStroke | AdornmentOverprint NothingEnum |
r/w | The method of overprinting the kenten stroke. Can return: AdornmentOverprint enumerator or NothingEnum enumerator. |
| kentenPlacement | NothingEnum Real |
r/w | The distance between kenten characters and their parent characters. Can return: Real or NothingEnum enumerator. |
| kentenPosition | NothingEnum RubyKentenPosition |
r/w | The kenten position relative to the parent character. Can return: RubyKentenPosition enumerator or NothingEnum enumerator. |
| kentenStrokeColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch, String or NothingEnum enumerator. |
| kentenStrokeTint | NothingEnum Real |
r/w | The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| kentenTint | NothingEnum Real |
r/w | The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| kentenWeight | NothingEnum Real |
r/w | The stroke weight (in points) of kenten characters. Can return: Real or NothingEnum enumerator. |
| kentenXScale | NothingEnum Real |
r/w | The horizontal size of kenten characters as a percent of the original size. Can return: Real or NothingEnum enumerator. |
| kentenYScale | NothingEnum Real |
r/w | The vertical size of kenten charachers as a percent of the original size. . Can return: Real or NothingEnum enumerator. |
| kerningMethod | NothingEnum String |
r/w | The type of pair kerning. Can return: String or NothingEnum enumerator. |
| kerningValue | NothingEnum Real |
r/w | The amount of space to add or remove between characters, specified in thousands of an em. . Can return: Real or NothingEnum enumerator. |
| keyboardDirection | CharacterDirectionOptions NothingEnum |
r/w | The keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator. |
| kinsokuHangType | KinsokuHangTypes NothingEnum |
r/w | The type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect. Can return: KinsokuHangTypes enumerator or NothingEnum enumerator. |
| kinsokuSet | KinsokuSet KinsokuTable NothingEnum String |
r/w | The kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator, String or NothingEnum enumerator. |
| kinsokuType | KinsokuType NothingEnum |
r/w | The type of kinsoku processing for preventing kinsoku characters from beginning or ending a line. Note: Valid only when a kinsoku set is defined. Can return: KinsokuType enumerator or NothingEnum enumerator. |
| lastLineIndent | NothingEnum Unit |
r/w | The amount to indent the last line in the paragraph. Can return: Unit or NothingEnum enumerator. |
| leading | Leading NothingEnum Unit |
r/w | The leading applied to the text. Can return: Unit, Leading enumerator or NothingEnum enumerator. |
| leadingAki | NothingEnum Real |
r/w | The amount of space before each character. Can return: Real or NothingEnum enumerator. |
| leadingModel | LeadingModel NothingEnum |
r/w | The point from which leading is measured from line to line. Can return: LeadingModel enumerator or NothingEnum enumerator. |
| leftIndent | NothingEnum Unit |
r/w | The width of the left indent. Can return: Unit or NothingEnum enumerator. |
| ligatures | Boolean NothingEnum |
r/w | If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator. |
| miterLimit | NothingEnum Real (0 - 1000) |
r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. Can return: Real (0 - 1000) or NothingEnum enumerator. (default: 4) |
| mojikumi | MojikumiTable MojikumiTableDefaults NothingEnum String |
r/w | The mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String, MojikumiTableDefaults enumerator or NothingEnum enumerator. |
| noBreak | Boolean NothingEnum |
r/w | If true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator. |
| numberingApplyRestartPolicy | Boolean NothingEnum |
r/w | If true, apply the numbering restart policy. Can return: Boolean or NothingEnum enumerator. |
| numberingCharacterStyle | CharacterStyle NothingEnum String |
r/w | The character style to be used for the number string. Can return: CharacterStyle, String or NothingEnum enumerator. |
| numberingContinue | Boolean NothingEnum |
r/w | Continue the numbering at this level. Can return: Boolean or NothingEnum enumerator. |
| numberingExpression | NothingEnum String |
r/w | The number string expression for numbering. Can return: String or NothingEnum enumerator. |
| numberingFormat | NothingEnum NumberingStyle String |
r/w | Numbering format options. Can return: NumberingStyle enumerator, String or NothingEnum enumerator. |
| numberingLevel | Long Integer NothingEnum |
r/w | The level of the paragraph. Can return: Long Integer or NothingEnum enumerator. |
| numberingRestartPolicies | NothingEnum NumberingRestartPolicy |
readonly | Numbering restart policies. Can return: NumberingRestartPolicy or NothingEnum enumerator. |
| numberingStartAt | Long Integer NothingEnum |
r/w | Determines starting number in a numbered list. Can return: Long Integer or NothingEnum enumerator. |
| otfContextualAlternate | Boolean NothingEnum |
r/w | If true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfDiscretionaryLigature | Boolean NothingEnum |
r/w | If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfFigureStyle | NothingEnum OTFFigureStyle |
r/w | The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator. |
| otfFraction | Boolean NothingEnum |
r/w | If true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfHVKana | Boolean NothingEnum |
r/w | If true, switches hiragana fonts, which have different glyphs for horizontal and vertical. . Can return: Boolean or NothingEnum enumerator. |
| otfHistorical | Boolean NothingEnum |
r/w | If true, use historical forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfJustificationAlternate | Boolean NothingEnum |
r/w | If true, use alternate justification forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfLocale | Boolean NothingEnum |
r/w | If true, uses localized forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfMark | Boolean NothingEnum |
r/w | If true, uses mark positioning in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfOrdinal | Boolean NothingEnum |
r/w | If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfOverlapSwash | Boolean NothingEnum |
r/w | If true, use overlapping swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfProportionalMetrics | Boolean NothingEnum |
r/w | If true, kerns according to proportional CJK metrics in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfRomanItalics | Boolean NothingEnum |
r/w | If true, applies italics to half-width alphanumerics. . Can return: Boolean or NothingEnum enumerator. |
| otfSlashedZero | Boolean NothingEnum |
r/w | If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfStretchedAlternate | Boolean NothingEnum |
r/w | If true, use stretched alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfStylisticAlternate | Boolean NothingEnum |
r/w | If true, use stylistic alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfStylisticSets | Long Integer NothingEnum |
r/w | The stylistic sets to use in OpenType fonts. Can return: Long Integer or NothingEnum enumerator. |
| otfSwash | Boolean NothingEnum |
r/w | If true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfTitling | Boolean NothingEnum |
r/w | If true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| overprintFill | Boolean NothingEnum |
r/w | If true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator. |
| overprintStroke | Boolean NothingEnum |
r/w | If true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator. |
| paragraphDirection | NothingEnum ParagraphDirectionOptions |
r/w | Paragraph direction. Can return: ParagraphDirectionOptions enumerator or NothingEnum enumerator. |
| paragraphGyoudori | Boolean NothingEnum |
r/w | If true, the gyoudori mode applies to the entire paragraph. If false, the gyoudori mode applies to each line in the paragraph. Can return: Boolean or NothingEnum enumerator. |
| paragraphJustification | NothingEnum ParagraphJustificationOptions |
r/w | Paragraph justification. Can return: ParagraphJustificationOptions enumerator or NothingEnum enumerator. |
| parent | Application | readonly | The parent of the FindTextPreference (a Application). |
| pointSize | NothingEnum Unit |
r/w | The text size. Can return: Unit or NothingEnum enumerator. |
| position | NothingEnum Position |
r/w | The text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator. |
| positionalForm | NothingEnum PositionalForms |
r/w | The OpenType positional form. Can return: PositionalForms enumerator or NothingEnum enumerator. |
| preferences | Preferences | readonly | A collection of preferences objects. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rensuuji | Boolean NothingEnum |
r/w | If true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers. Can return: Boolean or NothingEnum enumerator. |
| rightIndent | NothingEnum Unit |
r/w | The width of the right indent. Can return: Unit or NothingEnum enumerator. |
| rotateSingleByteCharacters | Boolean NothingEnum |
r/w | If true, rotates Roman characters in vertical text. Can return: Boolean or NothingEnum enumerator. |
| rubyAlignment | NothingEnum RubyAlignments |
r/w | The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum enumerator. |
| rubyAutoAlign | Boolean NothingEnum |
r/w | If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator. |
| rubyAutoScaling | Boolean NothingEnum |
r/w | If true, automatically scales ruby to the specified percent of parent text size. For information on specifying a percent, see ruby parent scaling percent. . Can return: Boolean or NothingEnum enumerator. |
| rubyAutoTcyAutoScale | Boolean NothingEnum |
r/w | If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em. Can return: Boolean or NothingEnum enumerator. |
| rubyAutoTcyDigits | NothingEnum Short Integer |
r/w | The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can return: Short Integer or NothingEnum enumerator. |
| rubyAutoTcyIncludeRoman | Boolean NothingEnum |
r/w | If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can return: Boolean or NothingEnum enumerator. |
| rubyFill | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch, String or NothingEnum enumerator. |
| rubyFont | Font NothingEnum String |
r/w | The font applied to ruby characters. Can return: Font, String or NothingEnum enumerator. |
| rubyFontSize | NothingEnum Real |
r/w | The size (in points) of ruby characters. Can return: Real or NothingEnum enumerator. |
| rubyFontStyle | NothingEnum String |
r/w | The font style of ruby characters. Can return: String or NothingEnum enumerator. |
| rubyOpenTypePro | Boolean NothingEnum |
r/w | If true, uses OpenType Pro fonts for ruby. Can return: Boolean or NothingEnum enumerator. |
| rubyOverhang | Boolean NothingEnum |
r/w | If true, constrains ruby overhang to the specified amount. For information on specifying an amount, see ruby parent overhang amount. . Can return: Boolean or NothingEnum enumerator. |
| rubyOverprintFill | AdornmentOverprint NothingEnum |
r/w | The method of overprinting the ruby fill. Can return: AdornmentOverprint enumerator or NothingEnum enumerator. |
| rubyOverprintStroke | AdornmentOverprint NothingEnum |
r/w | The method of overprinting the ruby stroke. Can return: AdornmentOverprint enumerator or NothingEnum enumerator. |
| rubyParentOverhangAmount | NothingEnum RubyOverhang |
r/w | The amount by which ruby characters can overhang the parent text. Can return: RubyOverhang enumerator or NothingEnum enumerator. |
| rubyParentScalingPercent | NothingEnum Real |
r/w | The amount (as a percentage) to scale the parent text size to determine the ruby text size. Can return: Real or NothingEnum enumerator. |
| rubyParentSpacing | NothingEnum RubyParentSpacing |
r/w | The ruby spacing relative to the parent text. . Can return: RubyParentSpacing enumerator or NothingEnum enumerator. |
| rubyPosition | NothingEnum RubyKentenPosition |
r/w | The position of ruby characters relative to the parent text. Can return: RubyKentenPosition enumerator or NothingEnum enumerator. |
| rubyStroke | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch, String or NothingEnum enumerator. |
| rubyStrokeTint | NothingEnum Real |
r/w | The stroke tint (as a percentage) of ruby characters. Can return: Real or NothingEnum enumerator. |
| rubyTint | NothingEnum Real |
r/w | The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| rubyType | NothingEnum RubyTypes |
r/w | The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator. |
| rubyWeight | NothingEnum Real |
r/w | The stroke weight (in points) of ruby characters. Can return: Real or NothingEnum enumerator. |
| rubyXOffset | NothingEnum Real |
r/w | The amount of horizontal space between ruby and parent characters. Can return: Real or NothingEnum enumerator. |
| rubyXScale | NothingEnum Real |
r/w | The horizontal size of ruby characters, specified as a percent of the original size. Can return: Real or NothingEnum enumerator. |
| rubyYOffset | NothingEnum Real |
r/w | The amount of vertical space between ruby and parent characters. Can return: Real or NothingEnum enumerator. |
| rubyYScale | NothingEnum Real |
r/w | The vertical size of ruby characters, specified as a percent of the original size. Can return: Real or NothingEnum enumerator. |
| scaleAffectsLineHeight | Boolean NothingEnum |
r/w | If true, the line changes size when characters are scaled. . Can return: Boolean or NothingEnum enumerator. |
| shataiAdjustRotation | Boolean NothingEnum |
r/w | If true, applies shatai rotation. Can return: Boolean or NothingEnum enumerator. |
| shataiAdjustTsume | Boolean NothingEnum |
r/w | If true, adjusts shatai tsume. Can return: Boolean or NothingEnum enumerator. |
| shataiDegreeAngle | NothingEnum Real |
r/w | The shatai lens angle (in degrees). Can return: Real or NothingEnum enumerator. |
| shataiMagnification | NothingEnum Real |
r/w | The amount (as a percentage) of shatai obliquing to apply. Can return: Real or NothingEnum enumerator. |
| singleWordJustification | NothingEnum SingleWordJustification |
r/w | The alignment to use for lines that contain a single word. Can return: SingleWordJustification enumerator or NothingEnum enumerator. |
| skew | NothingEnum Real |
r/w | The skew angle of the FindTextPreference. Can return: Real or NothingEnum enumerator. |
| spaceAfter | NothingEnum Unit |
r/w | The height of the paragraph space below. Can return: Unit or NothingEnum enumerator. |
| spaceBefore | NothingEnum Unit |
r/w | The height of the paragraph space above. Can return: Unit or NothingEnum enumerator. |
| spanColumnMinSpaceAfter | NothingEnum Unit |
r/w | The minimum space after a span or a split column. Can return: Unit or NothingEnum enumerator. |
| spanColumnMinSpaceBefore | NothingEnum Unit |
r/w | The minimum space before a span or a split column. Can return: Unit or NothingEnum enumerator. |
| spanColumnType | NothingEnum SpanColumnTypeOptions |
r/w | Whether a paragraph should be a single column, span columns or split columns. Can return: SpanColumnTypeOptions enumerator or NothingEnum enumerator. |
| spanSplitColumnCount | NothingEnum Short Integer (1 - 40) SpanColumnCountOptions |
r/w | The number of columns a paragraph spans or the number of split columns. Can return: Short Integer (1 - 40), SpanColumnCountOptions enumerator or NothingEnum enumerator. |
| splitColumnInsideGutter | NothingEnum Unit |
r/w | The inside gutter if the paragraph splits columns. Can return: Unit or NothingEnum enumerator. |
| splitColumnOutsideGutter | NothingEnum Unit |
r/w | The outside gutter if the paragraph splits columns. Can return: Unit or NothingEnum enumerator. |
| startParagraph | NothingEnum StartParagraph |
r/w | The location at which to start the paragraph. Can return: StartParagraph enumerator or NothingEnum enumerator. |
| strikeThroughColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. |
| strikeThroughGapColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. |
| strikeThroughGapOverprint | Boolean NothingEnum |
r/w | If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. Can return: Boolean or NothingEnum enumerator. |
| strikeThroughGapTint | NothingEnum Real |
r/w | The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid. Can return: Real or NothingEnum enumerator. |
| strikeThroughOffset | NothingEnum Unit |
r/w | The amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator. |
| strikeThroughOverprint | Boolean NothingEnum |
r/w | If true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| strikeThroughTint | NothingEnum Real |
r/w | The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| strikeThroughType | NothingEnum String StrokeStyle |
r/w | The stroke type of the strikethrough stroke. Can return: StrokeStyle, String or NothingEnum enumerator. |
| strikeThroughWeight | NothingEnum Unit |
r/w | The stroke weight of the strikethrough stroke. Can return: Unit or NothingEnum enumerator. |
| strikeThru | Boolean NothingEnum |
r/w | If true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator. |
| strokeAlignment | NothingEnum TextStrokeAlign |
r/w | The stroke alignment applied to the text. Can return: TextStrokeAlign enumerator or NothingEnum enumerator. |
| strokeColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Swatch. |
| strokeTint | NothingEnum Real |
r/w | The tint (as a percentage) of the stroke color of the FindTextPreference. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: Real or NothingEnum enumerator. |
| strokeWeight | NothingEnum Unit |
r/w | The stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator. |
| tatechuyoko | Boolean NothingEnum |
r/w | If true, makes the character horizontal in vertical text. Can return: Boolean or NothingEnum enumerator. |
| tatechuyokoXOffset | NothingEnum Real |
r/w | The horizontal offset for horizontal characters in vertical text. Can return: Real or NothingEnum enumerator. |
| tatechuyokoYOffset | NothingEnum Real |
r/w | The vertical offset for horizontal characters in vertical text. Can return: Real or NothingEnum enumerator. |
| tracking | NothingEnum Real |
r/w | The amount by which to loosen or tighten a block of text, specified in thousands of an em. Can return: Real or NothingEnum enumerator. |
| trailingAki | NothingEnum Real |
r/w | The amount of space after each character. Can return: Real or NothingEnum enumerator. |
| treatIdeographicSpaceAsSpace | Boolean NothingEnum |
r/w | If true, ideographic spaces will not wrap to the next line like text characters. Can return: Boolean or NothingEnum enumerator. |
| tsume | NothingEnum Real |
r/w | The amount of horizontal character compression. Can return: Real or NothingEnum enumerator. |
| underline | Boolean NothingEnum |
r/w | If true, underlines the text. Can return: Boolean or NothingEnum enumerator. |
| underlineColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator. |
| underlineGapColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the underline stroke. Note: Valid when underline type is not solid. Can return: Swatch, String or NothingEnum enumerator. |
| underlineGapOverprint | Boolean NothingEnum |
r/w | If true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| underlineGapTint | NothingEnum Real |
r/w | The tint (as a percentage) of the gap color of the underline stroke. (Range: 0 to 100) Note: Valid when underline type is not solid. Can return: Real or NothingEnum enumerator. |
| underlineOffset | NothingEnum Unit |
r/w | The amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator. |
| underlineOverprint | Boolean NothingEnum |
r/w | If true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator. |
| underlineTint | NothingEnum Real |
r/w | The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| underlineType | NothingEnum String StrokeStyle |
r/w | The stroke type of the underline stroke. Can return: StrokeStyle, String or NothingEnum enumerator. |
| underlineWeight | NothingEnum Unit |
r/w | The stroke weight of the underline stroke. Can return: Unit or NothingEnum enumerator. |
| verticalScale | NothingEnum Real |
r/w | The vertical scaling applied to the FindTextPreference. Can return: Real or NothingEnum enumerator. |
| warichu | Boolean NothingEnum |
r/w | If true, turns on warichu. Can return: Boolean or NothingEnum enumerator. |
| warichuAlignment | NothingEnum WarichuAlignment |
r/w | The warichu alignment. Can return: WarichuAlignment enumerator or NothingEnum enumerator. |
| warichuCharsAfterBreak | NothingEnum Short Integer |
r/w | The minimum number of characters allowed after a line break. . Can return: Short Integer or NothingEnum enumerator. |
| warichuCharsBeforeBreak | NothingEnum Short Integer |
r/w | The minimum number of characters allowed before a line break. Can return: Short Integer or NothingEnum enumerator. |
| warichuLineSpacing | NothingEnum Real |
r/w | The gap between lines of warichu characters. Can return: Real or NothingEnum enumerator. |
| warichuLines | NothingEnum Short Integer |
r/w | The number of lines of warichu within a single normal line. Can return: Short Integer or NothingEnum enumerator. |
| warichuSize | NothingEnum Real |
r/w | The amount (as a percentage) to scale parent text size to determine warichu size. Can return: Real or NothingEnum enumerator. |
| xOffsetDiacritic | NothingEnum Real |
r/w | The x (horizontal) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator. |
| yOffsetDiacritic | NothingEnum Real |
r/w | The y (vertical) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator. |
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 FindTextPreference 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 FindTextPreference.
Element of
Application.findTextPreferences
Return
Array of FindTextPreference FindTextPreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |