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 (Double or String) r/w The amount of baseline shift applied to the object.
Capitalization idCapitalization enumeration r/w The capitalization applied to the object.
FillColor Swatch, String r/w The fill of the object.
FillTint Double 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 Double r/w The angle of the gradient applied to the fill of the object.
GradientFillLength Double 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 (Doubles or Strings) 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 Double r/w The angle of the gradient applied to the stroke of the object.
GradientStrokeLength Double 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 (Doubles or Strings) 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 Double 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 (Double or String), idLeading 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 idOTFFigureStyle 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 (Double or String) r/w The point size of the text.
Position idPosition enumeration r/w The position (e.g., superscript or subscript) of the object.
Skew Double 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 Double r/w The tint percentage applied to the gap of the strikethrough (-1 represents 100%).
StrikeThroughOffset Unit (Double or String) r/w The offset of the strikethrough from the baseline.
StrikeThroughOverprint Boolean r/w If true, overprint the strikethrough.
StrikeThroughTint Double 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 (Double or String) 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 Double r/w The tint percentage applied to the stroke (-1 indicates 100%).
StrokeWeight Unit (Double or String) r/w The stroke weight (thickness) of the stroke.
Tracking Double 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 Double r/w The tint percentage applied to the gap of the underline (-1 represents 100%).
UnderlineOffset Unit (Double or String) r/w The offset of the underline from the baseline.
UnderlineOverprint Boolean r/w If true, overprint the underline.
UnderlineTint Double 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 (Double or String) r/w The stroke weight of the underline.
VerticalScale Double r/w The vertical scaling percentage applied to the object, including the scaling applied to its containing object(s).

CharacterStyle Methods

Method Returns Description
Delete Nothing Deletes the object.
ExtractLabel String Gets the content of the label associated with the specified key (name).
InsertLabel Nothing Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.

Leave a Comment

Previous post:

Next post: