CharacterStyle

A character style.

CharacterStyle Properties

Property Type Access Description
appliedFont Font, String r/w The applied font. Either a font object or the name of font family.
appliedLanguage LanguageWithVendors, Language, String r/w The language dictionary appled to the object.
basedOn Object, String r/w The character style this character style is based on.
baselineShift Unit r/w The amount of baseline shift applied to the object.
capitalization Capitalization enumeration r/w The capitalization applied to the object.
fillColor Swatch, String r/w The fill of the object.
fillTint Real r/w The tint percentage applied to the fill of the object (-1 indicates 100%).
fontStyle String r/w The name of the applied font style.
gradientFillAngle Real r/w The angle of the gradient applied to the fill of the object.
gradientFillLength Real r/w Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the fill of the object.
gradientFillStart Array of 2 Units r/w Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the fill of the object.
gradientStrokeAngle Real r/w The angle of the gradient applied to the stroke of the object.
gradientStrokeLength Real r/w Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the stroke of the object.
gradientStrokeStart Array of 2 Units r/w Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the stroke of the object.
horizontalScale Real r/w The horizontal scaling percentage applied to the object, including the scaling applied to its containing object(s).
id Long read A unique number identifying the object.
imported Boolean read If true, this character style was imported from another document.
index Long read Index of the object within its parent object.
kerningMethod String r/w The type of kerning (Optical, Metrics or None).
label String r/w A label that can be set to any string.
leading Unit, Leading enumeration r/w The applied leading.
ligatures Boolean r/w If true, use automatic ligature replacement characters.
name String r/w The name of the object.
noBreak Boolean r/w If true, do not break the text across lines.
otfContextualAlternate Boolean r/w If true, use contextual alternate forms in OpenType fonts.
otfDiscretionaryLigature Boolean r/w If true, use discretionary ligatures in OpenType fonts.
otfFigureStyle OTFFigureStyle enumeration r/w The figure style to use in OpenType fonts.
otfFraction Boolean r/w If true, use fractions in OpenType fonts.
otfHistorical Boolean r/w If true, use historical forms in OpenType fonts.
otfOrdinal Boolean r/w If true, use ordinals in OpenType fonts.
otfSlashedZero Boolean r/w If true, use a zero with slash in OpenType fonts.
otfStylisticSets Long r/w Stylistic sets to use in OpenType fonts.
otfSwash Boolean r/w If true, use swash forms in OpenType fonts.
otfTitling Boolean r/w If true, use titling forms in OpenType fonts.
overprintFill Boolean r/w If true, the fill of the object will overprint.
overprintStroke Boolean r/w If true, the storke of the object will overprint.
parent Object read The parent of the object.
pointSize Unit r/w The point size of the text.
position Position enumeration r/w The position (e.g., superscript or subscript) of the object.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
skew Real r/w The skew angle applied to the text.
strikeThroughColor Swatch, String r/w The color of the strikethrough.
strikeThroughGapColor Swatch, String r/w The gap color of the strikethrough.
strikeThroughGapOverprint Boolean r/w If true, overprint the gap of the strikethrough.
strikeThroughGapTint Real r/w The tint percentage applied to the gap of the strikethrough (-1 represents 100%).
strikeThroughOffset Unit r/w The offset of the strikethrough from the baseline.
strikeThroughOverprint Boolean r/w If true, overprint the strikethrough.
strikeThroughTint Real r/w The tint percentage applied to stroke color of the strikethrough.
strikeThroughType StrokeStyle, String r/w The stroke style of the strikethrough.
strikeThroughWeight Unit r/w The stroke weight of the strikethrough.
strikeThru Boolean r/w If true, apply a strikethrough to the text.
strokeColor Swatch, String r/w The stroke color of the object.
strokeTint Real r/w The tint percentage applied to the stroke (-1 indicates 100%).
strokeWeight Unit r/w The stroke weight (thickness) of the stroke.
tracking Real r/w The tracking (range kerning) applied to the object.
underline Boolean r/w If true, apply an underline to the text.
underlineColor Swatch, String r/w The color of the underline.
underlineGapColor Swatch, String r/w The gap color of the underline.
underlineGapOverprint Boolean r/w If true, overprint the gap of the underline.
underlineGapTint Real r/w The tint percentage applied to the gap of the underline (-1 represents 100%).
underlineOffset Unit r/w The offset of the underline from the baseline.
underlineOverprint Boolean r/w If true, overprint the underline.
underlineTint Real r/w The tint percentage applied to the underline (-1 represents 100%).
underlineType StrokeStyle, String r/w The stroke style applied to the underline.
underlineWeight Unit r/w The stroke weight of the underline.
verticalScale Real r/w The vertical scaling percentage applied to the object, including the scaling applied to its containing object(s).

CharacterStyle Methods

Method Returns Description
extractLabel String Gets the content of the label associated with the specified key (name).
getElements Array of Objects Resolve the object specifier.
insertLabel Nothing Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
remove Nothing Delete object.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: