Class

CharacterStyle

 A character style.

QuickLinks

addEventListener, duplicate, extractLabel, getElements, insertLabel, move, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | CharacterStyleGroup | Document
CharacterStyle
Event | EventListener | MutationEvent | StyleExportTagMap

Properties

PropertyTypeAccessDescription
appliedFontFont
NothingEnum
String
r/wThe font applied to the CharacterStyle, 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 of the text. Can return: LanguageWithVendors, Language or NothingEnum enumerator. Can also accept: String.
basedOnCharacterStyle
String
r/wThe style that this style is based on. Can return: CharacterStyle or String.
baselineShiftNothingEnum
Unit
r/wThe baseline shift applied to the text. Can return: Unit or NothingEnum enumerator.
capitalizationCapitalization
NothingEnum
r/wThe capitalization scheme. Can return: Capitalization enumerator 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.
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.
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 to the fill of the CharacterStyle. . Can return: Swatch or NothingEnum enumerator. Can also accept: String.
fillTintNothingEnum
Real
r/wThe 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.
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.
horizontalScaleNothingEnum
Real
r/wThe horizontal scaling applied to the CharacterStyle. Can return: Real or NothingEnum enumerator.
idnumber readonlyThe unique ID of the CharacterStyle.
importedBoolean
NothingEnum
readonlyIf true, the style was imported from another document. Can return: Boolean or NothingEnum enumerator.
indexnumber readonlyThe index of the CharacterStyle within its containing object.
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.
kashidasKashidasOptions
NothingEnum
r/wUse of Kashidas for justification. Can return: KashidasOptions enumerator 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.
keyboardDirectionCharacterDirectionOptions
NothingEnum
r/wThe keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
labelstring r/wA property that can be set to any string.
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.
ligaturesBoolean
NothingEnum
r/wIf true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator.
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)
namestring r/wThe name of the style.
noBreakBoolean
NothingEnum
r/wIf true, keeps the text on the same line. . Can return: Boolean 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.
parentApplication
CharacterStyleGroup
Document
readonlyThe parent of the CharacterStyle (a Document, Application or CharacterStyleGroup).
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.
previewColor3 Reals (0 - 255)
NothingEnum
UIColors
r/wThe 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.
propertiesObject r/wA property that allows setting of several properties at the same time.
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.
skewNothingEnum
Real
r/wThe skew angle of the CharacterStyle. Can return: Real 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 to the stroke of the CharacterStyle. Can return: Swatch or NothingEnum enumerator. Can also accept: String.
strokeTintNothingEnum
Real
r/wThe 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.
strokeWeightNothingEnum
Unit
r/wThe stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator.
styleExportTagMapsStyleExportTagMaps readonlyA collection of style export tag maps.
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.
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 CharacterStyle. 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)

CharacterStyle duplicate ()
Duplicates the CharacterStyle.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of CharacterStyle getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

CharacterStyle move (to: LocationOptions[, reference: varies])
Moves the style to the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceApplication
CellStyle
CellStyleGroup
CharacterStyle
CharacterStyleGroup
Document
ParagraphStyle
ParagraphStyleGroup
TableStyle
TableStyleGroup
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)

void remove ([replacingWith: CharacterStyle])
Deletes the style.

ParameterTypeDescription
replacingWithCharacterStyleThe style to apply in place of the deleted style. (Optional)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.allCharacterStyles

BuildingBlock.appliedCharacterStyle

ChangeGrepPreference.appliedCharacterStyle

ChangeGrepPreference.bulletsCharacterStyle

ChangeGrepPreference.numberingCharacterStyle

ChangeTextPreference.appliedCharacterStyle

ChangeTextPreference.bulletsCharacterStyle

ChangeTextPreference.numberingCharacterStyle

ChangeTransliteratePreference.appliedCharacterStyle

ChangeTransliteratePreference.bulletsCharacterStyle

ChangeTransliteratePreference.numberingCharacterStyle

Character.appliedCharacterStyle

Character.appliedNestedStyles

Character.bulletsCharacterStyle

Character.dropCapStyle

Character.numberingCharacterStyle

CharacterStyle.basedOn

CharacterStyleGroup.allCharacterStyles

CrossReferenceFormat.appliedCharacterStyle

CrossReferenceSource.appliedCharacterStyle

Document.allCharacterStyles

FindGrepPreference.appliedCharacterStyle

FindGrepPreference.bulletsCharacterStyle

FindGrepPreference.numberingCharacterStyle

FindTextPreference.appliedCharacterStyle

FindTextPreference.bulletsCharacterStyle

FindTextPreference.numberingCharacterStyle

FindTransliteratePreference.appliedCharacterStyle

FindTransliteratePreference.bulletsCharacterStyle

FindTransliteratePreference.numberingCharacterStyle

FootnoteOption.footnoteMarkerStyle

HyperlinkTextSource.appliedCharacterStyle

IndexOptions.crossReferenceStyle

IndexOptions.crossReferenceTopicStyle

IndexOptions.pageNumberStyle

InsertionPoint.appliedCharacterStyle

InsertionPoint.appliedNestedStyles

InsertionPoint.bulletsCharacterStyle

InsertionPoint.dropCapStyle

InsertionPoint.numberingCharacterStyle

Line.appliedCharacterStyle

Line.appliedNestedStyles

Line.bulletsCharacterStyle

Line.dropCapStyle

Line.numberingCharacterStyle

MatchCharacterStylePreference.appliedCharacterStyle

NestedGrepStyle.appliedCharacterStyle

NestedLineStyle.appliedCharacterStyle

NestedStyle.appliedCharacterStyle

PageReference.pageNumberStyleOverride

Paragraph.appliedCharacterStyle

Paragraph.appliedNestedStyles

Paragraph.bulletsCharacterStyle

Paragraph.dropCapStyle

Paragraph.numberingCharacterStyle

ParagraphStyle.bulletsCharacterStyle

ParagraphStyle.dropCapStyle

ParagraphStyle.numberingCharacterStyle

Story.appliedCharacterStyle

Story.appliedNestedStyles

Story.bulletsCharacterStyle

Story.dropCapStyle

Story.numberingCharacterStyle

StyleExportTagMap.parent

TOCStyleEntry.pageNumberStyle

TOCStyleEntry.separatorStyle

Text.appliedCharacterStyle

Text.appliedNestedStyles

Text.bulletsCharacterStyle

Text.dropCapStyle

Text.numberingCharacterStyle

TextColumn.appliedCharacterStyle

TextColumn.appliedNestedStyles

TextColumn.bulletsCharacterStyle

TextColumn.dropCapStyle

TextColumn.numberingCharacterStyle

TextDefault.appliedCharacterStyle

TextDefault.bulletsCharacterStyle

TextDefault.dropCapStyle

TextDefault.numberingCharacterStyle

TextStyleRange.appliedCharacterStyle

TextStyleRange.appliedNestedStyles

TextStyleRange.bulletsCharacterStyle

TextStyleRange.dropCapStyle

TextStyleRange.numberingCharacterStyle

Word.appliedCharacterStyle

Word.appliedNestedStyles

Word.bulletsCharacterStyle

Word.dropCapStyle

Word.numberingCharacterStyle

XMLExportMap.mappedStyle

XMLImportMap.mappedStyle

XmlStory.appliedCharacterStyle

XmlStory.appliedNestedStyles

XmlStory.bulletsCharacterStyle

XmlStory.dropCapStyle

XmlStory.numberingCharacterStyle

Used in:

BuildingBlock BuildingBlocks.add (blockType: BuildingBlockTypes[, appliedCharacterStyle: CharacterStyle][, customText: string][, withProperties: Object])

void Character.applyCharacterStyle (using: CharacterStyle)

void CharacterStyle.remove ([replacingWith: CharacterStyle])

CharacterStyle CharacterStyles.nextItem (obj: CharacterStyle)

CharacterStyle CharacterStyles.previousItem (obj: CharacterStyle)

void InsertionPoint.applyCharacterStyle (using: CharacterStyle)

void Line.applyCharacterStyle (using: CharacterStyle)

PageReference PageReferences.add (source: Text[, pageReferenceType: PageReferenceType=PageReferenceType.CURRENT_PAGE][, pageReferenceLimit: varies][, pageNumberStyleOverride: CharacterStyle][, withProperties: Object])

void Paragraph.applyCharacterStyle (using: CharacterStyle)

void Text.applyCharacterStyle (using: CharacterStyle)

void TextColumn.applyCharacterStyle (using: CharacterStyle)

void TextStyleRange.applyCharacterStyle (using: CharacterStyle)

void Word.applyCharacterStyle (using: CharacterStyle)

Return

CharacterStyle CharacterStyle.duplicate ()

Array of CharacterStyle CharacterStyle.getElements ()

CharacterStyle CharacterStyle.move (to: LocationOptions[, reference: varies])

CharacterStyle CharacterStyles.[] (index: number)

CharacterStyle CharacterStyles.add ([withProperties: Object])

CharacterStyle CharacterStyles.anyItem ()

Array of CharacterStyle CharacterStyles.everyItem ()

CharacterStyle CharacterStyles.firstItem ()

CharacterStyle CharacterStyles.item (index: varies)

CharacterStyle CharacterStyles.itemByID (id: number)

CharacterStyle CharacterStyles.itemByName (name: string)

Array of CharacterStyle CharacterStyles.itemByRange (from: varies, to: varies)

CharacterStyle CharacterStyles.lastItem ()

CharacterStyle CharacterStyles.middleItem ()

CharacterStyle CharacterStyles.nextItem (obj: CharacterStyle)

CharacterStyle CharacterStyles.previousItem (obj: CharacterStyle)

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