Adobe InDesign CS (3.0) Object Model JS: TextDefault

InDesign CS

Class

TextDefault

 Text defaults.

Hierarchy

Application | Document
TextDefault
Bullet | NestedStyle | TabStop

Properties

PropertyTypeAccessDescription
alignToBaselinebool r/wIf true, aligns the baseline of the text to the baseline grid.
appliedCharacterStyleCharacterStyleString r/wThe character style applied to the text. Can also accept: String.
appliedFontFont
String
r/wThe font applied to the text, specified as either a font object or the name of font family. Can return: Font or String.
appliedLanguageLanguage
String
r/wThe language of the text. Can also accept: String.
appliedParagraphStyleParagraphStyle
String
r/wThe paragraph style applied to the text. Can also accept: String.
autoLeadingnumber r/wThe percent of the type size to use for auto leading. (Range: 0 to 500).
balanceRaggedLinesbool r/wIf true, balance ragged lines.
baselineShiftnumber r/wThe vertical distance by which to offset the text from the baseline.
bulletCharBullet readonlyBullet character.
bulletsAndNumberingColorBnautocolor
String
Swatch
r/wDetermines color of bullet or number character. Can return: Bnautocolor enumerator or Swatch. Can also accept: String.
bulletsAndNumberingFontBnautofont
Font
String
r/wBullets and numbering font. Can return: Font, String or Bnautofont enumerator.
bulletsAndNumberingFontStyleBnautofontstyle
String
r/wDetermines bullets and numbering font style. Can return: Bnautofontstyle enumerator or String.
bulletsAndNumberingListTypeListtype:
Listtype.NO_LIST
Listtype.BULLET_LIST
Listtype.NUMBERED_LIST
r/wList type for bullets and numbering.
bulletsAndNumberingSizeBnautosize
Real
r/wDetermines point size of bullet or number character. Can return: Bnautosize enumerator or Real.
capitalizationCapitalization:
Capitalization.NORMAL
Capitalization.SMALL_CAPS
Capitalization.ALL_CAPS
Capitalization.CAP_TO_SMALL_CAP
r/wThe capitalization scheme.
characterDirectionCharacterDirectionOptions:
CharacterDirectionOptions.DEFAULT_DIRECTION
CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION
CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION
r/wThe direction of the character.
composerstring r/wThe text composer to use to compose the text.
desiredGlyphScalingnumber r/wThe desired width (as a percentage) of individual characters. (Range: 50 to 200)
desiredLetterSpacingnumber r/wThe desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500)
desiredWordSpacingnumber r/wThe desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)
diacriticPositionDiacriticPositionOptions:
DiacriticPositionOptions.DEFAULT_POSITION
DiacriticPositionOptions.LOOSE_POSITION
DiacriticPositionOptions.MEDIUM_POSITION
DiacriticPositionOptions.TIGHT_POSITION
DiacriticPositionOptions.OPENTYPE_POSITION
r/wPosition of diacriticical characters.
digitsTypeDigitsTypeOptions:
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/wThe digits type.
dropCapCharactersnumber r/wNumber of characters for drop cap.
dropCapLinesnumber r/wNumber of lines for drop cap.
dropCapStyleCharacterStyle
String
r/wThe character style to apply to the drop cap. Can also accept: String.
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can also accept: String.
fillTintnumber 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.)
firstLineIndentMeasurement Unit (Number or String) r/wThe amount to indent the first line.
fontStylestring r/wThe name of the font style.
gradientFillAnglenumber r/wThe angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)
gradientFillLengthnumber r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.
gridAlignFirstLineOnlybool r/wIf true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid.
horizontalScalenumber r/wThe horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
hyphenWeightnumber r/wHyphen weight.
hyphenateAfterFirstnumber r/wHyphenate after this many letters.
hyphenateBeforeLastnumber r/wHyphenate before this many letters.
hyphenateCapitalizedWordsbool r/wIf true, allows hyphenation of capitalized words.
hyphenateLadderLimitnumber r/wNumber of consecutive hyphens to allow.
hyphenateWordsLongerThannumber r/wHyphenate words that have more than this number of letters.
hyphenationbool r/wIf true, allows hyphenation.
hyphenationZoneMeasurement Unit (Number or String) r/wThe 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.
justificationJustification:
Justification.LEFT_ALIGN
Justification.CENTER_ALIGN
Justification.RIGHT_ALIGN
Justification.LEFT_JUSTIFIED
Justification.RIGHT_JUSTIFIED
Justification.CENTER_JUSTIFIED
Justification.FULLY_JUSTIFIED
r/wThe paragraph alignment.
kashidasKashidasOptions:
KashidasOptions.DEFAULT_KASHIDAS
KashidasOptions.KASHIDAS_OFF
r/wUse of Kashidas for justification
keepAllLinesTogetherbool r/wIf true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.
keepFirstLinesnumber r/wKeep at least this many lines together at the end of a column.
keepLastLinesnumber r/wKeep at least this many lines together at the start of a column.
keepLinesTogetherbool r/wIf true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.
keepWithNextnumber r/wKeep at least this many lines together with the following paragraph.
kerningMethodstring r/wThe type of pair kerning.
kerningValuenumber r/wThe amount of space to add or remove between characters, specified in thousands of an em.
keyboardDirectionCharacterDirectionOptions:
CharacterDirectionOptions.DEFAULT_DIRECTION
CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION
CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION
r/wThe keyboard direction of the character.
leadingLeading
Real
r/wThe leading amount. Can return: Real or Leading enumerator.
leftIndentMeasurement Unit (Number or String) r/wThe width of the left indent.
ligaturesbool r/wIf true, replaces specific character combinations (e.g., fl, fi) with ligature characters.
maximumGlyphScalingnumber r/wThe maximum width (as a percentage) of individual characters. (Range: 50 to 200)
maximumLetterSpacingnumber r/wThe 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.
maximumWordSpacingnumber r/wThe maximum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)
minimumGlyphScalingnumber r/wThe minimum width (as a percentage) of individual characters. (Range: 50 to 200)
minimumLetterSpacingnumber r/wThe 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.
minimumWordSpacingnumber r/wThe minimum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)
nestedStylesNestedStyles readonlyA collection of nested styles.
noBreakbool r/wIf true, keeps the text on the same line.
numberSeparatornumber r/wThe numbering separator as a unicode ID.
numberStartAtnumber r/wStarting number in a numbered list.
numberingStyleNumberingStyle
String
r/wNumbering style. Can return: NumberingStyle enumerator or String.
otfContextualAlternatebool r/wIf true, uses contextual alternate forms in OpenType fonts.
otfDiscretionaryLigaturebool r/wIf true, uses discretionary ligatures in OpenType fonts.
otfFigureStyleOTFFigureStyle:
OTFFigureStyle.TABULAR_LINING
OTFFigureStyle.PROPORTIONAL_OLDSTYLE
OTFFigureStyle.PROPORTIONAL_LINING
OTFFigureStyle.TABULAR_OLDSTYLE
OTFFigureStyle.DEFAULT_VALUE
r/wThe figure style in OpenType fonts.
otfFractionbool r/wIf true, uses fractions in OpenType fonts.
otfJustificationAlternatebool r/wIf true, use alternate justification forms in OpenType fonts
otfOrdinalbool r/wIf true, uses ordinals in OpenType fonts.
otfOverlapSwashbool r/wIf true, use overlapping swash forms in OpenType fonts
otfStretchedAlternatebool r/wIf true, use stretched alternate forms in OpenType fonts
otfStylisticAlternatebool r/wIf true, use stylistic alternate forms in OpenType fonts
otfSwashbool r/wIf true, uses swash forms in OpenType fonts.
otfTitlingbool r/wIf true, uses titling forms in OpenType fonts.
overprintFillbool r/wIf true, the fill color of the characters will overprint.
overprintStrokebool r/wIf true, the stroke of the characters will overprint.
paragraphDirectionParagraphDirectionOptions:
ParagraphDirectionOptions.LEFT_TO_RIGHT_DIRECTION
ParagraphDirectionOptions.RIGHT_TO_LEFT_DIRECTION
r/wParagraph direction.
paragraphJustificationParagraphJustificationOptions:
ParagraphJustificationOptions.DEFAULT_JUSTIFICATION
ParagraphJustificationOptions.ARABIC_JUSTIFICATION
ParagraphJustificationOptions.NASKH_JUSTIFICATION
r/wParagraph justification.
parentApplication
Document
readonlyThe parent of the TextDefault (a Application or Document).
pointSizenumber r/wThe size of the text in points
positionPosition:
Position.NORMAL
Position.SUPERSCRIPT
Position.SUBSCRIPT
Position.OT_SUPERSCRIPT
Position.OT_SUBSCRIPT
Position.OT_NUMERATOR
Position.OT_DENOMINATOR
r/wThe text position relative to the baseline.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightIndentMeasurement Unit (Number or String) r/wThe width of the right indent.
ruleAbovebool r/wIf true, places a rule above the paragraph.
ruleAboveColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.
ruleAboveGapColorString
Swatch
r/wThe 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.
ruleAboveGapOverprintbool r/wIf true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid.
ruleAboveGapTintnumber r/wThe 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.
ruleAboveLeftIndentMeasurement Unit (Number or String) r/wThe 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.
ruleAboveLineWeightnumber r/wThe stoke weight of the paragraph rule above.
ruleAboveOffsetMeasurement Unit (Number or String) r/wThe amount to offset the paragraph rule above from the baseline of the first line the paragraph.
ruleAboveOverprintbool r/wIf true, the paragraph rule above will overprint.
ruleAboveRightIndentMeasurement Unit (Number or String) r/wThe 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.
ruleAboveTintnumber r/wThe tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)
ruleAboveTypeStrokeStyle r/wThe stroke type of the paragraph rule above.
ruleAboveWidthRuleWidth:
RuleWidth.TEXT_WIDTH
RuleWidth.COLUMN_WIDTH
r/wThe basis (text width or column width) used to calculate the width of the paragraph rule above.
ruleBelowbool r/wIf true, applies a paragraph rule below.
ruleBelowColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.
ruleBelowGapColorString
Swatch
r/wThe 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.
ruleBelowGapOverPrintbool r/wIf true, overprint the paragraph rule below stroke gap color.
ruleBelowGapTintnumber r/wThe 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.
ruleBelowLeftIndentMeasurement Unit (Number or String) r/wThe 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.
ruleBelowLineWeightnumber r/wThe stroke weight of the paragraph rule below.
ruleBelowOffsetMeasurement Unit (Number or String) r/wThe amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.
ruleBelowOverPrintbool r/wIf true, overprint the paragraph rule below.
ruleBelowRightIndentMeasurement Unit (Number or String) r/wThe 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.
ruleBelowTintnumber r/wThe tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)
ruleBelowTypeStrokeStyle r/wThe stroke type of the paragraph rule below.
ruleBelowWidthRuleWidth:
RuleWidth.TEXT_WIDTH
RuleWidth.COLUMN_WIDTH
r/wThe basis (text width or column width) used to calculate the width of the paragraph rule below.
singleWordJustificationSingleWordJustification:
SingleWordJustification.LEFT_ALIGN
SingleWordJustification.CENTER_ALIGN
SingleWordJustification.RIGHT_ALIGN
SingleWordJustification.FULLY_JUSTIFIED
r/wThe alignment to use for lines that contain a single word.
skewnumber r/wThe skew angle of the text. (Range: -85 to 85)
spaceAfterMeasurement Unit (Number or String) r/wThe height of the paragraph space below.
spaceBeforeMeasurement Unit (Number or String) r/wThe height of the paragraph space above.
startParagraphStartParagraph:
StartParagraph.ANYWHERE
StartParagraph.NEXT_COLUMN
StartParagraph.NEXT_FRAME
StartParagraph.NEXT_PAGE
StartParagraph.NEXT_ODD_PAGE
StartParagraph.NEXT_EVEN_PAGE
r/wThe location at which to start the paragraph.
strikeThroughColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapOverprintbool r/wIf true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.
strikeThroughGapTintnumber 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.
strikeThroughOffsetMeasurement Unit (Number or String) r/wThe amount by which to offset the strikethrough stroke from the text baseline.
strikeThroughOverprintbool r/wIf true, the strikethrough stroke will overprint.
strikeThroughTintnumber r/wThe tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)
strikeThroughTypeStrokeStyle r/wThe stroke type of the strike through
strikeThroughWeightnumber r/wThe stroke weight of the strikethrough.
strikeThrubool r/wIf true, draws a strikethrough line through the text.
strokeColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can also accept: String.
strokeTintnumber 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.)
strokeWeightnumber r/wThe stroke weight (in points) to apply to the stroke of the text
tabList Array of
Arrays of Property Name/Value Pairs
r/wA list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs.
tabStopsTabStops readonlyA collection of tab stops.
trackingnumber r/wThe amount by which to loosen or tighten a block of text, specified in thousands of an em.
underlinebool r/wIf true, underlines the text.
underlineColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.
underlineGapColorString
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 or String.
underlineGapOverprintbool r/wIf true, the gap color of the underline stroke will overprint.
underlineGapTintnumber 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.
underlineOffsetMeasurement Unit (Number or String) r/wThe amount by which to offset the underline from the text baseline.
underlineOverprintbool r/wIf true, the underline stroke color will overprint.
underlineTintnumber r/wThe underline stroke tint (as a percentage). (Range: 0 to 100)
underlineTypeStrokeStyle r/wThe stroke type of the underline
underlineWeightnumber r/wThe underline stroke weight.
verticalScalenumber r/wThe vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
xOffsetDiacriticnumber r/wThe x (horizontal) offset for diacritic adjustment.
yOffsetDiacriticnumber r/wThe y (vertical) offset for diacritic adjustment.

Element of

Application.textDefaults

Document.textDefaults

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