A collection of character styles.
character style Properties
| Property | Type | Access | Description |
|---|---|---|---|
| applied font | any | r/w | The font applied to the text, specified as either a font object or the name of font family. Can return: font, string or nothing. |
| applied language | any | r/w | The language of the text. Can return: language with vendors, language or nothing. Can also accept: string. |
| based on | any | r/w | The style that this style is based on. Can return: character style or string. |
| baseline shift | any | r/w | The baseline shift applied to the text. Can return: number or string or nothing. |
| capitalization | any | r/w | The capitalization scheme. Can return: normal/small caps/all caps/cap to small cap or nothing. |
| character direction | any | r/w | The direction of the character. Can return: default direction/left to right direction/right to left direction or nothing. |
| class | type | read | The class descriptor type. |
| diacritic position | any | r/w | Position of diacriticical characters. Can return: default position/loose position/medium position/tight position/opentype position or nothing. |
| digits type | any | r/w | The digits type. Can return: default digits/arabic digits/hindi digits/farsi digits/Native digits/full farsi digits/thai digits/lao digits/devanagari digits/bengali digits/gurmukhi digits/gujarati digits/oriya digits/tamil digits/telugu digits/kannada … |
| end join | any | r/w | The stroke join type applied to the characters of the text. Can return: miter end join/round end join/bevel end join or nothing. |
| fill color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can return: swatch or nothing. Can also accept: string. |
| fill tint | any | r/w | The tint (as a percentage) of the fill color of the text. (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: fixed or nothing. |
| font style | any | r/w | The name of the font style. Can return: string or nothing. |
| gradient fill angle | any | r/w | The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: fixed or nothing. |
| gradient fill length | any | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. Can return: fixed or nothing. |
| gradient fill start | any | r/w | The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. Can return: list of 2 numbers or strings or nothing. |
| gradient stroke angle | any | r/w | The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: fixed or nothing. |
| gradient stroke length | any | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. Can return: fixed or nothing. |
| gradient stroke start | any | r/w | The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. Can return: list of 2 numbers or strings or nothing. |
| horizontal scale | any | r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: fixed or nothing. |
| id | integer | read | The unique ID of the character style. |
| imported | any | read | If true, the style was imported from another document. Can return: boolean or nothing. |
| index | integer | read | The index of the character style within its containing object. |
| kashidas | any | r/w | Use of Kashidas for justification. Can return: default kashidas/kashidas off or nothing. |
| kerning method | any | r/w | The type of pair kerning. Can return: string or nothing. |
| keyboard direction | any | r/w | The keyboard direction of the character. Can return: default direction/left to right direction/right to left direction or nothing. |
| label | text | r/w | A property that can be set to any string. |
| leading | any | r/w | The leading applied to the text. Can return: number or string, auto or nothing. |
| ligatures | any | r/w | If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: boolean or nothing. |
| miter limit | any | r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. Can return: fixed (0 – 1000) or nothing. |
| name | text | r/w | The name of the style. |
| no break | any | r/w | If true, keeps the text on the same line. . Can return: boolean or nothing. |
| object reference | character style | read | An object reference for the object. |
| OTF contextual alternate | any | r/w | If true, uses contextual alternate forms in OpenType fonts. Can return: boolean or nothing. |
| OTF discretionary ligature | any | r/w | If true, uses discretionary ligatures in OpenType fonts. Can return: boolean or nothing. |
| OTF figure style | any | r/w | The figure style in OpenType fonts. Can return: tabular lining/proportional oldstyle/proportional lining/tabular oldstyle/default or nothing. |
| OTF fraction | any | r/w | If true, uses fractions in OpenType fonts. Can return: boolean or nothing. |
| OTF historical | any | r/w | If true, use historical forms in OpenType fonts. Can return: boolean or nothing. |
| OTF justification alternate | any | r/w | If true, use alternate justification forms in OpenType fonts. Can return: boolean or nothing. |
| OTF locale | any | r/w | If true, uses localized forms in OpenType fonts. Can return: boolean or nothing. |
| OTF mark | any | r/w | If true, uses mark positioning in OpenType fonts. Can return: boolean or nothing. |
| OTF ordinal | any | r/w | If true, uses ordinals in OpenType fonts. Can return: boolean or nothing. |
| OTF overlap swash | any | r/w | If true, use overlapping swash forms in OpenType fonts. Can return: boolean or nothing. |
| OTF slashed zero | any | r/w | If true, use a slashed zeroes in OpenType fonts. Can return: boolean or nothing. |
| OTF stretched alternate | any | r/w | If true, use stretched alternate forms in OpenType fonts. Can return: boolean or nothing. |
| OTF stylistic alternate | any | r/w | If true, use stylistic alternate forms in OpenType fonts. Can return: boolean or nothing. |
| OTF stylistic sets | any | r/w | The stylistic sets to use in OpenType fonts. Can return: integer or nothing. |
| OTF swash | any | r/w | If true, uses swash forms in OpenType fonts. Can return: boolean or nothing. |
| OTF titling | any | r/w | If true, uses titling forms in OpenType fonts. Can return: boolean or nothing. |
| overprint fill | any | r/w | If true, the fill color of the characters will overprint. Can return: boolean or nothing. |
| overprint stroke | any | r/w | If true, the stroke of the characters will overprint. Can return: boolean or nothing. |
| parent | specifier | read | The parent of the character style (a document, application or character style group). Can return: document, application or character style group. |
| point size | any | r/w | The text size. Can return: number or string or nothing. |
| position | any | r/w | The text position relative to the baseline. Can return: normal/superscript/subscript/OT superscript/OT subscript/OT numerator/OT denominator or nothing. |
| positional form | any | r/w | The OpenType positional form. Can return: none/calculate/initial/medial/final/isolated or nothing. |
| preview color | any | r/w | 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: list of 3 fixed (0 – 255) or light blue/red/green/blue/yellow/magenta/cyan/gray/b… |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| skew | any | r/w | The skew angle of the text. (Range: -85 to 85). Can return: fixed or nothing. |
| strike through color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: swatch, string or nothing. |
| strike through gap color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: swatch, string or nothing. |
| strike through gap overprint | any | r/w | If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. Can return: boolean or nothing. |
| strike through gap tint | any | r/w | 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: fixed or nothing. |
| strike through offset | any | r/w | The amount by which to offset the strikethrough stroke from the text baseline. Can return: number or string or nothing. |
| strike through overprint | any | r/w | If true, the strikethrough stroke will overprint. Can return: boolean or nothing. |
| strike through tint | any | r/w | The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: fixed or nothing. |
| strike through type | any | r/w | The stroke type of the strikethrough stroke. Can return: stroke style, string or nothing. |
| strike through weight | any | r/w | The stroke weight of the strikethrough stroke. Can return: number or string or nothing. |
| strike thru | any | r/w | If true, draws a strikethrough line through the text. Can return: boolean or nothing. |
| stroke alignment | any | r/w | The stroke alignment applied to the text. Can return: center alignment/outside alignment or nothing. |
| stroke color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can return: swatch or nothing. Can also accept: string. |
| stroke tint | any | r/w | The tint (as a percentage) of the stroke color of the text. (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: fixed or nothing. |
| stroke weight | any | r/w | The stroke weight applied to the characters of the text. Can return: number or string or nothing. |
| tracking | any | r/w | The amount by which to loosen or tighten a block of text, specified in thousands of an em. Can return: fixed or nothing. |
| underline | any | r/w | If true, underlines the text. Can return: boolean or nothing. |
| underline color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: swatch, string or nothing. |
| underline gap color | any | r/w | 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 nothing. |
| underline gap overprint | any | r/w | If true, the gap color of the underline stroke will overprint. Can return: boolean or nothing. |
| underline gap tint | any | r/w | 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: fixed or nothing. |
| underline offset | any | r/w | The amount by which to offset the underline from the text baseline. Can return: number or string or nothing. |
| underline overprint | any | r/w | If true, the underline stroke color will overprint. Can return: boolean or nothing. |
| underline tint | any | r/w | The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: fixed or nothing. |
| underline type | any | r/w | The stroke type of the underline stroke. Can return: stroke style, string or nothing. |
| underline weight | any | r/w | The stroke weight of the underline stroke. Can return: number or string or nothing. |
| vertical scale | any | r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: fixed or nothing. |
| x offset diacritic | any | r/w | The x (horizontal) offset for diacritic adjustment. Can return: fixed or nothing. |
| y offset diacritic | any | r/w | The y (vertical) offset for diacritic adjustment. Can return: fixed or nothing. |