Class
Text defaults. getElements, toSource, toSpecifier
TextDefault
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| alignToBaseline | bool | r/w | If true, aligns the baseline of the text to the baseline grid. |
| appliedCharacterStyle | CharacterStyleString | r/w | The character style applied to the text. Can also accept: String. |
| appliedFont | Font String |
r/w | The font applied to the text, specified as either a font object or the name of font family. Can return: Font or String. |
| appliedLanguage | Language LanguageWithVendors String |
r/w | The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String. |
| appliedParagraphStyle | ParagraphStyle String |
r/w | The paragraph style applied to the text. Can also accept: String. |
| autoLeading | number | r/w | The percent of the type size to use for auto leading. (Range: 0 to 500). |
| balanceRaggedLines | BalanceLinesStyle Boolean |
r/w | If true or set to an enumeration value, balances ragged lines. Note: Not valid with a single-line text composer. Can return: Boolean or BalanceLinesStyle enumerator. |
| baselineShift | Measurement Unit (Number or String) | r/w | The baseline shift applied to the text. |
| bulletChar | Bullet | readonly | Bullet character. |
| bulletsAndNumberingColor | AutoEnum String Swatch |
r/w | Color of the bullet or number character. Can return: AutoEnum enumerator, Swatch or String. |
| bulletsAndNumberingListType | ListType: ListType.NO_LIST ListType.BULLET_LIST ListType.NUMBERED_LIST |
r/w | List type for bullets and numbering. |
| bulletsAndNumberingSize | AutoEnum Real |
r/w | Point size of the bullet or number character. Can return: AutoEnum enumerator or Real. |
| capitalization | Capitalization: Capitalization.NORMAL Capitalization.SMALL_CAPS Capitalization.ALL_CAPS Capitalization.CAP_TO_SMALL_CAP |
r/w | The capitalization scheme. |
| characterDirection | CharacterDirectionOptions: CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION |
r/w | The direction of the character. |
| composer | string | r/w | The text composer to use to compose the text. |
| desiredGlyphScaling | number | r/w | The desired width (as a percentage) of individual characters. (Range: 50 to 200) |
| desiredLetterSpacing | number | r/w | The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) |
| desiredWordSpacing | number | r/w | The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000) |
| diacriticPosition | DiacriticPositionOptions: DiacriticPositionOptions.DEFAULT_POSITION DiacriticPositionOptions.LOOSE_POSITION DiacriticPositionOptions.MEDIUM_POSITION DiacriticPositionOptions.TIGHT_POSITION DiacriticPositionOptions.OPENTYPE_POSITION |
r/w | Position of diacriticical characters. |
| digitsType | DigitsTypeOptions: DigitsTypeOptions.DEFAULT_DIGITS DigitsTypeOptions.ARABIC_DIGITS DigitsTypeOptions.HINDI_DIGITS DigitsTypeOptions.FARSI_DIGITS DigitsTypeOptions.NATIVE_DIGITS DigitsTypeOptions.FULL_FARSI_DIGITS DigitsTypeOptions.THAI_DIGITS DigitsTypeOptions.LAO_DIGITS DigitsTypeOptions.DEVANAGARI_DIGITS DigitsTypeOptions.BENGALI_DIGITS DigitsTypeOptions.GURMUKHI_DIGITS DigitsTypeOptions.GUJARATI_DIGITS DigitsTypeOptions.ORIYA_DIGITS DigitsTypeOptions.TAMIL_DIGITS DigitsTypeOptions.TELUGU_DIGITS DigitsTypeOptions.KANNADA_DIGITS DigitsTypeOptions.MALAYALAM_DIGITS DigitsTypeOptions.TIBETAN_DIGITS DigitsTypeOptions.KHMER_DIGITS DigitsTypeOptions.BURMESE_DIGITS |
r/w | The digits type. |
| dropCapCharacters | number | r/w | Number of characters for drop cap. |
| dropCapLines | number | r/w | Number of lines for drop cap. |
| dropCapStyle | CharacterStyle String |
r/w | The character style to apply to the drop cap. Can also accept: String. |
| fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can also accept: String. |
| fillTint | number | 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.) |
| firstLineIndent | Measurement Unit (Number or String) | r/w | The amount to indent the first line. |
| fontStyle | string | r/w | The name of the font style. |
| gradientFillAngle | number | r/w | The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180) |
| gradientFillLength | number | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. |
| gradientFillStart | Array of Measurement Unit (Number or String) | r/w | The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. |
| gradientStrokeAngle | number | r/w | The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180) |
| gradientStrokeLength | number | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. |
| gradientStrokeStart | Array of Measurement Unit (Number or String) | r/w | The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. |
| gridAlignFirstLineOnly | bool | r/w | If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid. |
| horizontalScale | number | r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| hyphenWeight | number | r/w | Hyphen weight. |
| hyphenateAfterFirst | number | r/w | Hyphenate after this many letters. |
| hyphenateBeforeLast | number | r/w | Hyphenate before this many letters. |
| hyphenateCapitalizedWords | bool | r/w | If true, allows hyphenation of capitalized words. |
| hyphenateLadderLimit | number | r/w | Number of consecutive hyphens to allow. |
| hyphenateLastWord | bool | r/w | If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. |
| hyphenateWordsLongerThan | number | r/w | Hyphenate words that have more than this number of letters. |
| hyphenation | bool | r/w | If true, allows hyphenation. |
| hyphenationZone | Measurement Unit (Number or String) | r/w | The amount of white space allowed at the end of a line of non-justified text before hypenation begins. Note: Valid when composer is single-line composer. |
| justification | Justification: Justification.LEFT_ALIGN Justification.CENTER_ALIGN Justification.RIGHT_ALIGN Justification.LEFT_JUSTIFIED Justification.RIGHT_JUSTIFIED Justification.CENTER_JUSTIFIED Justification.FULLY_JUSTIFIED Justification.TO_BINDING_SIDE Justification.AWAY_FROM_BINDING_SIDE |
r/w | The paragraph alignment. |
| kashidas | KashidasOptions: KashidasOptions.DEFAULT_KASHIDAS KashidasOptions.KASHIDAS_OFF |
r/w | Use of Kashidas for justification |
| keepAllLinesTogether | bool | r/w | If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. |
| keepFirstLines | number | r/w | Keep at least this many lines together at the end of a column. |
| keepLastLines | number | r/w | Keep at least this many lines together at the start of a column. |
| keepLinesTogether | bool | r/w | If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. |
| keepWithNext | number | r/w | Keep at least this many lines together with the following paragraph. |
| kerningMethod | string | r/w | The type of pair kerning. |
| keyboardDirection | CharacterDirectionOptions: CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION |
r/w | The keyboard direction of the character. |
| lastLineIndent | Measurement Unit (Number or String) | r/w | The amount to indent the last line in the paragraph. |
| leading | Leading Unit |
r/w | The leading applied to the text. Can return: Unit or Leading enumerator. |
| leftIndent | Measurement Unit (Number or String) | r/w | The width of the left indent. |
| ligatures | bool | r/w | If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. |
| maximumGlyphScaling | number | r/w | The maximum width (as a percentage) of individual characters. (Range: 50 to 200) |
| maximumLetterSpacing | number | r/w | The maximum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified. |
| maximumWordSpacing | number | r/w | The maximum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000) |
| minimumGlyphScaling | number | r/w | The minimum width (as a percentage) of individual characters. (Range: 50 to 200) |
| minimumLetterSpacing | number | r/w | The minimum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified. |
| minimumWordSpacing | number | r/w | The minimum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000) |
| nestedStyles | NestedStyles | readonly | A collection of nested styles. |
| noBreak | bool | r/w | If true, keeps the text on the same line. |
| numberSeparator | number | r/w | The numbering separator as a unicode ID. |
| numberStartAt | number | r/w | Starting number in a numbered list. |
| numberingFont | AutoEnum Font String |
r/w | Font of the number character. Can return: Font, String or AutoEnum enumerator. |
| numberingFontStyle | AutoEnum NothingEnum String |
r/w | Font style of the number character. Can return: String, NothingEnum enumerator or AutoEnum enumerator. |
| numberingStyle | NumberingStyle String |
r/w | Numbering style. Can return: NumberingStyle enumerator or String. |
| otfContextualAlternate | bool | r/w | If true, uses contextual alternate forms in OpenType fonts. |
| otfDiscretionaryLigature | bool | r/w | If true, uses discretionary ligatures in OpenType fonts. |
| otfFigureStyle | OTFFigureStyle: OTFFigureStyle.TABULAR_LINING OTFFigureStyle.PROPORTIONAL_OLDSTYLE OTFFigureStyle.PROPORTIONAL_LINING OTFFigureStyle.TABULAR_OLDSTYLE OTFFigureStyle.DEFAULT_VALUE |
r/w | The figure style in OpenType fonts. |
| otfFraction | bool | r/w | If true, uses fractions in OpenType fonts. |
| otfHistorical | bool | r/w | If true, use historical forms in OpenType fonts. |
| otfJustificationAlternate | bool | r/w | If true, use alternate justification forms in OpenType fonts |
| otfOrdinal | bool | r/w | If true, uses ordinals in OpenType fonts. |
| otfOverlapSwash | bool | r/w | If true, use overlapping swash forms in OpenType fonts |
| otfSlashedZero | bool | r/w | If true, use a slashed zeroes in OpenType fonts. |
| otfStretchedAlternate | bool | r/w | If true, use stretched alternate forms in OpenType fonts |
| otfStylisticAlternate | bool | r/w | If true, use stylistic alternate forms in OpenType fonts |
| otfStylisticSets | number | r/w | The stylistic sets to use in OpenType fonts. |
| otfSwash | bool | r/w | If true, uses swash forms in OpenType fonts. |
| otfTitling | bool | r/w | If true, uses titling forms in OpenType fonts. |
| overprintFill | bool | r/w | If true, the fill color of the characters will overprint. |
| overprintStroke | bool | r/w | If true, the stroke of the characters will overprint. |
| paragraphDirection | ParagraphDirectionOptions: ParagraphDirectionOptions.LEFT_TO_RIGHT_DIRECTION ParagraphDirectionOptions.RIGHT_TO_LEFT_DIRECTION |
r/w | Paragraph direction. |
| paragraphJustification | ParagraphJustificationOptions: ParagraphJustificationOptions.DEFAULT_JUSTIFICATION ParagraphJustificationOptions.ARABIC_JUSTIFICATION ParagraphJustificationOptions.NASKH_JUSTIFICATION |
r/w | Paragraph justification. |
| parent | Application Document |
readonly | The parent of the TextDefault (a Application or Document). |
| pointSize | Measurement Unit (Number or String) | r/w | The text size. |
| position | Position: Position.NORMAL Position.SUPERSCRIPT Position.SUBSCRIPT Position.OT_SUPERSCRIPT Position.OT_SUBSCRIPT Position.OT_NUMERATOR Position.OT_DENOMINATOR |
r/w | The text position relative to the baseline. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rightIndent | Measurement Unit (Number or String) | r/w | The width of the right indent. |
| ruleAbove | bool | r/w | If true, places a rule above the paragraph. |
| ruleAboveColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String. |
| ruleAboveGapColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule above. Note: Valid only when the paragraph rule above type is not solid. Can return: Swatch or String. |
| ruleAboveGapOverprint | bool | r/w | If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid. |
| ruleAboveGapTint | number | r/w | The tint (as a percentage) of the stroke gap color of the paragraph rule. (Range: 0 to 100) Note: Valid only when the rule above type is not solid. |
| ruleAboveLeftIndent | Measurement Unit (Number or String) | r/w | The distance to indent the left edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph. |
| ruleAboveLineWeight | number | r/w | The stoke weight of the paragraph rule above. |
| ruleAboveOffset | Measurement Unit (Number or String) | r/w | The amount to offset the paragraph rule above from the baseline of the first line the paragraph. |
| ruleAboveOverprint | bool | r/w | If true, the paragraph rule above will overprint. |
| ruleAboveRightIndent | Measurement Unit (Number or String) | r/w | The distance to indent the right edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph. |
| ruleAboveTint | number | r/w | The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) |
| ruleAboveType | String StrokeStyle |
r/w | The stroke type of the rule above the paragraph. Can return: StrokeStyle or String. |
| ruleAboveWidth | RuleWidth: RuleWidth.TEXT_WIDTH RuleWidth.COLUMN_WIDTH |
r/w | The basis (text width or column width) used to calculate the width of the paragraph rule above. |
| ruleBelow | bool | r/w | If true, applies a paragraph rule below. |
| ruleBelowColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String. |
| ruleBelowGapColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule below. Note: Valid only when the paragraph rule below type is not solid. Can return: Swatch or String. |
| ruleBelowGapOverPrint | bool | r/w | If true, overprint the paragraph rule below stroke gap color. |
| ruleBelowGapTint | number | r/w | The tint (as a percentage) of the stroke gap color of the paragraph rule below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type is not solid. |
| ruleBelowLeftIndent | Measurement Unit (Number or String) | r/w | The distance to indent the left edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph. |
| ruleBelowLineWeight | number | r/w | The stroke weight of the paragraph rule below. |
| ruleBelowOffset | Measurement Unit (Number or String) | r/w | The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph. |
| ruleBelowOverPrint | bool | r/w | If true, overprint the paragraph rule below. |
| ruleBelowRightIndent | Measurement Unit (Number or String) | r/w | The distance to indent the right edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph. |
| ruleBelowTint | number | r/w | The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) |
| ruleBelowType | String StrokeStyle |
r/w | The stroke type of the rule below the paragraph. Can return: StrokeStyle or String. |
| ruleBelowWidth | RuleWidth: RuleWidth.TEXT_WIDTH RuleWidth.COLUMN_WIDTH |
r/w | The basis (text width or column width) used to calculate the width of the paragraph rule below. |
| singleWordJustification | SingleWordJustification: SingleWordJustification.LEFT_ALIGN SingleWordJustification.CENTER_ALIGN SingleWordJustification.RIGHT_ALIGN SingleWordJustification.FULLY_JUSTIFIED |
r/w | The alignment to use for lines that contain a single word. |
| skew | number | r/w | The skew angle of the text. (Range: -85 to 85) |
| spaceAfter | Measurement Unit (Number or String) | r/w | The height of the paragraph space below. |
| spaceBefore | Measurement Unit (Number or String) | r/w | The height of the paragraph space above. |
| startParagraph | StartParagraph: StartParagraph.ANYWHERE StartParagraph.NEXT_COLUMN StartParagraph.NEXT_FRAME StartParagraph.NEXT_PAGE StartParagraph.NEXT_ODD_PAGE StartParagraph.NEXT_EVEN_PAGE |
r/w | The location at which to start the paragraph. |
| strikeThroughColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String. |
| strikeThroughGapColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String. |
| strikeThroughGapOverprint | bool | r/w | If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. |
| strikeThroughGapTint | number | 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. |
| strikeThroughOffset | Measurement Unit (Number or String) | r/w | The amount by which to offset the strikethrough stroke from the text baseline. |
| strikeThroughOverprint | bool | r/w | If true, the strikethrough stroke will overprint. |
| strikeThroughTint | number | r/w | The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) |
| strikeThroughType | String StrokeStyle |
r/w | The stroke type of the strikethrough stroke. Can return: StrokeStyle or String. |
| strikeThroughWeight | Measurement Unit (Number or String) | r/w | The stroke weight of the strikethrough stroke. |
| strikeThru | bool | r/w | If true, draws a strikethrough line through the text. |
| strokeColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can also accept: String. |
| strokeTint | number | 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.) |
| strokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight applied to the characters of the text. |
| tabList |
Array
of Arrays of Property Name/Value Pairs |
r/w | A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs. |
| tabStops | TabStops | readonly | A collection of tab stops. |
| tracking | number | r/w | The amount by which to loosen or tighten a block of text, specified in thousands of an em. |
| underline | bool | r/w | If true, underlines the text. |
| underlineColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String. |
| underlineGapColor | 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 or String. |
| underlineGapOverprint | bool | r/w | If true, the gap color of the underline stroke will overprint. |
| underlineGapTint | number | 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. |
| underlineOffset | Measurement Unit (Number or String) | r/w | The amount by which to offset the underline from the text baseline. |
| underlineOverprint | bool | r/w | If true, the underline stroke color will overprint. |
| underlineTint | number | r/w | The underline stroke tint (as a percentage). (Range: 0 to 100) |
| underlineType | String StrokeStyle |
r/w | The stroke type of the underline stroke. Can return: StrokeStyle or String. |
| underlineWeight | Measurement Unit (Number or String) | r/w | The stroke weight of the underline stroke. |
| verticalScale | number | r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| xOffsetDiacritic | number | r/w | The x (horizontal) offset for diacritic adjustment. |
| yOffsetDiacritic | number | r/w | The y (vertical) offset for diacritic adjustment. |
Methods
Instances
Array
of Object getElements ()
Resolves the object specifier, creating an array of object references.
string toSource ()
Generates a string which, if executed, will return the TextDefault.
Element of
Application.textDefaults
Document.textDefaults
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |