Adobe InDesign CS6 (8.0) Object Model JS: ChangeTextPreference

InDesign CS6

Class

ChangeTextPreference

 Change text preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
ChangeTextPreference
Bullet | Event | EventListener | MutationEvent | NumberingRestartPolicy | Preference

Properties

PropertyTypeAccessDescription
allowArbitraryHyphenationBooleanNothingEnum r/wIf true, words unassociated with a hyphenation dictionary can break to the next line on any character. Can return: Boolean or NothingEnum enumerator.
appliedCharacterStyleCharacterStyle
NothingEnum
String
r/wThe character style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: CharacterStyle.
appliedConditionsNothingEnum
Strings
r/wThe 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.
appliedFontFont
NothingEnum
String
r/wThe font applied to the ChangeTextPreference, specified as either a font object or the name of font family. Can return: Font, String or NothingEnum enumerator.
appliedLanguageLanguage
LanguageWithVendors
NothingEnum
String
r/wThe language to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Language or LanguageWithVendors.
appliedNumberingListNothingEnum
NumberingList
String
r/wThe list to be part of. Can return: NumberingList, String or NothingEnum enumerator.
appliedParagraphStyleNothingEnum
ParagraphStyle
String
r/wThe paragraph style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: ParagraphStyle.
autoLeadingNothingEnum
Real
r/wThe percent of the type size to use for auto leading. (Range: 0 to 500). Can return: Real or NothingEnum enumerator.
autoTcyNothingEnum
Short Integer
r/wThe number of half-width characters at or below which the characters automatically run horizontally in vertical text. Can return: Short Integer or NothingEnum enumerator.
autoTcyIncludeRomanBoolean
NothingEnum
r/wIf true, auto tcy includes Roman characters. Can return: Boolean or NothingEnum enumerator.
balanceRaggedLinesBalanceLinesStyle
Boolean
NothingEnum
r/wIf 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.
baselineShiftNothingEnum
Unit
r/wThe baseline shift applied to the text. Can return: Unit or NothingEnum enumerator.
bulletCharBullet
NothingEnum
readonlyBullet character. Can return: Bullet or NothingEnum enumerator.
bulletsAndNumberingListTypeListType
NothingEnum
r/wList type for bullets and numbering. Can return: ListType enumerator or NothingEnum enumerator.
bulletsCharacterStyleCharacterStyle
NothingEnum
String
r/wThe character style to be used for the text after string. Can return: CharacterStyle, String or NothingEnum enumerator.
bulletsTextAfterNothingEnum
String
r/wThe text after string expression for bullets. Can return: String or NothingEnum enumerator.
bunriKinshiBoolean
NothingEnum
r/wIf 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.
capitalizationCapitalization
NothingEnum
r/wThe capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator.
changeConditionsModeChangeConditionsModes
NothingEnum
r/wThe change conditions mode, change either replaces applied conditions or adds to applied conditions. Can return: ChangeConditionsModes enumerator or NothingEnum enumerator.
changeToNothingEnum
String
r/wThe replacement ChangeTextPreference. Can return: String or NothingEnum enumerator.
characterAlignmentCharacterAlignment
NothingEnum
r/wThe alignment of small characters to the largest character in the line. Can return: CharacterAlignment enumerator or NothingEnum enumerator.
characterDirectionCharacterDirectionOptions
NothingEnum
r/wThe direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
characterRotationNothingEnum
Real
r/wThe rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise. Can return: Real or NothingEnum enumerator.
cjkGridTrackingBoolean
NothingEnum
r/wIf true, uses grid tracking to track non-Roman characters in CJK grids. Can return: Boolean or NothingEnum enumerator.
composerNothingEnum
String
r/wThe text composer to use to compose the text. Can return: String or NothingEnum enumerator.
diacriticPositionDiacriticPositionOptions
NothingEnum
r/wPosition of diacriticical characters. Can return: DiacriticPositionOptions enumerator or NothingEnum enumerator.
digitsTypeDigitsTypeOptions
NothingEnum
r/wThe digits type. Can return: DigitsTypeOptions enumerator or NothingEnum enumerator.
dropCapCharactersNothingEnum
Short Integer (0 - 150)
r/wThe number of characters to drop cap. Can return: Short Integer (0 - 150) or NothingEnum enumerator.
dropCapLinesNothingEnum
Short Integer (0 - 25)
r/wThe number of lines to drop cap. Can return: Short Integer (0 - 25) or NothingEnum enumerator.
dropcapDetailLong Integer
NothingEnum
r/wDetails 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.
endJoinNothingEnum
OutlineJoin
r/wThe stroke join type applied to the characters of the text. Can return: OutlineJoin enumerator or NothingEnum enumerator.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fillColorNothingEnum
String
Swatch
r/wThe 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.
fillTintNothingEnum
Real
r/wThe tint (as a percentage) of the fill color of the ChangeTextPreference. (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.
firstLineIndentNothingEnum
Unit
r/wThe amount to indent the first line. Can return: Unit or NothingEnum enumerator.
fontStyleNothingEnum
String
r/wThe name of the font style. Can return: String or NothingEnum enumerator.
glyphFormAlternateGlyphForms
NothingEnum
r/wThe glyph variant to substitute for standard glyphs. Can return: AlternateGlyphForms enumerator or NothingEnum enumerator.
gradientFillAngleNothingEnum
Real
r/wThe angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientFillLengthNothingEnum
Real
r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. Can return: Real or NothingEnum enumerator.
gradientFillStart2 Units
NothingEnum
r/wThe 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.
gradientStrokeAngleNothingEnum
Real
r/wThe angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientStrokeLengthNothingEnum
Real
r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. Can return: Real or NothingEnum enumerator.
gradientStrokeStart2 Units
NothingEnum
r/wThe 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.
gridAlignmentGridAlignment
NothingEnum
r/wThe alignment to the frame grid or baseline grid. Can return: GridAlignment enumerator or NothingEnum enumerator.
gridGyoudoriNothingEnum
Short Integer
r/wThe manual gyoudori setting. Can return: Short Integer or NothingEnum enumerator.
horizontalScaleNothingEnum
Real
r/wThe horizontal scaling applied to the ChangeTextPreference. Can return: Real or NothingEnum enumerator.
hyphenateAcrossColumnsBoolean
NothingEnum
r/wIf true, allows the last word in a text column to be hyphenated. Can return: Boolean or NothingEnum enumerator.
hyphenateLastWordBoolean
NothingEnum
r/wIf true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. Can return: Boolean or NothingEnum enumerator.
ignoreEdgeAlignmentBoolean
NothingEnum
r/wIf true, ignores optical edge alignment for the paragraph. Can return: Boolean or NothingEnum enumerator.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
jidoriNothingEnum
Short Integer
r/wThe number of grid squares in which to arrange the text. . Can return: Short Integer or NothingEnum enumerator.
justificationJustification
NothingEnum
r/wThe paragraph alignment. Can return: Justification enumerator or NothingEnum enumerator.
kashidasKashidasOptions
NothingEnum
r/wUse of Kashidas for justification. Can return: KashidasOptions enumerator or NothingEnum enumerator.
keepAllLinesTogetherBoolean
NothingEnum
r/wIf true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. Can return: Boolean or NothingEnum enumerator.
keepFirstLinesNothingEnum
Short Integer (1 - 50)
r/wThe minimum number of lines to keep together in a paragraph before allowing a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator.
keepLastLinesNothingEnum
Short Integer (1 - 50)
r/wThe minimum number of lines to keep together in a paragraph after a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator.
keepLinesTogetherBoolean
NothingEnum
r/wIf true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. Can return: Boolean or NothingEnum enumerator.
keepRuleAboveInFrameBoolean
NothingEnum
r/wIf 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.
keepWithNextNothingEnum
Short Integer (0 - 5)
r/wThe minimum number of lines to keep with the next paragraph. Can return: Short Integer (0 - 5) or NothingEnum enumerator.
keepWithPreviousBoolean
NothingEnum
r/wIf the first line in the paragraph should be kept with the last line of previous paragraph. Can return: Boolean or NothingEnum enumerator.
kentenAlignmentKentenAlignment
NothingEnum
r/wThe alignment of kenten characters relative to the parent characters. . Can return: KentenAlignment enumerator or NothingEnum enumerator.
kentenCharacterSetKentenCharacterSet
NothingEnum
r/wThe character set used for the custom kenten character. Note: Valid only when kenten kind is custom. . Can return: KentenCharacterSet enumerator or NothingEnum enumerator.
kentenCustomCharacterNothingEnum
String
r/wThe character used for kenten. Note: Valid only when kenten kind is custom. Can return: String or NothingEnum enumerator.
kentenFillColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch, String or NothingEnum enumerator.
kentenFontFont
NothingEnum
String
r/wThe font to use for kenten characters. Can return: Font, String or NothingEnum enumerator.
kentenFontSizeNothingEnum
Real
r/wThe size (in points) of kenten characters. Can return: Real or NothingEnum enumerator.
kentenFontStyleNothingEnum
String
r/wThe font style of kenten characters. Can return: String or NothingEnum enumerator.
kentenKindKentenCharacter
NothingEnum
r/wThe style of kenten characters. Can return: KentenCharacter enumerator or NothingEnum enumerator.
kentenOverprintFillAdornmentOverprint
NothingEnum
r/wThe method of overprinting the kenten fill. Can return: AdornmentOverprint enumerator or NothingEnum enumerator.
kentenOverprintStrokeAdornmentOverprint
NothingEnum
r/wThe method of overprinting the kenten stroke. Can return: AdornmentOverprint enumerator or NothingEnum enumerator.
kentenPlacementNothingEnum
Real
r/wThe distance between kenten characters and their parent characters. Can return: Real or NothingEnum enumerator.
kentenPositionNothingEnum
RubyKentenPosition
r/wThe kenten position relative to the parent character. Can return: RubyKentenPosition enumerator or NothingEnum enumerator.
kentenStrokeColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch, String or NothingEnum enumerator.
kentenStrokeTintNothingEnum
Real
r/wThe stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
kentenTintNothingEnum
Real
r/wThe fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
kentenWeightNothingEnum
Real
r/wThe stroke weight (in points) of kenten characters. Can return: Real or NothingEnum enumerator.
kentenXScaleNothingEnum
Real
r/wThe horizontal size of kenten characters as a percent of the original size. Can return: Real or NothingEnum enumerator.
kentenYScaleNothingEnum
Real
r/wThe vertical size of kenten charachers as a percent of the original size. . Can return: Real or NothingEnum enumerator.
kerningMethodNothingEnum
String
r/wThe type of pair kerning. Can return: String or NothingEnum enumerator.
kerningValueNothingEnum
Real
r/wThe amount of space to add or remove between characters, specified in thousands of an em. . Can return: Real or NothingEnum enumerator.
keyboardDirectionCharacterDirectionOptions
NothingEnum
r/wThe keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
kinsokuHangTypeKinsokuHangTypes
NothingEnum
r/wThe type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect. Can return: KinsokuHangTypes enumerator or NothingEnum enumerator.
kinsokuSetKinsokuSet
KinsokuTable
NothingEnum
String
r/wThe kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator, String or NothingEnum enumerator.
kinsokuTypeKinsokuType
NothingEnum
r/wThe 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.
lastLineIndentNothingEnum
Unit
r/wThe amount to indent the last line in the paragraph. Can return: Unit or NothingEnum enumerator.
leadingLeading
NothingEnum
Unit
r/wThe leading applied to the text. Can return: Unit, Leading enumerator or NothingEnum enumerator.
leadingAkiNothingEnum
Real
r/wThe amount of space before each character. Can return: Real or NothingEnum enumerator.
leadingModelLeadingModel
NothingEnum
r/wThe point from which leading is measured from line to line. Can return: LeadingModel enumerator or NothingEnum enumerator.
leftIndentNothingEnum
Unit
r/wThe width of the left indent. Can return: Unit or NothingEnum enumerator.
ligaturesBoolean
NothingEnum
r/wIf true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator.
markupTagNothingEnum
String
XMLTag
r/wThe XML tag applied to the element. Can return: String or NothingEnum enumerator. Can also accept: XMLTag.
miterLimitNothingEnum
Real (0 - 1000)
r/wThe 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)
mojikumiMojikumiTable
MojikumiTableDefaults
NothingEnum
String
r/wThe mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String, MojikumiTableDefaults enumerator or NothingEnum enumerator.
noBreakBoolean
NothingEnum
r/wIf true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator.
numberingApplyRestartPolicyBoolean
NothingEnum
r/wIf true, apply the numbering restart policy. Can return: Boolean or NothingEnum enumerator.
numberingCharacterStyleCharacterStyle
NothingEnum
String
r/wThe character style to be used for the number string. Can return: CharacterStyle, String or NothingEnum enumerator.
numberingContinueBoolean
NothingEnum
r/wContinue the numbering at this level. Can return: Boolean or NothingEnum enumerator.
numberingExpressionNothingEnum
String
r/wThe number string expression for numbering. Can return: String or NothingEnum enumerator.
numberingFormatNothingEnum
NumberingStyle
String
r/wNumbering format options. Can return: NumberingStyle enumerator, String or NothingEnum enumerator.
numberingLevelLong Integer
NothingEnum
r/wThe level of the paragraph. Can return: Long Integer or NothingEnum enumerator.
numberingRestartPoliciesNothingEnum
NumberingRestartPolicy
readonlyNumbering restart policies. Can return: NumberingRestartPolicy or NothingEnum enumerator.
numberingStartAtLong Integer
NothingEnum
r/wDetermines starting number in a numbered list. Can return: Long Integer or NothingEnum enumerator.
otfContextualAlternateBoolean
NothingEnum
r/wIf true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfDiscretionaryLigatureBoolean
NothingEnum
r/wIf true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfFigureStyleNothingEnum
OTFFigureStyle
r/wThe figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator.
otfFractionBoolean
NothingEnum
r/wIf true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfHVKanaBoolean
NothingEnum
r/wIf true, switches hiragana fonts, which have different glyphs for horizontal and vertical. . Can return: Boolean or NothingEnum enumerator.
otfHistoricalBoolean
NothingEnum
r/wIf true, use historical forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfJustificationAlternateBoolean
NothingEnum
r/wIf true, use alternate justification forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfLocaleBoolean
NothingEnum
r/wIf true, uses localized forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfMarkBoolean
NothingEnum
r/wIf true, uses mark positioning in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOrdinalBoolean
NothingEnum
r/wIf true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOverlapSwashBoolean
NothingEnum
r/wIf true, use overlapping swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfProportionalMetricsBoolean
NothingEnum
r/wIf true, kerns according to proportional CJK metrics in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfRomanItalicsBoolean
NothingEnum
r/wIf true, applies italics to half-width alphanumerics. . Can return: Boolean or NothingEnum enumerator.
otfSlashedZeroBoolean
NothingEnum
r/wIf true, use a slashed zeroes in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStretchedAlternateBoolean
NothingEnum
r/wIf true, use stretched alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticAlternateBoolean
NothingEnum
r/wIf true, use stylistic alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticSetsLong Integer
NothingEnum
r/wThe stylistic sets to use in OpenType fonts. Can return: Long Integer or NothingEnum enumerator.
otfSwashBoolean
NothingEnum
r/wIf true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfTitlingBoolean
NothingEnum
r/wIf true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
overprintFillBoolean
NothingEnum
r/wIf true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
overprintStrokeBoolean
NothingEnum
r/wIf true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
paragraphDirectionNothingEnum
ParagraphDirectionOptions
r/wParagraph direction. Can return: ParagraphDirectionOptions enumerator or NothingEnum enumerator.
paragraphGyoudoriBoolean
NothingEnum
r/wIf 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.
paragraphJustificationNothingEnum
ParagraphJustificationOptions
r/wParagraph justification. Can return: ParagraphJustificationOptions enumerator or NothingEnum enumerator.
paragraphKashidaWidthNothingEnum
Real
r/wParagraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long. Can return: Real or NothingEnum enumerator.
parentApplication readonlyThe parent of the ChangeTextPreference (a Application).
pointSizeNothingEnum
Unit
r/wThe text size. Can return: Unit or NothingEnum enumerator.
positionNothingEnum
Position
r/wThe text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator.
positionalFormNothingEnum
PositionalForms
r/wThe OpenType positional form. Can return: PositionalForms enumerator or NothingEnum enumerator.
preferencesPreferences readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
rensuujiBoolean
NothingEnum
r/wIf true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers. Can return: Boolean or NothingEnum enumerator.
rightIndentNothingEnum
Unit
r/wThe width of the right indent. Can return: Unit or NothingEnum enumerator.
rotateSingleByteCharactersBoolean
NothingEnum
r/wIf true, rotates Roman characters in vertical text. Can return: Boolean or NothingEnum enumerator.
rubyAlignmentNothingEnum
RubyAlignments
r/wThe ruby alignment. Can return: RubyAlignments enumerator or NothingEnum enumerator.
rubyAutoAlignBoolean
NothingEnum
r/wIf true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator.
rubyAutoScalingBoolean
NothingEnum
r/wIf 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.
rubyAutoTcyAutoScaleBoolean
NothingEnum
r/wIf true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em. Can return: Boolean or NothingEnum enumerator.
rubyAutoTcyDigitsNothingEnum
Short Integer
r/wThe number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can return: Short Integer or NothingEnum enumerator.
rubyAutoTcyIncludeRomanBoolean
NothingEnum
r/wIf true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can return: Boolean or NothingEnum enumerator.
rubyFillNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch, String or NothingEnum enumerator.
rubyFontFont
NothingEnum
String
r/wThe font applied to ruby characters. Can return: Font, String or NothingEnum enumerator.
rubyFontSizeNothingEnum
Real
r/wThe size (in points) of ruby characters. Can return: Real or NothingEnum enumerator.
rubyFontStyleNothingEnum
String
r/wThe font style of ruby characters. Can return: String or NothingEnum enumerator.
rubyOpenTypeProBoolean
NothingEnum
r/wIf true, uses OpenType Pro fonts for ruby. Can return: Boolean or NothingEnum enumerator.
rubyOverhangBoolean
NothingEnum
r/wIf 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.
rubyOverprintFillAdornmentOverprint
NothingEnum
r/wThe method of overprinting the ruby fill. Can return: AdornmentOverprint enumerator or NothingEnum enumerator.
rubyOverprintStrokeAdornmentOverprint
NothingEnum
r/wThe method of overprinting the ruby stroke. Can return: AdornmentOverprint enumerator or NothingEnum enumerator.
rubyParentOverhangAmountNothingEnum
RubyOverhang
r/wThe amount by which ruby characters can overhang the parent text. Can return: RubyOverhang enumerator or NothingEnum enumerator.
rubyParentScalingPercentNothingEnum
Real
r/wThe amount (as a percentage) to scale the parent text size to determine the ruby text size. Can return: Real or NothingEnum enumerator.
rubyParentSpacingNothingEnum
RubyParentSpacing
r/wThe ruby spacing relative to the parent text. . Can return: RubyParentSpacing enumerator or NothingEnum enumerator.
rubyPositionNothingEnum
RubyKentenPosition
r/wThe position of ruby characters relative to the parent text. Can return: RubyKentenPosition enumerator or NothingEnum enumerator.
rubyStrokeNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch, String or NothingEnum enumerator.
rubyStrokeTintNothingEnum
Real
r/wThe stroke tint (as a percentage) of ruby characters. Can return: Real or NothingEnum enumerator.
rubyTintNothingEnum
Real
r/wThe tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
rubyTypeNothingEnum
RubyTypes
r/wThe ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator.
rubyWeightNothingEnum
Real
r/wThe stroke weight (in points) of ruby characters. Can return: Real or NothingEnum enumerator.
rubyXOffsetNothingEnum
Real
r/wThe amount of horizontal space between ruby and parent characters. Can return: Real or NothingEnum enumerator.
rubyXScaleNothingEnum
Real
r/wThe horizontal size of ruby characters, specified as a percent of the original size. Can return: Real or NothingEnum enumerator.
rubyYOffsetNothingEnum
Real
r/wThe amount of vertical space between ruby and parent characters. Can return: Real or NothingEnum enumerator.
rubyYScaleNothingEnum
Real
r/wThe vertical size of ruby characters, specified as a percent of the original size. Can return: Real or NothingEnum enumerator.
scaleAffectsLineHeightBoolean
NothingEnum
r/wIf true, the line changes size when characters are scaled. . Can return: Boolean or NothingEnum enumerator.
shataiAdjustRotationBoolean
NothingEnum
r/wIf true, applies shatai rotation. Can return: Boolean or NothingEnum enumerator.
shataiAdjustTsumeBoolean
NothingEnum
r/wIf true, adjusts shatai tsume. Can return: Boolean or NothingEnum enumerator.
shataiDegreeAngleNothingEnum
Real
r/wThe shatai lens angle (in degrees). Can return: Real or NothingEnum enumerator.
shataiMagnificationNothingEnum
Real
r/wThe amount (as a percentage) of shatai obliquing to apply. Can return: Real or NothingEnum enumerator.
singleWordJustificationNothingEnum
SingleWordJustification
r/wThe alignment to use for lines that contain a single word. Can return: SingleWordJustification enumerator or NothingEnum enumerator.
skewNothingEnum
Real
r/wThe skew angle of the ChangeTextPreference. Can return: Real or NothingEnum enumerator.
spaceAfterNothingEnum
Unit
r/wThe height of the paragraph space below. Can return: Unit or NothingEnum enumerator.
spaceBeforeNothingEnum
Unit
r/wThe height of the paragraph space above. Can return: Unit or NothingEnum enumerator.
spanColumnMinSpaceAfterNothingEnum
Unit
r/wThe minimum space after a span or a split column. Can return: Unit or NothingEnum enumerator.
spanColumnMinSpaceBeforeNothingEnum
Unit
r/wThe minimum space before a span or a split column. Can return: Unit or NothingEnum enumerator.
spanColumnTypeNothingEnum
SpanColumnTypeOptions
r/wWhether a paragraph should be a single column, span columns or split columns. Can return: SpanColumnTypeOptions enumerator or NothingEnum enumerator.
spanSplitColumnCountNothingEnum
Short Integer (1 - 40)
SpanColumnCountOptions
r/wThe number of columns a paragraph spans or the number of split columns. Can return: Short Integer (1 - 40), SpanColumnCountOptions enumerator or NothingEnum enumerator.
splitColumnInsideGutterNothingEnum
Unit
r/wThe inside gutter if the paragraph splits columns. Can return: Unit or NothingEnum enumerator.
splitColumnOutsideGutterNothingEnum
Unit
r/wThe outside gutter if the paragraph splits columns. Can return: Unit or NothingEnum enumerator.
startParagraphNothingEnum
StartParagraph
r/wThe location at which to start the paragraph. Can return: StartParagraph enumerator or NothingEnum enumerator.
strikeThroughColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapOverprintBoolean
NothingEnum
r/wIf 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.
strikeThroughGapTintNothingEnum
Real
r/wThe 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.
strikeThroughOffsetNothingEnum
Unit
r/wThe amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator.
strikeThroughOverprintBoolean
NothingEnum
r/wIf true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator.
strikeThroughTintNothingEnum
Real
r/wThe tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
strikeThroughTypeNothingEnum
String
StrokeStyle
r/wThe stroke type of the strikethrough stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
strikeThroughWeightNothingEnum
Unit
r/wThe stroke weight of the strikethrough stroke. Can return: Unit or NothingEnum enumerator.
strikeThruBoolean
NothingEnum
r/wIf true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator.
strokeAlignmentNothingEnum
TextStrokeAlign
r/wThe stroke alignment applied to the text. Can return: TextStrokeAlign enumerator or NothingEnum enumerator.
strokeColorNothingEnum
String
Swatch
r/wThe 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.
strokeTintNothingEnum
Real
r/wThe tint (as a percentage) of the stroke color of the ChangeTextPreference. (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.
strokeWeightNothingEnum
Unit
r/wThe stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator.
tatechuyokoBoolean
NothingEnum
r/wIf true, makes the character horizontal in vertical text. Can return: Boolean or NothingEnum enumerator.
tatechuyokoXOffsetNothingEnum
Real
r/wThe horizontal offset for horizontal characters in vertical text. Can return: Real or NothingEnum enumerator.
tatechuyokoYOffsetNothingEnum
Real
r/wThe vertical offset for horizontal characters in vertical text. Can return: Real or NothingEnum enumerator.
trackingNothingEnum
Real
r/wThe amount by which to loosen or tighten a block of text, specified in thousands of an em. Can return: Real or NothingEnum enumerator.
trailingAkiNothingEnum
Real
r/wThe amount of space after each character. Can return: Real or NothingEnum enumerator.
treatIdeographicSpaceAsSpaceBoolean
NothingEnum
r/wIf true, ideographic spaces will not wrap to the next line like text characters. Can return: Boolean or NothingEnum enumerator.
tsumeNothingEnum
Real
r/wThe amount of horizontal character compression. Can return: Real or NothingEnum enumerator.
underlineBoolean
NothingEnum
r/wIf true, underlines the text. Can return: Boolean or NothingEnum enumerator.
underlineColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator.
underlineGapColorNothingEnum
String
Swatch
r/wThe 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.
underlineGapOverprintBoolean
NothingEnum
r/wIf true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator.
underlineGapTintNothingEnum
Real
r/wThe 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.
underlineOffsetNothingEnum
Unit
r/wThe amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator.
underlineOverprintBoolean
NothingEnum
r/wIf true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator.
underlineTintNothingEnum
Real
r/wThe underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
underlineTypeNothingEnum
String
StrokeStyle
r/wThe stroke type of the underline stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
underlineWeightNothingEnum
Unit
r/wThe stroke weight of the underline stroke. Can return: Unit or NothingEnum enumerator.
verticalScaleNothingEnum
Real
r/wThe vertical scaling applied to the ChangeTextPreference. Can return: Real or NothingEnum enumerator.
warichuBoolean
NothingEnum
r/wIf true, turns on warichu. Can return: Boolean or NothingEnum enumerator.
warichuAlignmentNothingEnum
WarichuAlignment
r/wThe warichu alignment. Can return: WarichuAlignment enumerator or NothingEnum enumerator.
warichuCharsAfterBreakNothingEnum
Short Integer
r/wThe minimum number of characters allowed after a line break. . Can return: Short Integer or NothingEnum enumerator.
warichuCharsBeforeBreakNothingEnum
Short Integer
r/wThe minimum number of characters allowed before a line break. Can return: Short Integer or NothingEnum enumerator.
warichuLineSpacingNothingEnum
Real
r/wThe gap between lines of warichu characters. Can return: Real or NothingEnum enumerator.
warichuLinesNothingEnum
Short Integer
r/wThe number of lines of warichu within a single normal line. Can return: Short Integer or NothingEnum enumerator.
warichuSizeNothingEnum
Real
r/wThe amount (as a percentage) to scale parent text size to determine warichu size. Can return: Real or NothingEnum enumerator.
xOffsetDiacriticNothingEnum
Real
r/wThe x (horizontal) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.
yOffsetDiacriticNothingEnum
Real
r/wThe 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.

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 ChangeTextPreference 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 ChangeTextPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.changeTextPreferences

Return

Array of ChangeTextPreference ChangeTextPreference.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index