CharacterStyle

A character style.

Go to Property Listing | Method Listing

Methods:

addEventListener, createThumbnailWithProperties, duplicate, extractLabel, getElements, insertLabel, isNthDesignAxisHidden, move, remove, removeEventListener, setNthDesignAxis, toSource, toSpecifier

Property Listing

Property	Type	Access	Description
appliedFont	Font String NothingEnum.NOTHING	read/write	The font applied to the CharacterStyle, specified as either a font object or the name of font family. Can return: Font, String or NothingEnum enumerator.
appliedLanguage	Language LanguageWithVendors NothingEnumCanalsoaccept:String	read/write	The language of the text. Can return: LanguageWithVendors, Language or NothingEnum enumerator. Can also accept: String.
basedOn	CharacterStyle String	read/write	The style that this style is based on. Can return: CharacterStyle or String.
baselineShift	Unit NothingEnum.NOTHING	read/write	The baseline shift applied to the text. Can return: Unit or NothingEnum enumerator.
capitalization	Capitalization Capitalization.ALL_CAPS Capitalization.CAP_TO_SMALL_CAP Capitalization.LOWER_CASE Capitalization.NORMAL Capitalization.SMALL_CAPS NothingEnum.NOTHING	read/write	The capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator.
characterAlignment	CharacterAlignment CharacterAlignment.ALIGN_BASELINE CharacterAlignment.ALIGN_EM_BOTTOM CharacterAlignment.ALIGN_EM_CENTER CharacterAlignment.ALIGN_EM_TOP CharacterAlignment.ALIGN_ICF_BOTTOM CharacterAlignment.ALIGN_ICF_TOP NothingEnum.NOTHING	read/write	The alignment of small characters to the largest character in the line. Can return: CharacterAlignment enumerator or NothingEnum enumerator.
characterDirection	CharacterDirectionOptions CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION NothingEnum.NOTHING	read/write	The direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
characterRotation	Real NothingEnum.NOTHING	read/write	The rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise. Can return: Real or NothingEnum enumerator.
cjkGridTracking	Boolean NothingEnum.NOTHING	read/write	If true, uses grid tracking to track non-Roman characters in CJK grids. Can return: Boolean or NothingEnum enumerator.
designAxes	Array of Reals NothingEnum.NOTHING	read/write	Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator.
diacriticPosition	DiacriticPositionOptions DiacriticPositionOptions.DEFAULT_POSITION DiacriticPositionOptions.LOOSE_POSITION DiacriticPositionOptions.MEDIUM_POSITION DiacriticPositionOptions.OPENTYPE_POSITION DiacriticPositionOptions.OPENTYPE_POSITION_FROM_BASELINE DiacriticPositionOptions.TIGHT_POSITION NothingEnum.NOTHING	read/write	Position of diacriticical characters. Can return: DiacriticPositionOptions enumerator or NothingEnum enumerator.
digitsType	DigitsTypeOptions DigitsTypeOptions.ARABIC_DIGITS DigitsTypeOptions.BENGALI_DIGITS DigitsTypeOptions.BURMESE_DIGITS DigitsTypeOptions.DEFAULT_DIGITS DigitsTypeOptions.DEVANAGARI_DIGITS DigitsTypeOptions.FARSI_DIGITS DigitsTypeOptions.FULL_FARSI_DIGITS DigitsTypeOptions.GUJARATI_DIGITS DigitsTypeOptions.GURMUKHI_DIGITS DigitsTypeOptions.HINDI_DIGITS DigitsTypeOptions.KANNADA_DIGITS DigitsTypeOptions.KHMER_DIGITS DigitsTypeOptions.LAO_DIGITS DigitsTypeOptions.MALAYALAM_DIGITS DigitsTypeOptions.NATIVE_DIGITS DigitsTypeOptions.ORIYA_DIGITS DigitsTypeOptions.TAMIL_DIGITS DigitsTypeOptions.TELUGU_DIGITS DigitsTypeOptions.THAI_DIGITS DigitsTypeOptions.TIBETAN_DIGITS NothingEnum.NOTHING	read/write	The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum enumerator.
emitCss	Boolean NothingEnum.NOTHING	read/write	Emit CSS. Can return: Boolean or NothingEnum enumerator.
endJoin	OutlineJoin OutlineJoin.BEVEL_END_JOIN OutlineJoin.MITER_END_JOIN OutlineJoin.ROUND_END_JOIN NothingEnum.NOTHING	read/write	The stroke join type applied to the characters of the text. Can return: OutlineJoin enumerator or NothingEnum enumerator.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
fillColor	Swatch NothingEnumCanalsoaccept:String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the CharacterStyle. . Can return: Swatch or NothingEnum enumerator. Can also accept: String.
fillTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the fill color of the CharacterStyle. (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.
fontStyle	String NothingEnum.NOTHING	read/write	The name of the font style. Can return: String or NothingEnum enumerator.
glyphForm	AlternateGlyphForms AlternateGlyphForms.EXPERT_FORM AlternateGlyphForms.FULL_WIDTH_FORM AlternateGlyphForms.JIS04_FORM AlternateGlyphForms.JIS78_FORM AlternateGlyphForms.JIS83_FORM AlternateGlyphForms.JIS90_FORM AlternateGlyphForms.MONOSPACED_HALF_WIDTH_FORM AlternateGlyphForms.NLC_FORM AlternateGlyphForms.NONE AlternateGlyphForms.PROPORTIONAL_WIDTH_FORM AlternateGlyphForms.QUARTER_WIDTH_FORM AlternateGlyphForms.THIRD_WIDTH_FORM AlternateGlyphForms.TRADITIONAL_FORM NothingEnum.NOTHING	read/write	The glyph variant to substitute for standard glyphs. Can return: AlternateGlyphForms enumerator or NothingEnum enumerator.
gradientFillAngle	Real NothingEnum.NOTHING	read/write	The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientFillLength	Real NothingEnum.NOTHING	read/write	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	Array of 2 Units NothingEnum.NOTHING	read/write	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	Real NothingEnum.NOTHING	read/write	The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientStrokeLength	Real NothingEnum.NOTHING	read/write	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	Array of 2 Units NothingEnum.NOTHING	read/write	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.
horizontalScale	Real NothingEnum.NOTHING	read/write	The horizontal scaling applied to the CharacterStyle. Can return: Real or NothingEnum enumerator.
id	Number	readonly	The unique ID of the CharacterStyle.
imported	Boolean NothingEnum.NOTHING	readonly	If true, the style was imported from another document. Can return: Boolean or NothingEnum enumerator.
includeClass	Boolean NothingEnum.NOTHING	read/write	If true, class attribute will be generated for the style. Can return: Boolean or NothingEnum enumerator.
index	Number	readonly	The index of the CharacterStyle within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
jidori	ShortInteger NothingEnum.NOTHING	read/write	The number of grid squares in which to arrange the text. . Can return: Short Integer or NothingEnum enumerator.
kashidas	KashidasOptions KashidasOptions.DEFAULT_KASHIDAS KashidasOptions.KASHIDAS_OFF NothingEnum.NOTHING	read/write	Use of Kashidas for justification. Can return: KashidasOptions enumerator or NothingEnum enumerator.
kentenAlignment	KentenAlignment KentenAlignment.ALIGN_KENTEN_CENTER KentenAlignment.ALIGN_KENTEN_LEFT NothingEnum.NOTHING	read/write	The alignment of kenten characters relative to the parent characters. . Can return: KentenAlignment enumerator or NothingEnum enumerator.
kentenCharacterSet	KentenCharacterSet KentenCharacterSet.CHARACTER_INPUT KentenCharacterSet.JIS KentenCharacterSet.KUTEN KentenCharacterSet.SHIFT_JIS KentenCharacterSet.UNICODE NothingEnum.NOTHING	read/write	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	String NothingEnum.NOTHING	read/write	The character used for kenten. Note: Valid only when kenten kind is custom. Can return: String or NothingEnum enumerator.
kentenFillColor	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch, String or NothingEnum enumerator.
kentenFont	Font String NothingEnum.NOTHING	read/write	The font to use for kenten characters. Can return: Font, String or NothingEnum enumerator.
kentenFontSize	Real NothingEnum.NOTHING	read/write	The size (in points) of kenten characters. Can return: Real or NothingEnum enumerator.
kentenFontStyle	String NothingEnum.NOTHING	read/write	The font style of kenten characters. Can return: String or NothingEnum enumerator.
kentenKind	KentenCharacter KentenCharacter.CUSTOM KentenCharacter.KENTEN_BLACK_CIRCLE KentenCharacter.KENTEN_BLACK_TRIANGLE KentenCharacter.KENTEN_BULLSEYE KentenCharacter.KENTEN_FISHEYE KentenCharacter.KENTEN_SESAME_DOT KentenCharacter.KENTEN_SMALL_BLACK_CIRCLE KentenCharacter.KENTEN_SMALL_WHITE_CIRCLE KentenCharacter.KENTEN_WHITE_CIRCLE KentenCharacter.KENTEN_WHITE_SESAME_DOT KentenCharacter.KENTEN_WHITE_TRIANGLE KentenCharacter.NONE NothingEnum.NOTHING	read/write	The style of kenten characters. Can return: KentenCharacter enumerator or NothingEnum enumerator.
kentenOverprintFill	AdornmentOverprint AdornmentOverprint.AUTO AdornmentOverprint.OVERPRINT_OFF AdornmentOverprint.OVERPRINT_ON NothingEnum.NOTHING	read/write	The method of overprinting the kenten fill. Can return: AdornmentOverprint enumerator or NothingEnum enumerator.
kentenOverprintStroke	AdornmentOverprint AdornmentOverprint.AUTO AdornmentOverprint.OVERPRINT_OFF AdornmentOverprint.OVERPRINT_ON NothingEnum.NOTHING	read/write	The method of overprinting the kenten stroke. Can return: AdornmentOverprint enumerator or NothingEnum enumerator.
kentenPlacement	Real NothingEnum.NOTHING	read/write	The distance between kenten characters and their parent characters. Can return: Real or NothingEnum enumerator.
kentenPosition	RubyKentenPosition RubyKentenPosition.ABOVE_RIGHT RubyKentenPosition.BELOW_LEFT NothingEnum.NOTHING	read/write	The kenten position relative to the parent character. Can return: RubyKentenPosition enumerator or NothingEnum enumerator.
kentenStrokeColor	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch, String or NothingEnum enumerator.
kentenStrokeTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
kentenTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
kentenWeight	Real NothingEnum.NOTHING	read/write	The stroke weight (in points) of kenten characters. Can return: Real or NothingEnum enumerator.
kentenXScale	Real NothingEnum.NOTHING	read/write	The horizontal size of kenten characters as a percent of the original size. Can return: Real or NothingEnum enumerator.
kentenYScale	Real NothingEnum.NOTHING	read/write	The vertical size of kenten charachers as a percent of the original size. . Can return: Real or NothingEnum enumerator.
kerningMethod	String NothingEnum.NOTHING	read/write	The type of pair kerning. Can return: String or NothingEnum enumerator.
keyboardDirection	CharacterDirectionOptions CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION NothingEnum.NOTHING	read/write	The keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
label	String	read/write	A property that can be set to any string.
leading	Leading Leading.AUTO Unit NothingEnum.NOTHING	read/write	The leading applied to the text. Can return: Unit, Leading enumerator or NothingEnum enumerator.
leadingAki	Real NothingEnum.NOTHING	read/write	The amount of space before each character. Can return: Real or NothingEnum enumerator.
ligatures	Boolean NothingEnum.NOTHING	read/write	If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator.
miterLimit	Real(0-1000) NothingEnum.NOTHING	read/write	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.
name	String	read/write	The name of the style.
noBreak	Boolean NothingEnum.NOTHING	read/write	If true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator.
otfContextualAlternate	Boolean NothingEnum.NOTHING	read/write	If true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfDiscretionaryLigature	Boolean NothingEnum.NOTHING	read/write	If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfFigureStyle	OTFFigureStyle OTFFigureStyle.DEFAULT_VALUE OTFFigureStyle.PROPORTIONAL_LINING OTFFigureStyle.PROPORTIONAL_OLDSTYLE OTFFigureStyle.TABULAR_LINING OTFFigureStyle.TABULAR_OLDSTYLE NothingEnum.NOTHING	read/write	The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator.
otfFraction	Boolean NothingEnum.NOTHING	read/write	If true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfHVKana	Boolean NothingEnum.NOTHING	read/write	If true, switches hiragana fonts, which have different glyphs for horizontal and vertical. . Can return: Boolean or NothingEnum enumerator.
otfHistorical	Boolean NothingEnum.NOTHING	read/write	If true, use historical forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfJustificationAlternate	Boolean NothingEnum.NOTHING	read/write	If true, use alternate justification forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfLocale	Boolean NothingEnum.NOTHING	read/write	If true, uses localized forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfMark	Boolean NothingEnum.NOTHING	read/write	If true, uses mark positioning in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOrdinal	Boolean NothingEnum.NOTHING	read/write	If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOverlapSwash	Boolean NothingEnum.NOTHING	read/write	If true, use overlapping swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfProportionalMetrics	Boolean NothingEnum.NOTHING	read/write	If true, kerns according to proportional CJK metrics in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfRomanItalics	Boolean NothingEnum.NOTHING	read/write	If true, applies italics to half-width alphanumerics. . Can return: Boolean or NothingEnum enumerator.
otfSlashedZero	Boolean NothingEnum.NOTHING	read/write	If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStretchedAlternate	Boolean NothingEnum.NOTHING	read/write	If true, use stretched alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticAlternate	Boolean NothingEnum.NOTHING	read/write	If true, use stylistic alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticSets	LongInteger NothingEnum.NOTHING	read/write	The stylistic sets to use in OpenType fonts. Can return: Long Integer or NothingEnum enumerator.
otfSwash	Boolean NothingEnum.NOTHING	read/write	If true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfTitling	Boolean NothingEnum.NOTHING	read/write	If true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
overprintFill	Boolean NothingEnum.NOTHING	read/write	If true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
overprintStroke	Boolean NothingEnum.NOTHING	read/write	If true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
parent	Application CharacterStyleGroup Document	readonly	The parent of the CharacterStyle (a Document, Application or CharacterStyleGroup).
pointSize	Unit NothingEnum.NOTHING	read/write	The text size. Can return: Unit or NothingEnum enumerator.
position	Position Position.NORMAL Position.OT_DENOMINATOR Position.OT_NUMERATOR Position.OT_SUBSCRIPT Position.OT_SUPERSCRIPT Position.SUBSCRIPT Position.SUPERSCRIPT NothingEnum.NOTHING	read/write	The text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator.
positionalForm	PositionalForms PositionalForms.CALCULATE PositionalForms.FINAL PositionalForms.INITIAL PositionalForms.ISOLATED PositionalForms.MEDIAL PositionalForms.NONE NothingEnum.NOTHING	read/write	The OpenType positional form. Can return: PositionalForms enumerator or NothingEnum enumerator.
previewColor	Array of 3 Reals (0 - 255) NothingEnum.NOTHING UIColors	read/write	The color to use for preview, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum enumerator.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rubyAlignment	RubyAlignments RubyAlignments.RUBY_1_AKI RubyAlignments.RUBY_CENTER RubyAlignments.RUBY_EQUAL_AKI RubyAlignments.RUBY_FULL_JUSTIFY RubyAlignments.RUBY_JIS RubyAlignments.RUBY_LEFT RubyAlignments.RUBY_RIGHT NothingEnum.NOTHING	read/write	The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum enumerator.
rubyAutoAlign	Boolean NothingEnum.NOTHING	read/write	If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator.
rubyAutoScaling	Boolean NothingEnum.NOTHING	read/write	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.NOTHING	read/write	If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em. Can return: Boolean or NothingEnum enumerator.
rubyAutoTcyDigits	ShortInteger NothingEnum.NOTHING	read/write	The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can return: Short Integer or NothingEnum enumerator.
rubyAutoTcyIncludeRoman	Boolean NothingEnum.NOTHING	read/write	If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can return: Boolean or NothingEnum enumerator.
rubyFill	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch, String or NothingEnum enumerator.
rubyFont	Font String NothingEnum.NOTHING	read/write	The font applied to ruby characters. Can return: Font, String or NothingEnum enumerator.
rubyFontSize	Real NothingEnum.NOTHING	read/write	The size (in points) of ruby characters. Can return: Real or NothingEnum enumerator.
rubyFontStyle	String NothingEnum.NOTHING	read/write	The font style of ruby characters. Can return: String or NothingEnum enumerator.
rubyOpenTypePro	Boolean NothingEnum.NOTHING	read/write	If true, uses OpenType Pro fonts for ruby. Can return: Boolean or NothingEnum enumerator.
rubyOverhang	Boolean NothingEnum.NOTHING	read/write	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 AdornmentOverprint.AUTO AdornmentOverprint.OVERPRINT_OFF AdornmentOverprint.OVERPRINT_ON NothingEnum.NOTHING	read/write	The method of overprinting the ruby fill. Can return: AdornmentOverprint enumerator or NothingEnum enumerator.
rubyOverprintStroke	AdornmentOverprint AdornmentOverprint.AUTO AdornmentOverprint.OVERPRINT_OFF AdornmentOverprint.OVERPRINT_ON NothingEnum.NOTHING	read/write	The method of overprinting the ruby stroke. Can return: AdornmentOverprint enumerator or NothingEnum enumerator.
rubyParentOverhangAmount	RubyOverhang RubyOverhang.NONE RubyOverhang.RUBY_OVERHANG_HALF_CHAR RubyOverhang.RUBY_OVERHANG_HALF_RUBY RubyOverhang.RUBY_OVERHANG_NO_LIMIT RubyOverhang.RUBY_OVERHANG_ONE_CHAR RubyOverhang.RUBY_OVERHANG_ONE_RUBY NothingEnum.NOTHING	read/write	The amount by which ruby characters can overhang the parent text. Can return: RubyOverhang enumerator or NothingEnum enumerator.
rubyParentScalingPercent	Real NothingEnum.NOTHING	read/write	The amount (as a percentage) to scale the parent text size to determine the ruby text size. Can return: Real or NothingEnum enumerator.
rubyParentSpacing	RubyParentSpacing RubyParentSpacing.RUBY_PARENT_121_AKI RubyParentSpacing.RUBY_PARENT_BOTH_SIDES RubyParentSpacing.RUBY_PARENT_EQUAL_AKI RubyParentSpacing.RUBY_PARENT_FULL_JUSTIFY RubyParentSpacing.RUBY_PARENT_NO_ADJUSTMENT NothingEnum.NOTHING	read/write	The ruby spacing relative to the parent text. . Can return: RubyParentSpacing enumerator or NothingEnum enumerator.
rubyPosition	RubyKentenPosition RubyKentenPosition.ABOVE_RIGHT RubyKentenPosition.BELOW_LEFT NothingEnum.NOTHING	read/write	The position of ruby characters relative to the parent text. Can return: RubyKentenPosition enumerator or NothingEnum enumerator.
rubyStroke	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch, String or NothingEnum enumerator.
rubyStrokeTint	Real NothingEnum.NOTHING	read/write	The stroke tint (as a percentage) of ruby characters. Can return: Real or NothingEnum enumerator.
rubyTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
rubyType	RubyTypes RubyTypes.GROUP_RUBY RubyTypes.PER_CHARACTER_RUBY NothingEnum.NOTHING	read/write	The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator.
rubyWeight	Real NothingEnum.NOTHING	read/write	The stroke weight (in points) of ruby characters. Can return: Real or NothingEnum enumerator.
rubyXOffset	Real NothingEnum.NOTHING	read/write	The amount of horizontal space between ruby and parent characters. Can return: Real or NothingEnum enumerator.
rubyXScale	Real NothingEnum.NOTHING	read/write	The horizontal size of ruby characters, specified as a percent of the original size. Can return: Real or NothingEnum enumerator.
rubyYOffset	Real NothingEnum.NOTHING	read/write	The amount of vertical space between ruby and parent characters. Can return: Real or NothingEnum enumerator.
rubyYScale	Real NothingEnum.NOTHING	read/write	The vertical size of ruby characters, specified as a percent of the original size. Can return: Real or NothingEnum enumerator.
scaleAffectsLineHeight	Boolean NothingEnum.NOTHING	read/write	If true, the line changes size when characters are scaled. . Can return: Boolean or NothingEnum enumerator.
shataiAdjustRotation	Boolean NothingEnum.NOTHING	read/write	If true, applies shatai rotation. Can return: Boolean or NothingEnum enumerator.
shataiAdjustTsume	Boolean NothingEnum.NOTHING	read/write	If true, adjusts shatai tsume. Can return: Boolean or NothingEnum enumerator.
shataiDegreeAngle	Real NothingEnum.NOTHING	read/write	The shatai lens angle (in degrees). Can return: Real or NothingEnum enumerator.
shataiMagnification	Real NothingEnum.NOTHING	read/write	The amount (as a percentage) of shatai obliquing to apply. Can return: Real or NothingEnum enumerator.
skew	Real NothingEnum.NOTHING	read/write	The skew angle of the CharacterStyle. Can return: Real or NothingEnum enumerator.
splitDocument	Boolean NothingEnum.NOTHING	read/write	Split Document (EPUB only). Can return: Boolean or NothingEnum enumerator.
strikeThroughColor	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapColor	String Swatch NothingEnum.NOTHING	read/write	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.NOTHING	read/write	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	Real (range 0 - 100) NothingEnum.NOTHING	read/write	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	Unit NothingEnum.NOTHING	read/write	The amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator.
strikeThroughOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator.
strikeThroughTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
strikeThroughType	String StrokeStyle NothingEnum.NOTHING	read/write	The stroke type of the strikethrough stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
strikeThroughWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight of the strikethrough stroke. Can return: Unit or NothingEnum enumerator.
strikeThru	Boolean NothingEnum.NOTHING	read/write	If true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator.
strokeAlignment	TextStrokeAlign TextStrokeAlign.CENTER_ALIGNMENT TextStrokeAlign.OUTSIDE_ALIGNMENT NothingEnum.NOTHING	read/write	The stroke alignment applied to the text. Can return: TextStrokeAlign enumerator or NothingEnum enumerator.
strokeColor	Swatch NothingEnumCanalsoaccept:String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the CharacterStyle. Can return: Swatch or NothingEnum enumerator. Can also accept: String.
strokeTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the stroke color of the CharacterStyle. (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	Unit NothingEnum.NOTHING	read/write	The stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator.
styleExportTagMaps	StyleExportTagMaps StyleExportTagMap	readonly	A collection of style export tag maps.
styleUniqueId	String NothingEnum.NOTHING	read/write	A unique id that can be assigned to a style. This can be used to differentiate between the styles. Internal use only. Can return: String or NothingEnum enumerator.
tatechuyoko	Boolean NothingEnum.NOTHING	read/write	If true, makes the character horizontal in vertical text. Can return: Boolean or NothingEnum enumerator.
tatechuyokoXOffset	Real NothingEnum.NOTHING	read/write	The horizontal offset for horizontal characters in vertical text. Can return: Real or NothingEnum enumerator.
tatechuyokoYOffset	Real NothingEnum.NOTHING	read/write	The vertical offset for horizontal characters in vertical text. Can return: Real or NothingEnum enumerator.
tracking	Real NothingEnum.NOTHING	read/write	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	Real NothingEnum.NOTHING	read/write	The amount of space after each character. Can return: Real or NothingEnum enumerator.
tsume	Real NothingEnum.NOTHING	read/write	The amount of horizontal character compression. Can return: Real or NothingEnum enumerator.
underline	Boolean NothingEnum.NOTHING	read/write	If true, underlines the text. Can return: Boolean or NothingEnum enumerator.
underlineColor	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator.
underlineGapColor	String Swatch NothingEnum.NOTHING	read/write	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.NOTHING	read/write	If true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator.
underlineGapTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	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	Unit NothingEnum.NOTHING	read/write	The amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator.
underlineOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator.
underlineTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
underlineType	String StrokeStyle NothingEnum.NOTHING	read/write	The stroke type of the underline stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
underlineWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight of the underline stroke. Can return: Unit or NothingEnum enumerator.
verticalScale	Real NothingEnum.NOTHING	read/write	The vertical scaling applied to the CharacterStyle. Can return: Real or NothingEnum enumerator.
warichu	Boolean NothingEnum.NOTHING	read/write	If true, turns on warichu. Can return: Boolean or NothingEnum enumerator.
warichuAlignment	WarichuAlignment WarichuAlignment.AUTO WarichuAlignment.CENTER_ALIGN WarichuAlignment.CENTER_JUSTIFIED WarichuAlignment.FULLY_JUSTIFIED WarichuAlignment.LEFT_ALIGN WarichuAlignment.LEFT_JUSTIFIED WarichuAlignment.RIGHT_ALIGN WarichuAlignment.RIGHT_JUSTIFIED NothingEnum.NOTHING	read/write	The warichu alignment. Can return: WarichuAlignment enumerator or NothingEnum enumerator.
warichuCharsAfterBreak	ShortInteger NothingEnum.NOTHING	read/write	The minimum number of characters allowed after a line break. . Can return: Short Integer or NothingEnum enumerator.
warichuCharsBeforeBreak	ShortInteger NothingEnum.NOTHING	read/write	The minimum number of characters allowed before a line break. Can return: Short Integer or NothingEnum enumerator.
warichuLineSpacing	Real NothingEnum.NOTHING	read/write	The gap between lines of warichu characters. Can return: Real or NothingEnum enumerator.
warichuLines	ShortInteger NothingEnum.NOTHING	read/write	The number of lines of warichu within a single normal line. Can return: Short Integer or NothingEnum enumerator.
warichuSize	Real NothingEnum.NOTHING	read/write	The amount (as a percentage) to scale parent text size to determine warichu size. Can return: Real or NothingEnum enumerator.
xOffsetDiacritic	Real NothingEnum.NOTHING	read/write	The x (horizontal) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.
yOffsetDiacritic	Real NothingEnum.NOTHING	read/write	The y (vertical) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.

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)

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)

Boolean createThumbnailWithProperties (previewText:String, pointSize:Number, space:ColorSpace, colorValue:Array of Number, to:File)

Create thumbnail for selected text with the given properties.

Parameter	Type	Description
previewText	String	Text to use as sample
pointSize	Number	Text font size (in points)
space	ColorSpace ColorSpace.CMYK ColorSpace.HSB ColorSpace.LAB ColorSpace.MIXEDINK ColorSpace.RGB	Color space RGB, CMYK or LAB
colorValue	Array of Number	Color values
to	File	The path to the export file.

CharacterStyle duplicate ()

Duplicates the CharacterStyle.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

CharacterStyle getElements ()

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

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

Boolean isNthDesignAxisHidden (nthAxisIndex:Number)

If true, Nth design axis of variable font is hidden.

Parameter	Type	Description
nthAxisIndex	Number	Index of design axis.

CharacterStyle move (to:LocationOptions, reference:Varies CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup Application)

Moves the style to the specified location.

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location relative to the reference object or within the containing object.
reference	CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup Application	The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional)

undefined remove (replacingWith:CharacterStyle)

Deletes the style.

Parameter	Type	Description
replacingWith	CharacterStyle	The style to apply in place of the deleted style. (Optional)

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)

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)

undefined setNthDesignAxis (nthAxisIndex:Number, nthAxisValue:Number)

Set Nth design axis of a variable font.

Parameter	Type	Description
nthAxisIndex	Number	Index of design axis.
nthAxisValue	Number	Value of nth design axis.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

CrossReferenceFormat.appliedCharacterStyle

HyperlinkTextSource.appliedCharacterStyle

CrossReferenceSource.appliedCharacterStyle

BuildingBlock.appliedCharacterStyle

Application.allCharacterStyles

Document.allCharacterStyles

CharacterStyleGroup.allCharacterStyles

Text.appliedNestedStyles

Character.appliedNestedStyles

Word.appliedNestedStyles

Line.appliedNestedStyles

TextColumn.appliedNestedStyles

Paragraph.appliedNestedStyles

TextStyleRange.appliedNestedStyles

InsertionPoint.appliedNestedStyles

Story.appliedNestedStyles

XmlStory.appliedNestedStyles

IndexOptions.crossReferenceTopicStyle

IndexOptions.crossReferenceStyle

IndexOptions.pageNumberStyle

PageReference.pageNumberStyleOverride

TOCStyleEntry.pageNumberStyle

TOCStyleEntry.separatorStyle

TextDefault.appliedCharacterStyle

MatchCharacterStylePreference.appliedCharacterStyle

NestedLineStyle.appliedCharacterStyle

NestedGrepStyle.appliedCharacterStyle

Text.appliedCharacterStyle

Character.appliedCharacterStyle

Word.appliedCharacterStyle

Line.appliedCharacterStyle

TextColumn.appliedCharacterStyle

Paragraph.appliedCharacterStyle

TextStyleRange.appliedCharacterStyle

InsertionPoint.appliedCharacterStyle

Story.appliedCharacterStyle

NestedStyle.appliedCharacterStyle

XmlStory.appliedCharacterStyle

EndnoteOption.endnoteMarkerStyle

FootnoteOption.footnoteMarkerStyle

TextDefault.dropCapStyle

Text.dropCapStyle

Character.dropCapStyle

Word.dropCapStyle

Line.dropCapStyle

TextColumn.dropCapStyle

Paragraph.dropCapStyle

TextStyleRange.dropCapStyle

InsertionPoint.dropCapStyle

Story.dropCapStyle

ParagraphStyle.dropCapStyle

XmlStory.dropCapStyle

TextDefault.numberingCharacterStyle

Text.numberingCharacterStyle

Character.numberingCharacterStyle

Word.numberingCharacterStyle

Line.numberingCharacterStyle

TextColumn.numberingCharacterStyle

Paragraph.numberingCharacterStyle

TextStyleRange.numberingCharacterStyle

InsertionPoint.numberingCharacterStyle

Story.numberingCharacterStyle

ParagraphStyle.numberingCharacterStyle

XmlStory.numberingCharacterStyle

FindTextPreference.numberingCharacterStyle

FindGrepPreference.numberingCharacterStyle

FindTransliteratePreference.numberingCharacterStyle

ChangeTextPreference.numberingCharacterStyle

ChangeGrepPreference.numberingCharacterStyle

ChangeTransliteratePreference.numberingCharacterStyle

TextDefault.bulletsCharacterStyle

Text.bulletsCharacterStyle

Character.bulletsCharacterStyle

Word.bulletsCharacterStyle

Line.bulletsCharacterStyle

TextColumn.bulletsCharacterStyle

Paragraph.bulletsCharacterStyle

TextStyleRange.bulletsCharacterStyle

InsertionPoint.bulletsCharacterStyle

Story.bulletsCharacterStyle

ParagraphStyle.bulletsCharacterStyle

XmlStory.bulletsCharacterStyle

FindTextPreference.bulletsCharacterStyle

FindGrepPreference.bulletsCharacterStyle

FindTransliteratePreference.bulletsCharacterStyle

ChangeTextPreference.bulletsCharacterStyle

ChangeGrepPreference.bulletsCharacterStyle

ChangeTransliteratePreference.bulletsCharacterStyle

Event.parent

EventListener.parent

MutationEvent.parent

StyleExportTagMap.parent

XMLImportMap.mappedStyle

XMLExportMap.mappedStyle

CharacterStyle.basedOn

CharacterStyle

Methods:

Objects:

Property Listing

Method Listing

Object of

Return