Scriptographer.org - CharacterStyle

The CharacterStyle object represents the character style of a text item ( textItem.characterStyle) or a text range ( textRange.characterStyle).

Sample code:

var text = new PointText(new Point(50, 100));
text.content = 'Hello world.';
text.characterStyle.font = app.fonts['helvetica'];
text.characterStyle.fontSize = 10;
text.characterStyle.tracking = 100;

Constructors

CharacterStyle()

Properties

font

Specifies which font to use in the character style. If you pass a font family, it will automatically pick the first of the family's weights.

Sample code:

var text = new PointText(new Point(0,0));
text.content = 'The content of the text field.';

// Sets all the text to Verdana Regular.
text.characterStyle.font = app.fonts['Verdana'];

//sets the second word to Verdana Bold
text.range.words[1].characterStyle.font = app.fonts['Verdana']['Bold'];

Accepts:

FontWeight
String
FontFamily

Returns:

FontWeight

fontSize

horizontalScale

verticalScale

autoLeading

leading

tracking

baselineShift

rotation

The rotation of the characters in the text item that the character style is applied to.

Angles are oriented clockwise and measured in degrees by default. Read more about angle units and orientation in the description of the point.angle property.

Sample code:

var text = new PointText(new Point(0,0));
text.content = 'The content of the text field.';

// sets the character rotation to 45 degrees:
text.characterStyle.rotation = 45;

Returns:

Number — the rotation angle

kerning

kerningType

The character style's kerning method.

Sample code:

var text = new PointText(new Point(0,0));
text.content = 'The content of the text field.';

// sets the kerning method to optical
text.characterStyle.kerningType = 'optical';

Returns:

String ('manual', 'metric', 'optical')

capitalization

The character style's capitalization.

Sample code:

var text = new PointText(new Point(0,0));
text.content = 'The content of the text field.';

// sets the capitalization to all caps
text.characterStyle.capitalization = 'all';

Returns:

String ('normal', 'small', 'all', 'all-small')

baselineOption

The character style's baseline option which is used to set the text to either subscript or superscript. Superscript and subscript text is reduced-size text that is raised or lowered in relation to a font's baseline.

Sample code:

var text = new PointText(new Point(0,0));
text.content = 'The content of the text field.';

// sets the baseline option to superscript:
text.characterStyle.capitalization = 'superscript';

Returns: