CharacterStyle

A character style.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

Property	Type	Access	Description
appliedFont	Font String NothingEnum.NOTHING	read/write	The font applied to the CharacterStyle, specified as either a font object or the name of font family. Can return: Font, String or NothingEnum enumerator.
appliedLanguage	Language LanguageWithVendors NothingEnumCanalsoaccept:String	read/write	The language of the text. Can return: LanguageWithVendors, Language or NothingEnum enumerator. Can also accept: String.
basedOn	CharacterStyle String	read/write	The style that this style is based on. Can return: CharacterStyle or String.
baselineShift	Unit NothingEnum.NOTHING	read/write	The baseline shift applied to the text. Can return: Unit or NothingEnum enumerator.
capitalization	Capitalization Capitalization.ALL_CAPS Capitalization.CAP_TO_SMALL_CAP Capitalization.NORMAL Capitalization.SMALL_CAPS NothingEnum.NOTHING	read/write	The capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator.
characterDirection	CharacterDirectionOptions CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION NothingEnum.NOTHING	read/write	The direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
diacriticPosition	DiacriticPositionOptions DiacriticPositionOptions.DEFAULT_POSITION DiacriticPositionOptions.LOOSE_POSITION DiacriticPositionOptions.MEDIUM_POSITION DiacriticPositionOptions.OPENTYPE_POSITION DiacriticPositionOptions.TIGHT_POSITION NothingEnum.NOTHING	read/write	Position of diacriticical characters. Can return: DiacriticPositionOptions enumerator or NothingEnum enumerator.
digitsType	DigitsTypeOptions DigitsTypeOptions.ARABIC_DIGITS DigitsTypeOptions.BENGALI_DIGITS DigitsTypeOptions.BURMESE_DIGITS DigitsTypeOptions.DEFAULT_DIGITS DigitsTypeOptions.DEVANAGARI_DIGITS DigitsTypeOptions.FARSI_DIGITS DigitsTypeOptions.FULL_FARSI_DIGITS DigitsTypeOptions.GUJARATI_DIGITS DigitsTypeOptions.GURMUKHI_DIGITS DigitsTypeOptions.HINDI_DIGITS DigitsTypeOptions.KANNADA_DIGITS DigitsTypeOptions.KHMER_DIGITS DigitsTypeOptions.LAO_DIGITS DigitsTypeOptions.MALAYALAM_DIGITS DigitsTypeOptions.NATIVE_DIGITS DigitsTypeOptions.ORIYA_DIGITS DigitsTypeOptions.TAMIL_DIGITS DigitsTypeOptions.TELUGU_DIGITS DigitsTypeOptions.THAI_DIGITS DigitsTypeOptions.TIBETAN_DIGITS NothingEnum.NOTHING	read/write	The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum enumerator.
endJoin	OutlineJoin OutlineJoin.BEVEL_END_JOIN OutlineJoin.MITER_END_JOIN OutlineJoin.ROUND_END_JOIN NothingEnum.NOTHING	read/write	The stroke join type applied to the characters of the text. Can return: OutlineJoin enumerator or NothingEnum enumerator.
fillColor	Swatch NothingEnumCanalsoaccept:String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the CharacterStyle. . Can return: Swatch or NothingEnum enumerator. Can also accept: String.
fillTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The 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.
fontStyle	String NothingEnum.NOTHING	read/write	The name of the font style. Can return: String or NothingEnum enumerator.
gradientFillAngle	Real NothingEnum.NOTHING	read/write	The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientFillLength	Real NothingEnum.NOTHING	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. Can return: Real or NothingEnum enumerator.
gradientFillStart	Array of 2 Units NothingEnum.NOTHING	read/write	The 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.
gradientStrokeAngle	Real NothingEnum.NOTHING	read/write	The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientStrokeLength	Real NothingEnum.NOTHING	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. Can return: Real or NothingEnum enumerator.
gradientStrokeStart	Array of 2 Units NothingEnum.NOTHING	read/write	The 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.
horizontalScale	Real NothingEnum.NOTHING	read/write	The horizontal scaling applied to the CharacterStyle. Can return: Real or NothingEnum enumerator.
id	Number	readonly	The unique ID of the CharacterStyle.
imported	Boolean NothingEnum.NOTHING	readonly	If true, the style was imported from another document. Can return: Boolean or NothingEnum enumerator.
index	Number	readonly	The index of the CharacterStyle within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
kashidas	KashidasOptions KashidasOptions.DEFAULT_KASHIDAS KashidasOptions.KASHIDAS_OFF NothingEnum.NOTHING	read/write	Use of Kashidas for justification. Can return: KashidasOptions enumerator or NothingEnum enumerator.
kerningMethod	String NothingEnum.NOTHING	read/write	The type of pair kerning. Can return: String or NothingEnum enumerator.
keyboardDirection	CharacterDirectionOptions CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION NothingEnum.NOTHING	read/write	The keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
label	String	read/write	A property that can be set to any string.
leading	Leading Leading.AUTO Unit NothingEnum.NOTHING	read/write	The leading applied to the text. Can return: Unit, Leading enumerator or NothingEnum enumerator.
ligatures	Boolean NothingEnum.NOTHING	read/write	If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator.
miterLimit	Real(0-1000) NothingEnum.NOTHING	read/write	The 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.
name	String	read/write	The name of the style.
noBreak	Boolean NothingEnum.NOTHING	read/write	If true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator.
otfContextualAlternate	Boolean NothingEnum.NOTHING	read/write	If true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfDiscretionaryLigature	Boolean NothingEnum.NOTHING	read/write	If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfFigureStyle	OTFFigureStyle OTFFigureStyle.DEFAULT_VALUE OTFFigureStyle.PROPORTIONAL_LINING OTFFigureStyle.PROPORTIONAL_OLDSTYLE OTFFigureStyle.TABULAR_LINING OTFFigureStyle.TABULAR_OLDSTYLE NothingEnum.NOTHING	read/write	The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator.
otfFraction	Boolean NothingEnum.NOTHING	read/write	If true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfHistorical	Boolean NothingEnum.NOTHING	read/write	If true, use historical forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfJustificationAlternate	Boolean NothingEnum.NOTHING	read/write	If true, use alternate justification forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfLocale	Boolean NothingEnum.NOTHING	read/write	If true, uses localized forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfMark	Boolean NothingEnum.NOTHING	read/write	If true, uses mark positioning in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOrdinal	Boolean NothingEnum.NOTHING	read/write	If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOverlapSwash	Boolean NothingEnum.NOTHING	read/write	If true, use overlapping swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfSlashedZero	Boolean NothingEnum.NOTHING	read/write	If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStretchedAlternate	Boolean NothingEnum.NOTHING	read/write	If true, use stretched alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticAlternate	Boolean NothingEnum.NOTHING	read/write	If true, use stylistic alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticSets	LongInteger NothingEnum.NOTHING	read/write	The stylistic sets to use in OpenType fonts. Can return: Long Integer or NothingEnum enumerator.
otfSwash	Boolean NothingEnum.NOTHING	read/write	If true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfTitling	Boolean NothingEnum.NOTHING	read/write	If true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
overprintFill	Boolean NothingEnum.NOTHING	read/write	If true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
overprintStroke	Boolean NothingEnum.NOTHING	read/write	If true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
parent	Application CharacterStyleGroup Document	readonly	The parent of the CharacterStyle (a Document, Application or CharacterStyleGroup).
pointSize	Unit NothingEnum.NOTHING	read/write	The text size. Can return: Unit or NothingEnum enumerator.
position	Position Position.NORMAL Position.OT_DENOMINATOR Position.OT_NUMERATOR Position.OT_SUBSCRIPT Position.OT_SUPERSCRIPT Position.SUBSCRIPT Position.SUPERSCRIPT NothingEnum.NOTHING	read/write	The text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator.
positionalForm	PositionalForms PositionalForms.CALCULATE PositionalForms.FINAL PositionalForms.INITIAL PositionalForms.ISOLATED PositionalForms.MEDIAL PositionalForms.NONE NothingEnum.NOTHING	read/write	The OpenType positional form. Can return: PositionalForms enumerator or NothingEnum enumerator.
previewColor	Array of 3 Reals (0 - 255) NothingEnum.NOTHING UIColors	read/write	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: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum enumerator.
properties	Object	read/write	A property that allows setting of several properties at the same time.
skew	Real NothingEnum.NOTHING	read/write	The skew angle of the CharacterStyle. Can return: Real or NothingEnum enumerator.
strikeThroughColor	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapColor	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapOverprint	Boolean NothingEnum.NOTHING	read/write	If 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.
strikeThroughGapTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	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: Real or NothingEnum enumerator.
strikeThroughOffset	Unit NothingEnum.NOTHING	read/write	The amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator.
strikeThroughOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator.
strikeThroughTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
strikeThroughType	String StrokeStyle NothingEnum.NOTHING	read/write	The stroke type of the strikethrough stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
strikeThroughWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight of the strikethrough stroke. Can return: Unit or NothingEnum enumerator.
strikeThru	Boolean NothingEnum.NOTHING	read/write	If true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator.
strokeAlignment	TextStrokeAlign TextStrokeAlign.CENTER_ALIGNMENT TextStrokeAlign.OUTSIDE_ALIGNMENT NothingEnum.NOTHING	read/write	The stroke alignment applied to the text. Can return: TextStrokeAlign enumerator or NothingEnum enumerator.
strokeColor	Swatch NothingEnumCanalsoaccept:String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the CharacterStyle. Can return: Swatch or NothingEnum enumerator. Can also accept: String.
strokeTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The 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.
strokeWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator.
tracking	Real NothingEnum.NOTHING	read/write	The amount by which to loosen or tighten a block of text, specified in thousands of an em. Can return: Real or NothingEnum enumerator.
underline	Boolean NothingEnum.NOTHING	read/write	If true, underlines the text. Can return: Boolean or NothingEnum enumerator.
underlineColor	String Swatch NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator.
underlineGapColor	String Swatch NothingEnum.NOTHING	read/write	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 NothingEnum enumerator.
underlineGapOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator.
underlineGapTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	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: Real or NothingEnum enumerator.
underlineOffset	Unit NothingEnum.NOTHING	read/write	The amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator.
underlineOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator.
underlineTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
underlineType	String StrokeStyle NothingEnum.NOTHING	read/write	The stroke type of the underline stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
underlineWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight of the underline stroke. Can return: Unit or NothingEnum enumerator.
verticalScale	Real NothingEnum.NOTHING	read/write	The vertical scaling applied to the CharacterStyle. Can return: Real or NothingEnum enumerator.
xOffsetDiacritic	Real NothingEnum.NOTHING	read/write	The x (horizontal) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.
yOffsetDiacritic	Real NothingEnum.NOTHING	read/write	The y (vertical) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.

Method Listing

CharacterStyle duplicate ()

Duplicates the CharacterStyle.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

CharacterStyle getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

CharacterStyle move (to:LocationOptions, reference:Varies CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup Application)

Moves the style to the specified location.

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

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

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)

undefined remove (replacingWith:CharacterStyle)

Deletes the style.

Parameter	Type	Description
replacingWith	CharacterStyle	The style to apply in place of the deleted style. (Optional)

String toSource ()

Generates a string which, if executed, will return the CharacterStyle.

String toSpecifier ()

Retrieves the object specifier.

Object of

CrossReferenceFormat.appliedCharacterStyle

HyperlinkTextSource.appliedCharacterStyle

CrossReferenceSource.appliedCharacterStyle

BuildingBlock.appliedCharacterStyle

Application.allCharacterStyles

Document.allCharacterStyles

CharacterStyleGroup.allCharacterStyles

Text.appliedNestedStyles

Character.appliedNestedStyles

Word.appliedNestedStyles

Line.appliedNestedStyles

TextColumn.appliedNestedStyles

Paragraph.appliedNestedStyles

TextStyleRange.appliedNestedStyles

InsertionPoint.appliedNestedStyles

Story.appliedNestedStyles

XmlStory.appliedNestedStyles

IndexOptions.crossReferenceTopicStyle

IndexOptions.crossReferenceStyle

IndexOptions.pageNumberStyle

PageReference.pageNumberStyleOverride

TOCStyleEntry.pageNumberStyle

TOCStyleEntry.separatorStyle

TextDefault.appliedCharacterStyle

MatchCharacterStylePreference.appliedCharacterStyle

NestedLineStyle.appliedCharacterStyle

NestedGrepStyle.appliedCharacterStyle

Text.appliedCharacterStyle

Character.appliedCharacterStyle

Word.appliedCharacterStyle

Line.appliedCharacterStyle

TextColumn.appliedCharacterStyle

Paragraph.appliedCharacterStyle

TextStyleRange.appliedCharacterStyle

InsertionPoint.appliedCharacterStyle

Story.appliedCharacterStyle

NestedStyle.appliedCharacterStyle

XmlStory.appliedCharacterStyle

FootnoteOption.footnoteMarkerStyle

TextDefault.dropCapStyle

Text.dropCapStyle

Character.dropCapStyle

Word.dropCapStyle

Line.dropCapStyle

TextColumn.dropCapStyle

Paragraph.dropCapStyle

TextStyleRange.dropCapStyle

InsertionPoint.dropCapStyle

Story.dropCapStyle

ParagraphStyle.dropCapStyle

XmlStory.dropCapStyle

TextDefault.numberingCharacterStyle

Text.numberingCharacterStyle

Character.numberingCharacterStyle

Word.numberingCharacterStyle

Line.numberingCharacterStyle

TextColumn.numberingCharacterStyle

Paragraph.numberingCharacterStyle

TextStyleRange.numberingCharacterStyle

InsertionPoint.numberingCharacterStyle

Story.numberingCharacterStyle

ParagraphStyle.numberingCharacterStyle

XmlStory.numberingCharacterStyle

FindTextPreference.numberingCharacterStyle

FindGrepPreference.numberingCharacterStyle

ChangeTextPreference.numberingCharacterStyle

ChangeGrepPreference.numberingCharacterStyle

TextDefault.bulletsCharacterStyle

Text.bulletsCharacterStyle

Character.bulletsCharacterStyle

Word.bulletsCharacterStyle

Line.bulletsCharacterStyle

TextColumn.bulletsCharacterStyle

Paragraph.bulletsCharacterStyle

TextStyleRange.bulletsCharacterStyle

InsertionPoint.bulletsCharacterStyle

Story.bulletsCharacterStyle

ParagraphStyle.bulletsCharacterStyle

XmlStory.bulletsCharacterStyle

FindTextPreference.bulletsCharacterStyle

FindGrepPreference.bulletsCharacterStyle

ChangeTextPreference.bulletsCharacterStyle

ChangeGrepPreference.bulletsCharacterStyle

XMLImportMap.mappedStyle

XMLExportMap.mappedStyle

CharacterStyle.basedOn

CharacterStyle

Methods:

Objects:

Property Listing

Method Listing

Object of

Return