Class
A character style. extractLabel, insertLabel, remove
CharacterStyle
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| appliedFont | FontNothingEnum String |
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 NothingEnum enumerator. |
| appliedLanguage | Language NothingEnum String |
r/w | The language of the text. Can return: Language or NothingEnum enumerator. Can also accept: String. |
| basedOn | CharacterStyle NothingEnum String |
r/w | The style that this style is based on. Can return: CharacterStyle, String or NothingEnum enumerator. |
| baselineShift | NothingEnum Real |
r/w | The vertical distance by which to offset the text from the baseline. Can return: Real or NothingEnum enumerator. |
| capitalization | Capitalization NothingEnum |
r/w | The capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator. |
| characterDirection | CharacterDirectionOptions NothingEnum |
r/w | The direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator. |
| diacriticPosition | DiacriticPositionOptions NothingEnum |
r/w | Position of diacriticical characters. Can return: DiacriticPositionOptions enumerator or NothingEnum enumerator. |
| digitsType | DigitsTypeOptions NothingEnum |
r/w | The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum enumerator. |
| fillColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can return: Swatch or NothingEnum enumerator. Can also accept: String. |
| fillTint | NothingEnum Real |
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: Real or NothingEnum enumerator. |
| fontStyle | NothingEnum String |
r/w | The name of the font style. Can return: String or NothingEnum enumerator. |
| horizontalScale | NothingEnum Real |
r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator. |
| hyphenWeight | NothingEnum Short |
r/w | Hyphen weight. Can return: Short or NothingEnum enumerator. |
| id | Long NothingEnum |
readonly | The unique ID of the CharacterStyle. Can return: Long or NothingEnum enumerator. |
| imported | Boolean NothingEnum |
readonly | If true, the style was imported from another document. Can return: Boolean or NothingEnum enumerator. |
| index | Long NothingEnum |
readonly | The index of the CharacterStyle within its containing object. Can return: Long or NothingEnum enumerator. |
| kashidas | KashidasOptions NothingEnum |
r/w | Use of Kashidas for justification. Can return: KashidasOptions enumerator or NothingEnum enumerator. |
| kerningMethod | NothingEnum String |
r/w | The type of pair kerning. Can return: String or NothingEnum enumerator. |
| keyboardDirection | CharacterDirectionOptions NothingEnum |
r/w | The keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator. |
| label | NothingEnum String |
r/w | A property that can be set to any string. Can return: String or NothingEnum enumerator. |
| leading | Leading NothingEnum Real |
r/w | The leading amount. Can return: Real, Leading enumerator or NothingEnum enumerator. |
| ligatures | Boolean NothingEnum |
r/w | If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator. |
| name | NothingEnum String |
r/w | The name of the CharacterStyle. Can return: String or NothingEnum enumerator. |
| noBreak | Boolean NothingEnum |
r/w | If true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator. |
| otfContextualAlternate | Boolean NothingEnum |
r/w | If true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfDiscretionaryLigature | Boolean NothingEnum |
r/w | If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfFigureStyle | NothingEnum OTFFigureStyle |
r/w | The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator. |
| otfFraction | Boolean NothingEnum |
r/w | If true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfJustificationAlternate | Boolean NothingEnum |
r/w | If true, use alternate justification forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfOrdinal | Boolean NothingEnum |
r/w | If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfOverlapSwash | Boolean NothingEnum |
r/w | If true, use overlapping swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfStretchedAlternate | Boolean NothingEnum |
r/w | If true, use stretched alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfStylisticAlternate | Boolean NothingEnum |
r/w | If true, use stylistic alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfSwash | Boolean NothingEnum |
r/w | If true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfTitling | Boolean NothingEnum |
r/w | If true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| overprintFill | Boolean NothingEnum |
r/w | If true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator. |
| overprintStroke | Boolean NothingEnum |
r/w | If true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator. |
| parent | Application Document |
readonly | The parent of the CharacterStyle (a Document or Application). |
| pointSize | NothingEnum Real |
r/w | The size of the text in points. Can return: Real or NothingEnum enumerator. |
| position | NothingEnum Position |
r/w | The text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| skew | NothingEnum Real |
r/w | The skew angle of the text. (Range: -85 to 85). Can return: Real or NothingEnum enumerator. |
| strikeThroughColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. |
| strikeThroughGapColor | NothingEnum String Swatch |
r/w | 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 |
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 NothingEnum enumerator. |
| strikeThroughGapTint | NothingEnum Real |
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: Real or NothingEnum enumerator. |
| strikeThroughOffset | NothingEnum Unit |
r/w | The amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator. |
| strikeThroughOverprint | Boolean NothingEnum |
r/w | If true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| strikeThroughTint | NothingEnum Real |
r/w | The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| strikeThroughType | NothingEnum StrokeStyle |
r/w | The stroke type of the strike through. Can return: StrokeStyle or NothingEnum enumerator. |
| strikeThroughWeight | NothingEnum Real |
r/w | The stroke weight of the strikethrough. Can return: Real or NothingEnum enumerator. |
| strikeThru | Boolean NothingEnum |
r/w | If true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator. |
| strokeColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can return: Swatch or NothingEnum enumerator. Can also accept: String. |
| strokeTint | NothingEnum Real |
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: Real or NothingEnum enumerator. |
| strokeWeight | NothingEnum Real |
r/w | The stroke weight (in points) to apply to the stroke of the text. Can return: Real or NothingEnum enumerator. |
| tracking | NothingEnum Real |
r/w | 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 |
r/w | If true, underlines the text. Can return: Boolean or NothingEnum enumerator. |
| underlineColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator. |
| underlineGapColor | NothingEnum String Swatch |
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 NothingEnum enumerator. |
| underlineGapOverprint | Boolean NothingEnum |
r/w | If true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| underlineGapTint | NothingEnum Real |
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: Real or NothingEnum enumerator. |
| underlineOffset | NothingEnum Unit |
r/w | The amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator. |
| underlineOverprint | Boolean NothingEnum |
r/w | If true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator. |
| underlineTint | NothingEnum Real |
r/w | The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| underlineType | NothingEnum StrokeStyle |
r/w | The stroke type of the underline. Can return: StrokeStyle or NothingEnum enumerator. |
| underlineWeight | NothingEnum Real |
r/w | The underline stroke weight. Can return: Real or NothingEnum enumerator. |
| verticalScale | NothingEnum Real |
r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator. |
| xOffsetDiacritic | NothingEnum Real |
r/w | The x (horizontal) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator. |
| yOffsetDiacritic | NothingEnum Real |
r/w | The y (vertical) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator. |
Methods
Instances
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
void 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. |
Element of
ChangePreference.appliedCharacterStyle
Character.appliedCharacterStyle
Character.dropCapStyle
CharacterStyle.basedOn
FindPreference.appliedCharacterStyle
IndexOptions.crossReferenceStyle
IndexOptions.crossReferenceTopicStyle
IndexOptions.pageNumberStyle
InsertionPoint.appliedCharacterStyle
InsertionPoint.dropCapStyle
Line.appliedCharacterStyle
Line.dropCapStyle
NestedStyle.appliedCharacterStyle
PageReference.pageNumberStyleOverride
Paragraph.appliedCharacterStyle
Paragraph.dropCapStyle
ParagraphStyle.dropCapStyle
Story.appliedCharacterStyle
Story.dropCapStyle
TOCStyleEntry.pageNumberStyle
TOCStyleEntry.separatorStyle
Text.appliedCharacterStyle
Text.dropCapStyle
TextColumn.appliedCharacterStyle
TextColumn.dropCapStyle
TextDefault.appliedCharacterStyle
TextDefault.dropCapStyle
TextStyleRange.appliedCharacterStyle
TextStyleRange.dropCapStyle
Word.appliedCharacterStyle
Word.dropCapStyle
XMLExportMap.mappedStyle
XMLImportMap.mappedStyle
Used in:
void Character.applyStyle (using: any[, clearingOverrides: bool=true])
void InsertionPoint.applyStyle (using: any[, clearingOverrides: bool=true])
void Line.applyStyle (using: any[, clearingOverrides: bool=true])
PageReference PageReferences.add (parentStory: Story, storyOffset: any[, pageReferenceType: PageReferenceType=PageReferenceType.CURRENT_PAGE][, pageReferenceLimit: any][, pageNumberStyleOverride: CharacterStyle][, withProperties: Object])
void Paragraph.applyStyle (using: any[, clearingOverrides: bool=true])
void Text.applyStyle (using: any[, clearingOverrides: bool=true])
void TextColumn.applyStyle (using: any[, clearingOverrides: bool=true])
void TextStyleRange.applyStyle (using: any[, clearingOverrides: bool=true])
void Word.applyStyle (using: any[, clearingOverrides: bool=true])
XMLExportMap XMLExportMaps.add (mappedStyle: any, markupTag: any[, withProperties: Object])
XMLImportMap XMLImportMaps.add (markupTag: any, mappedStyle: any[, withProperties: Object])
Return
CharacterStyle CharacterStyles.add ([withProperties: Object])
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |