TextStyleRange

A text style range (a continuous range of identical formatting attributes).

TextStyleRange Properties

Property Type Access Description
alignToBaseline Boolean r/w If true, align the baseline to the baseline grid.
allGraphics Array of Graphics read All graphics contained by the object.
allPageItems Array of PageItems read All page items contained by the object.
appliedCharacterStyle CharacterStyle, String r/w The character style applied to the object.
appliedFont Font, String r/w The applied font. Either a font object or the name of font family.
appliedLanguage LanguageWithVendors, Language, String r/w The language dictionary appled to the object.
appliedParagraphStyle ParagraphStyle, String r/w The applied paragraph style.
ascent Unit read The maximum ascent of any character in the object.
associatedXMLElements Array of XMLItems read The XML elements associated with the object.
autoLeading Real r/w Percentage used for calculating auto leading.
balanceRaggedLines Boolean, BalanceLinesStyle enumeration r/w If true, or set to one of the enumerations, apply ragged line balancing to the paragraph containing the object.
baseline Unit read The vertical position of the baseline on the page, relative to the ruler zero point.
baselineShift Unit r/w The amount of baseline shift applied to the object.
bulletChar Bullet read The bullet character used when a bullet is applied to the paragraph containing the object.
bulletsAndNumberingColor AutoEnum enumeration, Swatch, String r/w The color of the bullet or numbering.
bulletsAndNumberingListType ListType enumeration r/w The list type to use for bullets and numbering.
bulletsAndNumberingSize AutoEnum enumeration, Real r/w The point size of the bullet or numbering.
buttons Buttons read The buttons contained by the object.
capitalization Capitalization enumeration r/w The capitalization applied to the object.
characters Characters read The characters of the object.
composer String r/w The applied text composer.
contents String, SpecialCharacters enumeration (see table at end of chapter) r/w The text contents.
descent Unit read The maximum descent of any character in the object.
desiredGlyphScaling Real r/w The desired percentage of glyph scaling.
desiredLetterSpacing Real r/w The desired percentage of letter spacing.
desiredWordSpacing Real r/w The desired percentage of word spacing.
dropCapCharacters Short r/w The number of characters for a drop cap.
dropCapLines Short r/w The number of lines for drop cap.
dropCapStyle CharacterStyle, String r/w The character style for a drop cap.
fillColor Swatch, String r/w The fill of the object.
fillTint Real r/w The tint percentage applied to the fill of the object (-1 indicates 100%).
firstLineIndent Unit r/w The first line indent.
fontStyle String r/w The name of the applied font style.
footnotes Footnotes read The footnotes contained by the object.
formFields FormFields read The form fields contained by the object.
gradientFillAngle Real r/w The angle of the gradient applied to the fill of the object.
gradientFillLength Real r/w Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the fill of the object.
gradientFillStart Array of 2 Units r/w Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the fill of the object.
gradientStrokeAngle Real r/w The angle of the gradient applied to the stroke of the object.
gradientStrokeLength Real r/w Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the stroke of the object.
gradientStrokeStart Array of 2 Units r/w Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the stroke of the object.
graphicLines GraphicLines read The graphic lines contained by the object.
gridAlignFirstLineOnly Boolean r/w If true, only the first line of the object will be aligned to the frame grid or baseline grid.
groups Groups read The groups contained by the object.
horizontalOffset Unit read The horizontal position of the baseline on the page, relative to the ruler zero point.
horizontalScale Real r/w The horizontal scaling percentage applied to the object, including the scaling applied to its containing object(s).
hyphenateAfterFirst Short r/w Hyphenate after this many letters.
hyphenateBeforeLast Short r/w Hyphenate before this many letters.
hyphenateCapitalizedWords Boolean r/w If true, hyphenate capitalized words.
hyphenateLadderLimit Short r/w The number of consecutive hyphens allowed.
hyphenateLastWord Boolean r/w If true, allow hyphenation for the last word of the paragraph.
hyphenateWordsLongerThan Short r/w Disallow hyphenation for words shorter than this length (in characters).
hyphenation Boolean r/w If true, hyphenation is on.
hyphenationZone Unit r/w The width of the hyphenation zone.
hyphenWeight Short r/w An value (from 1 to 11) that denotes the relative desirability of hyphenation in composing the text. Lower values result in greater use of hyphenation; higher values result in greater variation of spacing between lines of text.
index Long read Index of the object within its parent object.
insertionPoints InsertionPoints read The insertion points in the object.
justification Justification enumeration r/w The alignment applied to the paragraph.
keepAllLinesTogether Boolean r/w If true, to keep all lines of the paragraph together.
keepFirstLines Short r/w If the paragraph has to break across text columns or text frames, do not leave fewer than this number of lines at the beginning of the paragraph.
keepLastLines Short r/w If the paragraph has to break across text columns or text frames, do not leave fewer than this number of lines at the end of the paragraph.
keepLinesTogether Boolean r/w If true, use the settings for KeepAllLinesTogether, KeepFirstLines, and KeepLastLines.
keepWithNext Short r/w If this value is set to zero, allow a page break, column break, or frame break between this paragraph and the following paragraph. If the paragraph following this paragraph has to break across text columns or text frames, keep this paragraph with at least this number of lines of the following paragraph.
kerningMethod String r/w The type of kerning (Optical, Metrics or None).
kerningValue Real r/w The amount of kerning.
lastLineIndent Unit r/w The last line indent.
leading Unit, Leading enumeration r/w The applied leading.
leftIndent Unit r/w The left indent.
length Long read The number of characters in the object.
ligatures Boolean r/w If true, use automatic ligature replacement characters.
lines Lines read The lines of text in the object.
maximumGlyphScaling Real r/w The maximum percentage of glyph scaling.
maximumLetterSpacing Real r/w The maximum percentage of letter spacing.
maximumWordSpacing Real r/w The maximum percentage of word spacing.
minimumGlyphScaling Real r/w The minimum percentage of glyph scaling.
minimumLetterSpacing Real r/w The minimum percentage of letter spacing.
minimumWordSpacing Real r/w The minimum percentage of word spacing.
nestedStyles NestedStyles read The nested styles applied to the object.
noBreak Boolean r/w If true, do not break the text across lines.
notes Notes read Every note.
numberingFont Font, String, AutoEnum enumeration r/w The font applied to numbering.
numberingFontStyle String, NothingEnum enumeration, AutoEnum enumeration r/w The font style applied to numbering.
numberingStyle NumberingStyle enumeration, String r/w The numbering style.
numberSeparator Short r/w The numbering separator character.
numberStartAt Long r/w The starting number for a numbered list.
opentypeFeatures Array of 2 Strings or Longs r/w OpenType features available in the applied font.
otfContextualAlternate Boolean r/w If true, use contextual alternate forms in OpenType fonts.
otfDiscretionaryLigature Boolean r/w If true, use discretionary ligatures in OpenType fonts.
otfFigureStyle OTFFigureStyle enumeration r/w The figure style to use in OpenType fonts.
otfFraction Boolean r/w If true, use fractions in OpenType fonts.
otfHistorical Boolean r/w If true, use historical forms in OpenType fonts.
otfOrdinal Boolean r/w If true, use ordinals in OpenType fonts.
otfSlashedZero Boolean r/w If true, use a zero with slash in OpenType fonts.
otfStylisticSets Long r/w Stylistic sets to use in OpenType fonts.
otfSwash Boolean r/w If true, use swash forms in OpenType fonts.
otfTitling Boolean r/w If true, use titling forms in OpenType fonts.
ovals Ovals read All ovals contained by the object.
overprintFill Boolean r/w If true, the fill of the object will overprint.
overprintStroke Boolean r/w If true, the storke of the object will overprint.
pageItems PageItems read The page items contained by the object.
paragraphs Paragraphs read The paragraphs contained by the object.
parent Object read The parent of the object.
parentStory Story read The story containing the object.
parentTextFrames TextFrame, TextPath read The text frame(s) containing the object.
pointSize Unit r/w The point size of the text.
polygons Polygons read The polygons contained by the object.
position Position enumeration r/w The position (e.g., superscript or subscript) of the object.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
rectangles Rectangles read The rectangles contained by the object.
rightIndent Unit r/w The right indent.
ruleAbove Boolean r/w If true, apply a paragraph rule above.
ruleAboveColor Swatch, String r/w The color of the paragraph rule above.
ruleAboveGapColor Swatch, String r/w The color applied to the gap of the rule above.
ruleAboveGapOverprint Boolean r/w If true, overprint the rule above gap color.
ruleAboveGapTint Real r/w The tint applied to the rule above gap color (-1 represents 100%).
ruleAboveLeftIndent Unit r/w The left indent of the rule above.
ruleAboveLineWeight Real r/w The stroke weight of the rule above.
ruleAboveOffset Unit r/w The offset of the rule above from the baseline of the first line in the paragraph.
ruleAboveOverprint Boolean r/w If true, overprint the rule above.
ruleAboveRightIndent Unit r/w The right indent of the rule above.
ruleAboveTint Real r/w The tint applied to the the rule above (-1 represents 100%).
ruleAboveType StrokeStyle, String r/w The stroke style applied to the rule above.
ruleAboveWidth RuleWidth enumeration r/w When this value is set to column width, the width of the rule above is based on the width of the column; when this value is set to text width, the width of the rule above is based on the width of the first line of text in the paragraph.
ruleBelow Boolean r/w If true, apply a paragraph rule below.
ruleBelowColor Swatch, String r/w The color of the paragraph below above.
ruleBelowGapColor Swatch, String r/w The color applied to the gap of the rule below.
ruleBelowGapOverPrint Boolean r/w If true, overprint the rule below gap color.
ruleBelowGapTint Real r/w The tint applied to the rule below gap color (-1 represents 100%).
ruleBelowLeftIndent Unit r/w The left indent of the rule below.
ruleBelowLineWeight Real r/w The stroke weight of the rule below.
ruleBelowOffset Unit r/w The offset of the rule below from the baseline of the last line in the paragraph.
ruleBelowOverPrint Boolean r/w If true, overprint the rule below.
ruleBelowRightIndent Unit r/w The right indent of the rule below.
ruleBelowTint Real r/w The tint applied to the the rule below (-1 represents 100%).
ruleBelowType StrokeStyle, String r/w The stroke style applied to the rule below.
ruleBelowWidth RuleWidth enumeration r/w When this value is set to column width, the width of the rule above is based on the width of the column; when this value is set to text width, the width of the rule above is based on the width of the first line of text in the paragraph.
singleWordJustification SingleWordJustification enumeration r/w Alignment applied to lines containing a single word.
skew Real r/w The angle of the skew for the text.
spaceAfter Unit r/w Paragraph space after.
spaceBefore Unit r/w Paragraph space before.
startParagraph StartParagraph enumeration r/w When this property is set to anything other than start anywhere, apply a column or page break before the paragraph.
strikeThroughColor Swatch, String r/w The color of the strikethrough.
strikeThroughGapColor Swatch, String r/w The gap color of the strikethrough.
strikeThroughGapOverprint Boolean r/w If true, overprint the gap of the strikethrough.
strikeThroughGapTint Real r/w The tint percentage applied to the gap of the strikethrough (-1 represents 100%).
strikeThroughOffset Unit r/w The offset of the strikethrough from the baseline.
strikeThroughOverprint Boolean r/w If true, overprint the strikethrough.
strikeThroughTint Real r/w The tint percentage applied to stroke color of the strikethrough.
strikeThroughType StrokeStyle, String r/w The stroke style of the strikethrough.
strikeThroughWeight Unit r/w The stroke weight of the strikethrough.
strikeThru Boolean r/w If true, apply a strikethrough to the text.
strokeColor Swatch, String r/w The stroke color of the object.
strokeTint Real r/w The tint percentage applied to the stroke (-1 indicates 100%).
strokeWeight Unit r/w The stroke weight (thickness) of the stroke.
tables Tables read The tables contained by the object.
tabList An array of property names and values r/w A list of all of the properties of all of the tab stops on this object.
tabStops TabStops read The tab stops applied to the object.
textColumns TextColumns read The text columns contained by the object.
textFrames TextFrames read The text frames contained by the object.
texts Texts read The texts contained by the object.
textStyleRanges TextStyleRanges read The text style ranges contained by the object.
tracking Real r/w The tracking (range kerning) applied to the object.
underline Boolean r/w If true, apply an underline to the text.
underlineColor Swatch, String r/w The color of the underline.
underlineGapColor Swatch, String r/w The gap color of the underline.
underlineGapOverprint Boolean r/w If true, overprint the gap of the underline.
underlineGapTint Real r/w The tint percentage applied to the gap of the underline (-1 represents 100%).
underlineOffset Unit r/w The offset of the underline from the baseline.
underlineOverprint Boolean r/w If true, overprint the underline.
underlineTint Real r/w The tint percentage applied to the underline (-1 represents 100%).
underlineType StrokeStyle, String r/w The stroke style applied to the underline.
underlineWeight Unit r/w The stroke weight of the underline.
verticalScale Real r/w The vertical scaling percentage applied to the object, including the scaling applied to its containing object(s).
words Words read The words contained by the object.

TextStyleRange Methods

Method Returns Description
applyBullets Nothing Applies bullets to the text.
applyNumbers Nothing Apply numbering to the text.
applyStyle Nothing Applies a paragraph or character style.
changecase Nothing Changes the case of the text.
clearOverrides Nothing Clears local formatting overrides applied to the text.
convertBulletsAndNumberingToText Nothing Converts bullets and numbering to text.
convertToNote Note Converts the text to a note.
convertToTable Table Converts the text to a table.
createOutlines Array of PageItems Create outlines from the text.
exportFile Nothing Export the object to file.
getElements Array of Objects Resolve the object specifier.
markup Nothing Mark up layout content with XML preserving the existing content.
move Text Move before/after another text object, or to beginning/end.
place PageItem, Graphic, Movie, Sound, Story or Text Places a file.
recompose Nothing Recomposes the text in the object.
remove Nothing Delete the object.
removeBulletsAndNumbers Nothing Remove bullets and numbers.
search Array of Texts Searches for text and returns a list of text objects matching the search string and/or formatting specified by the find preferences. Search can also replace the text and/or formatting. This command corresponds to InDesign’s Find/Change feature.
select Nothing Selects the object.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: