Adobe InDesign CS3 (5.0) Object Model JS: CharacterStyle

InDesign CS3

Class

CharacterStyle

 A character style.

QuickLinks

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

Hierarchy

Application | CharacterStyleGroup | Document
CharacterStyle

Properties

PropertyTypeAccessDescription
appliedFontFontNothingEnum
String
r/wThe font applied to the text, specified as either a font object or the name of font family. Can return: Font, String or NothingEnum enumerator.
appliedLanguageLanguage
LanguageWithVendors
NothingEnum
String
r/wThe language of the text. Can return: LanguageWithVendors, Language or NothingEnum enumerator. Can also accept: String.
basedOnCharacterStyle
NothingEnum
String
r/wThe style that this style is based on. Can return: CharacterStyle, String or NothingEnum enumerator.
baselineShiftNothingEnum
Unit
r/wThe baseline shift applied to the text. Can return: Unit or NothingEnum enumerator.
capitalizationCapitalization
NothingEnum
r/wThe capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator.
characterDirectionCharacterDirectionOptions
NothingEnum
r/wThe direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
diacriticPositionDiacriticPositionOptions
NothingEnum
r/wPosition of diacriticical characters. Can return: DiacriticPositionOptions enumerator or NothingEnum enumerator.
digitsTypeDigitsTypeOptions
NothingEnum
r/wThe digits type. Can return: DigitsTypeOptions enumerator or NothingEnum enumerator.
fillColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can return: Swatch or NothingEnum enumerator. Can also accept: String.
fillTintNothingEnum
Real
r/wThe 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: Real or NothingEnum enumerator.
fontStyleNothingEnum
String
r/wThe name of the font style. Can return: String or NothingEnum enumerator.
gradientFillAngleNothingEnum
Real
r/wThe angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientFillLengthNothingEnum
Real
r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. Can return: Real or NothingEnum enumerator.
gradientFillStart2 Units
NothingEnum
r/wThe 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.
gradientStrokeAngleNothingEnum
Real
r/wThe angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientStrokeLengthNothingEnum
Real
r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. Can return: Real or NothingEnum enumerator.
gradientStrokeStart2 Units
NothingEnum
r/wThe 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.
horizontalScaleNothingEnum
Real
r/wThe horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator.
idLong Integer
NothingEnum
readonlyThe unique ID of the CharacterStyle. Can return: Long Integer or NothingEnum enumerator.
importedBoolean
NothingEnum
readonlyIf true, the style was imported from another document. Can return: Boolean or NothingEnum enumerator.
indexLong Integer
NothingEnum
readonlyThe index of the CharacterStyle within its containing object. Can return: Long Integer or NothingEnum enumerator.
kashidasKashidasOptions
NothingEnum
r/wUse of Kashidas for justification. Can return: KashidasOptions enumerator or NothingEnum enumerator.
kerningMethodNothingEnum
String
r/wThe type of pair kerning. Can return: String or NothingEnum enumerator.
keyboardDirectionCharacterDirectionOptions
NothingEnum
r/wThe keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
labelNothingEnum
String
r/wA property that can be set to any string. Can return: String or NothingEnum enumerator.
leadingLeading
NothingEnum
Unit
r/wThe leading applied to the text. Can return: Unit, Leading enumerator or NothingEnum enumerator.
ligaturesBoolean
NothingEnum
r/wIf true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator.
nameNothingEnum
String
r/wThe name of the CharacterStyle. Can return: String or NothingEnum enumerator.
noBreakBoolean
NothingEnum
r/wIf true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator.
otfContextualAlternateBoolean
NothingEnum
r/wIf true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfDiscretionaryLigatureBoolean
NothingEnum
r/wIf true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfFigureStyleNothingEnum
OTFFigureStyle
r/wThe figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator.
otfFractionBoolean
NothingEnum
r/wIf true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfHistoricalBoolean
NothingEnum
r/wIf true, use historical forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfJustificationAlternateBoolean
NothingEnum
r/wIf true, use alternate justification forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfLocaleBoolean
NothingEnum
r/wIf true, uses localized forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfMarkBoolean
NothingEnum
r/wIf true, uses mark positioning in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOrdinalBoolean
NothingEnum
r/wIf true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOverlapSwashBoolean
NothingEnum
r/wIf true, use overlapping swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfSlashedZeroBoolean
NothingEnum
r/wIf true, use a slashed zeroes in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStretchedAlternateBoolean
NothingEnum
r/wIf true, use stretched alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticAlternateBoolean
NothingEnum
r/wIf true, use stylistic alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticSetsLong Integer
NothingEnum
r/wThe stylistic sets to use in OpenType fonts. Can return: Long Integer or NothingEnum enumerator.
otfSwashBoolean
NothingEnum
r/wIf true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfTitlingBoolean
NothingEnum
r/wIf true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
overprintFillBoolean
NothingEnum
r/wIf true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
overprintStrokeBoolean
NothingEnum
r/wIf true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
parentApplication
CharacterStyleGroup
Document
readonlyThe parent of the CharacterStyle (a Document, Application or CharacterStyleGroup).
pointSizeNothingEnum
Unit
r/wThe text size. Can return: Unit or NothingEnum enumerator.
positionNothingEnum
Position
r/wThe text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator.
positionalFormNothingEnum
PositionalForms
r/wThe OpenType positional form. Can return: PositionalForms enumerator or NothingEnum enumerator.
propertiesObject r/wA property that allows setting of several properties at the same time.
skewNothingEnum
Real
r/wThe skew angle of the text. (Range: -85 to 85). Can return: Real or NothingEnum enumerator.
strikeThroughColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapOverprintBoolean
NothingEnum
r/wIf 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.
strikeThroughGapTintNothingEnum
Real
r/wThe 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.
strikeThroughOffsetNothingEnum
Unit
r/wThe amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator.
strikeThroughOverprintBoolean
NothingEnum
r/wIf true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator.
strikeThroughTintNothingEnum
Real
r/wThe tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
strikeThroughTypeNothingEnum
String
StrokeStyle
r/wThe stroke type of the strikethrough stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
strikeThroughWeightNothingEnum
Unit
r/wThe stroke weight of the strikethrough stroke. Can return: Unit or NothingEnum enumerator.
strikeThruBoolean
NothingEnum
r/wIf true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator.
strokeColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can return: Swatch or NothingEnum enumerator. Can also accept: String.
strokeTintNothingEnum
Real
r/wThe 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: Real or NothingEnum enumerator.
strokeWeightNothingEnum
Unit
r/wThe stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator.
trackingNothingEnum
Real
r/wThe amount by which to loosen or tighten a block of text, specified in thousands of an em. Can return: Real or NothingEnum enumerator.
underlineBoolean
NothingEnum
r/wIf true, underlines the text. Can return: Boolean or NothingEnum enumerator.
underlineColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator.
underlineGapColorNothingEnum
String
Swatch
r/wThe 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.
underlineGapOverprintBoolean
NothingEnum
r/wIf true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator.
underlineGapTintNothingEnum
Real
r/wThe 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.
underlineOffsetNothingEnum
Unit
r/wThe amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator.
underlineOverprintBoolean
NothingEnum
r/wIf true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator.
underlineTintNothingEnum
Real
r/wThe underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
underlineTypeNothingEnum
String
StrokeStyle
r/wThe stroke type of the underline stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
underlineWeightNothingEnum
Unit
r/wThe stroke weight of the underline stroke. Can return: Unit or NothingEnum enumerator.
verticalScaleNothingEnum
Real
r/wThe vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator.
xOffsetDiacriticNothingEnum
Real
r/wThe x (horizontal) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.
yOffsetDiacriticNothingEnum
Real
r/wThe y (vertical) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.

Methods

Instances

CharacterStyle duplicate ()
Duplicates the CharacterStyle.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of CharacterStyle getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

CharacterStyle move (to: LocationOptions[, reference: any])
Moves the style to the specified location.

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

void remove ([replacingWith: CharacterStyle])
Deletes the style.

ParameterTypeDescription
replacingWithCharacterStyleThe 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.

Element of

Application.allCharacterStyles

ChangeGrepPreference.appliedCharacterStyle

ChangeGrepPreference.bulletsCharacterStyle

ChangeGrepPreference.numberingCharacterStyle

ChangeTextPreference.appliedCharacterStyle

ChangeTextPreference.bulletsCharacterStyle

ChangeTextPreference.numberingCharacterStyle

Character.appliedCharacterStyle

Character.appliedNestedStyle

Character.bulletsCharacterStyle

Character.dropCapStyle

Character.numberingCharacterStyle

CharacterStyle.basedOn

CharacterStyleGroup.allCharacterStyles

Document.allCharacterStyles

FindGrepPreference.appliedCharacterStyle

FindGrepPreference.bulletsCharacterStyle

FindGrepPreference.numberingCharacterStyle

FindTextPreference.appliedCharacterStyle

FindTextPreference.bulletsCharacterStyle

FindTextPreference.numberingCharacterStyle

FootnoteOption.footnoteMarkerStyle

IndexOptions.crossReferenceStyle

IndexOptions.crossReferenceTopicStyle

IndexOptions.pageNumberStyle

InsertionPoint.appliedCharacterStyle

InsertionPoint.appliedNestedStyle

InsertionPoint.bulletsCharacterStyle

InsertionPoint.dropCapStyle

InsertionPoint.numberingCharacterStyle

Line.appliedCharacterStyle

Line.appliedNestedStyle

Line.bulletsCharacterStyle

Line.dropCapStyle

Line.numberingCharacterStyle

MatchCharacterStylePreference.appliedCharacterStyle

NestedStyle.appliedCharacterStyle

PageReference.pageNumberStyleOverride

Paragraph.appliedCharacterStyle

Paragraph.appliedNestedStyle

Paragraph.bulletsCharacterStyle

Paragraph.dropCapStyle

Paragraph.numberingCharacterStyle

ParagraphStyle.bulletsCharacterStyle

ParagraphStyle.dropCapStyle

ParagraphStyle.numberingCharacterStyle

Story.appliedCharacterStyle

Story.appliedNestedStyle

Story.bulletsCharacterStyle

Story.dropCapStyle

Story.numberingCharacterStyle

TOCStyleEntry.pageNumberStyle

TOCStyleEntry.separatorStyle

Text.appliedCharacterStyle

Text.appliedNestedStyle

Text.bulletsCharacterStyle

Text.dropCapStyle

Text.numberingCharacterStyle

TextColumn.appliedCharacterStyle

TextColumn.appliedNestedStyle

TextColumn.bulletsCharacterStyle

TextColumn.dropCapStyle

TextColumn.numberingCharacterStyle

TextDefault.appliedCharacterStyle

TextDefault.bulletsCharacterStyle

TextDefault.dropCapStyle

TextDefault.numberingCharacterStyle

TextStyleRange.appliedCharacterStyle

TextStyleRange.appliedNestedStyle

TextStyleRange.bulletsCharacterStyle

TextStyleRange.dropCapStyle

TextStyleRange.numberingCharacterStyle

Word.appliedCharacterStyle

Word.appliedNestedStyle

Word.bulletsCharacterStyle

Word.dropCapStyle

Word.numberingCharacterStyle

XMLExportMap.mappedStyle

XMLImportMap.mappedStyle

XmlStory.appliedCharacterStyle

XmlStory.appliedNestedStyle

XmlStory.bulletsCharacterStyle

XmlStory.dropCapStyle

XmlStory.numberingCharacterStyle

Used in:

CellStyle CellStyle.move (to: LocationOptions[, reference: any])

CellStyleGroup CellStyleGroup.move (to: LocationOptions[, reference: any])

void CellStyleGroup.remove ([replacingWith: any])

void Character.applyCharacterStyle (using: CharacterStyle)

CharacterStyle CharacterStyle.move (to: LocationOptions[, reference: any])

void CharacterStyle.remove ([replacingWith: CharacterStyle])

CharacterStyleGroup CharacterStyleGroup.move (to: LocationOptions[, reference: any])

void CharacterStyleGroup.remove ([replacingWith: any])

array of CharacterStyle CharacterStyles.itemByRange (from: any, to: any)

CharacterStyle CharacterStyles.nextItem (obj: CharacterStyle)

CharacterStyle CharacterStyles.previousItem (obj: CharacterStyle)

void InsertionPoint.applyCharacterStyle (using: CharacterStyle)

void Line.applyCharacterStyle (using: CharacterStyle)

PageReference PageReferences.add (source: Text[, pageReferenceType: PageReferenceType=PageReferenceType.CURRENT_PAGE][, pageReferenceLimit: any][, pageNumberStyleOverride: CharacterStyle][, withProperties: Object])

void Paragraph.applyCharacterStyle (using: CharacterStyle)

ParagraphStyle ParagraphStyle.move (to: LocationOptions[, reference: any])

ParagraphStyleGroup ParagraphStyleGroup.move (to: LocationOptions[, reference: any])

void ParagraphStyleGroup.remove ([replacingWith: any])

TableStyle TableStyle.move (to: LocationOptions[, reference: any])

TableStyleGroup TableStyleGroup.move (to: LocationOptions[, reference: any])

void TableStyleGroup.remove ([replacingWith: any])

void Text.applyCharacterStyle (using: CharacterStyle)

void TextColumn.applyCharacterStyle (using: CharacterStyle)

void TextStyleRange.applyCharacterStyle (using: CharacterStyle)

void Word.applyCharacterStyle (using: CharacterStyle)

void XMLElement.applyCharacterStyle (using: any)

XMLExportMap XMLExportMaps.add (mappedStyle: any, markupTag: any[, withProperties: Object])

XMLImportMap XMLImportMaps.add (markupTag: any, mappedStyle: any[, withProperties: Object])

Return

CharacterStyle CharacterStyle.duplicate ()

Array of CharacterStyle CharacterStyle.getElements ()

CharacterStyle CharacterStyle.move (to: LocationOptions[, reference: any])

CharacterStyle CharacterStyles.add ([withProperties: Object])

CharacterStyle CharacterStyles.anyItem ()

Array of CharacterStyle CharacterStyles.everyItem ()

CharacterStyle CharacterStyles.firstItem ()

CharacterStyle CharacterStyles.item (index: any)

CharacterStyle CharacterStyles.itemByID (id: number)

CharacterStyle CharacterStyles.itemByName (name: string)

Array of CharacterStyle CharacterStyles.itemByRange (from: any, to: any)

CharacterStyle CharacterStyles.lastItem ()

CharacterStyle CharacterStyles.middleItem ()

CharacterStyle CharacterStyles.nextItem (obj: CharacterStyle)

CharacterStyle CharacterStyles.previousItem (obj: CharacterStyle)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index