A text style range (a continuous range of identical formatting attributes).
text style range elements
| Name | Refer to By |
|---|---|
| buttons | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| characters | by numeric index, as a range of elements, before/after another element, satisfying a test |
| footnotes | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| form fields | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| graphic lines | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| groups | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| insertion points | by numeric index, as a range of elements, before/after another element, satisfying a test |
| lines | by numeric index, as a range of elements, before/after another element, satisfying a test |
| nested styles | by numeric index, as a range of elements, before/after another element, satisfying a test |
| ovals | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| page items | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| paragraphs | by numeric index, as a range of elements, before/after another element, satisfying a test |
| polygons | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| rectangles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| tables | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| tab stops | by numeric index, as a range of elements, before/after another element, satisfying a test |
| text columns | by numeric index, as a range of elements, before/after another element, satisfying a test |
| text frames | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| texts | by numeric index, as a range of elements, before/after another element, satisfying a test |
| text style ranges | by numeric index, as a range of elements, before/after another element, satisfying a test |
| words | by numeric index, as a range of elements, before/after another element, satisfying a test |
text style range properties
| Property | Type | Access | Description |
|---|---|---|---|
| align to baseline | boolean | r/w | If true, align the baseline to the baseline grid. |
| all graphics | list of graphics | read | All graphics contained by the object. |
| all page items | list of page items | read | All page items contained by the object. |
| applied character style | character style, string | r/w | The character style applied to the object. |
| applied font | font, string | r/w | The applied font. Either a font object or the name of font family. |
| applied language | language with vendors, language, string | r/w | The language dictionary appled to the object. |
| applied paragraph style | paragraph style, string | r/w | The applied paragraph style. |
| ascent | number or string | read | The maximum ascent of any character in the object. |
| associated XML elements | list of XML Items | read | The XML elements associated with the object. |
| auto leading | fixed | r/w | Percentage used for calculating auto leading. |
| balance ragged lines | boolean, balance lines style enumeration | r/w | If true, or set to one of the enumerations, apply ragged line balancing to the paragraph containing the object. |
| baseline | number or string | read | The vertical position of the baseline on the page, relative to the ruler zero point. |
| baseline shift | number or string | r/w | The amount of baseline shift applied to the object. |
| bullet char | bullet | read | The bullet character used when a bullet is applied to the paragraph containing the object. |
| bullets and numbering color | auto enum enumeration, swatch, string | r/w | The color of the bullet or numbering. |
| bullets and numbering list type | list type enumeration | r/w | The list type to use for bullets and numbering. |
| bullets and numbering size | auto enum enumeration, fixed | r/w | The point size of the bullet or numbering. |
| capitalization | capitalization enumeration | r/w | The capitalization applied to the object. |
| class | integer | read | The class descriptor type. |
| composer | string | r/w | The applied text composer. |
| contents | string, special characters enumeration | r/w | The text contents. |
| descent | number or string | read | The maximum descent of any character in the object. |
| desired glyph scaling | fixed | r/w | The desired percentage of glyph scaling. |
| desired letter spacing | fixed | r/w | The desired percentage of letter spacing. |
| desired word spacing | fixed | r/w | The desired percentage of word spacing. |
| drop cap characters | small integer | r/w | The number of characters for a drop cap. |
| drop cap lines | small integer | r/w | The number of lines for drop cap. |
| drop cap style | character style, string | r/w | The character style for a drop cap. |
| fill color | swatch, string | r/w | The fill of the object. |
| fill tint | fixed | r/w | The tint percentage applied to the fill of the object (-1 indicates 100%). |
| first line indent | number or string | r/w | The first line indent. |
| font style | string | r/w | The name of the applied font style. |
| gradient fill angle | fixed | r/w | The angle of the gradient applied to the fill of the object. |
| gradient fill length | fixed | r/w | Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the fill of the object. |
| gradient fill start | list of 2 numbers or strings | 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. |
| gradient stroke angle | fixed | r/w | The angle of the gradient applied to the stroke of the object. |
| gradient stroke length | fixed | r/w | Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the stroke of the object. |
| gradient stroke start | list of 2 numbers or strings | 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. |
| grid align first line only | boolean | r/w | If true, only the first line of the object will be aligned to the frame grid or baseline grid. |
| horizontal offset | number or string | read | The horizontal position of the baseline on the page, relative to the ruler zero point. |
| horizontal scale | fixed | r/w | The horizontal scaling percentage applied to the object, including the scaling applied to its containing object(s). |
| hyphen weight | small integer | 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. |
| hyphenate after first | small integer | r/w | Hyphenate after this many letters. |
| hyphenate before last | small integer | r/w | Hyphenate before this many letters. |
| hyphenate capitalized words | boolean | r/w | If true, hyphenate capitalized words. |
| hyphenate ladder limit | small integer | r/w | The number of consecutive hyphens allowed. |
| hyphenate last word | boolean | r/w | If true, allow hyphenation for the last word of the paragraph. |
| hyphenate words longer than | small integer | r/w | Disallow hyphenation for words shorter than this length (in characters). |
| hyphenation | boolean | r/w | If true, hyphenation is on. |
| hyphenation zone | number or string | r/w | The width of the hyphenation zone. |
| index | integer | read | Index of the object within its parent object. |
| justification | justification enumeration | r/w | The alignment applied to the paragraph. |
| keep all lines together | boolean | r/w | If true, to keep all lines of the paragraph together. |
| keep first lines | small integer | 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. |
| keep last lines | small integer | 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. |
| keep lines together | boolean | r/w | If true, use the settings for KeepAllLinesTogether, KeepFirstLines, and KeepLastLines. |
| keep with next | small integer | 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. |
| kerning method | string | r/w | The type of kerning (Optical, Metrics or None). |
| kerning value | fixed | r/w | The amount of kerning. |
| last line indent | number or string | r/w | The last line indent. |
| leading | number or string, leading enumeration | r/w | The applied leading. |
| left indent | number or string | r/w | The left indent. |
| length | integer | read | The number of characters in the object. |
| ligatures | boolean | r/w | If true, use automatic ligature replacement characters. |
| maximum glyph scaling | fixed | r/w | The maximum percentage of glyph scaling. |
| maximum letter spacing | fixed | r/w | The maximum percentage of letter spacing. |
| maximum word spacing | fixed | r/w | The maximum percentage of word spacing. |
| minimum glyph scaling | fixed | r/w | The minimum percentage of glyph scaling. |
| minimum letter spacing | fixed | r/w | The minimum percentage of letter spacing. |
| minimum word spacing | fixed | r/w | The minimum percentage of word spacing. |
| no break | boolean | r/w | If true, do not break the text across lines. |
| number separator | small integer | r/w | The numbering separator character. |
| number start at | integer | r/w | The starting number for a numbered list. |
| numbering font | font, string, auto enum enumeration | r/w | The font applied to numbering. |
| numbering font style | string, nothing enum enumeration, auto enum enumeration | r/w | The font style applied to numbering. |
| numbering style | numbering style enumeration, string | r/w | The numbering style. |
| object reference | object | read | An object reference for this object. |
| OpenType features | list of 2 strings or integers | r/w | OpenType features available in the applied font. |
| OTF contextual alternate | boolean | r/w | If true, use contextual alternate forms in OpenType fonts. |
| OTF discretionary ligature | boolean | r/w | If true, use discretionary ligatures in OpenType fonts. |
| OTF figure style | OTF figure style enumeration | r/w | The figure style to use in OpenType fonts. |
| OTF fraction | boolean | r/w | If true, use fractions in OpenType fonts. |
| OTF historical | boolean | r/w | If true, use historical forms in OpenType fonts. |
| OTF ordinal | boolean | r/w | If true, use ordinals in OpenType fonts. |
| OTF slashed zero | boolean | r/w | If true, use a zero with slash in OpenType fonts. |
| OTF stylistic sets | integer | r/w | Stylistic sets to use in OpenType fonts. |
| OTF swash | boolean | r/w | If true, use swash forms in OpenType fonts. |
| OTF titling | boolean | r/w | If true, use titling forms in OpenType fonts. |
| overprint fill | boolean | r/w | If true, the fill of the object will overprint. |
| overprint stroke | boolean | r/w | If true, the storke of the object will overprint. |
| parent | object | read | The parent of the object. |
| parent story | story | read | The story containing the object. |
| parent text frames | text frame, text path | read | The text frame(s) containing the object. |
| point size | number or string | r/w | The point size of the text. |
| position | position enumeration | r/w | The position (e.g., superscript or subscript) of the object. |
| properties | record | r/w | Property that allows setting of several properties at the same time. |
| right indent | number or string | r/w | The right indent. |
| rule above | boolean | r/w | If true, apply a paragraph rule above. |
| rule above color | swatch, string | r/w | The color of the paragraph rule above. |
| rule above gap color | swatch, string | r/w | The color applied to the gap of the rule above. |
| rule above gap overprint | boolean | r/w | If true, overprint the rule above gap color. |
| rule above gap tint | fixed | r/w | The tint applied to the rule above gap color (-1 represents 100%). |
| rule above left indent | number or string | r/w | The left indent of the rule above. |
| rule above line weight | fixed | r/w | The stroke weight of the rule above. |
| rule above offset | number or string | r/w | The offset of the rule above from the baseline of the first line in the paragraph. |
| rule above overprint | boolean | r/w | If true, overprint the rule above. |
| rule above right indent | number or string | r/w | The right indent of the rule above. |
| rule above tint | fixed | r/w | The tint applied to the the rule above (-1 represents 100%). |
| rule above type | stroke style, string | r/w | The stroke style applied to the rule above. |
| rule above width | rule width 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. |
| rule below | boolean | r/w | If true, apply a paragraph rule below. |
| rule below color | swatch, string | r/w | The color of the paragraph below above. |
| rule below gap color | swatch, string | r/w | The color applied to the gap of the rule below. |
| rule below gap overPrint | boolean | r/w | If true, overprint the rule below gap color. |
| rule below gap tint | fixed | r/w | The tint applied to the rule below gap color (-1 represents 100%). |
| rule below left indent | number or string | r/w | The left indent of the rule below. |
| rule below line weight | fixed | r/w | The stroke weight of the rule below. |
| rule below offset | number or string | r/w | The offset of the rule below from the baseline of the last line in the paragraph. |
| rule below overPrint | boolean | r/w | If true, overprint the rule below. |
| rule below right indent | number or string | r/w | The right indent of the rule below. |
| rule below tint | fixed | r/w | The tint applied to the the rule below (-1 represents 100%). |
| rule below type | stroke style, string | r/w | The stroke style applied to the rule below. |
| rule below width | rule width 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. |
| single word justification | single word justification enumeration | r/w | Alignment applied to lines containing a single word. |
| skew | fixed | r/w | The angle of the skew for the text. |
| space after | number or string | r/w | Paragraph space after. |
| space before | number or string | r/w | Paragraph space before. |
| start paragraph | start paragraph enumeration | r/w | When this property is set to anything other than start anywhere, apply a column or page break before the paragraph. |
| strike through color | swatch, string | r/w | The color of the strikethrough. |
| strike through gap color | swatch, string | r/w | The gap color of the strikethrough. |
| strike through gap overprint | boolean | r/w | If true, overprint the gap of the strikethrough. |
| strike through gap tint | fixed | r/w | The tint percentage applied to the gap of the strikethrough (-1 represents 100%). |
| strike through offset | number or string | r/w | The offset of the strikethrough from the baseline. |
| strike through overprint | boolean | r/w | If true, overprint the strikethrough. |
| strike through tint | fixed | r/w | The tint percentage applied to stroke color of the strikethrough. |
| strike through type | stroke style, string | r/w | The stroke style of the strikethrough. |
| strike through weight | number or string | r/w | The stroke weight of the strikethrough. |
| strike thru | boolean | r/w | If true, apply a strikethrough to the text. |
| stroke color | swatch, string | r/w | The stroke color of the object. |
| stroke tint | fixed | r/w | The tint percentage applied to the stroke (-1 indicates 100%). |
| stroke weight | number or string | r/w | The stroke weight (thickness) of the stroke. |
| tab list | record | r/w | A list of all of the properties of all of the tab stops on this object. |
| tracking | fixed | r/w | The tracking (range kerning) applied to the object. |
| underline | boolean | r/w | If true, apply an underline to the text. |
| underline color | swatch, string | r/w | The color of the underline. |
| underline gap color | swatch, string | r/w | The gap color of the underline. |
| underline gap overprint | boolean | r/w | If true, overprint the gap of the underline. |
| underline gap tint | fixed | r/w | The tint percentage applied to the gap of the underline (-1 represents 100%). |
| underline offset | number or string | r/w | The offset of the underline from the baseline. |
| underline overprint | boolean | r/w | If true, overprint the underline. |
| underline tint | fixed | r/w | The tint percentage applied to the underline (-1 represents 100%). |
| underline type | stroke style, string | r/w | The stroke style applied to the underline. |
| underline weight | number or string | r/w | The stroke weight of the underline. |
| vertical scale | fixed | r/w | The vertical scaling percentage applied to the object, including the scaling applied to its containing object(s). |
text style range methods
| Method | Returns | Description |
|---|---|---|
| apply bullets | Nothing | Applies bullets to the text. |
| apply numbers | Nothing | Apply numbering to the text. |
| apply style | Nothing | Applies a paragraph or character style. |
| changecase | Nothing | Changes the case of the text. |
| clear overrides | Nothing | Clears local formatting overrides applied to the text. |
| convert bullets and numbering to text | Nothing | Converts bullets and numbering to text. |
| convert to note | note | Converts the text to a note. |
| convert to table | table | Converts the text to a table. |
| create outlines | list of page items | Create outlines from the text. |
| delete | Nothing | Delete the object. |
| export | Nothing | Export the object to file. |
| 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 | page item, graphic, movie, sound, story or text | Places a file. |
| recompose | Nothing | Recomposes the text in the object. |
| remove bullets and numbers | Nothing | Remove bullets and numbers. |
| search | list 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. |