A text object.
Element
button
character
footnote
form field
graphic line
group
hidden text
insertion point
line
nested grep style
nested line style
nested style
note
oval
page item
paragraph
polygon
rectangle
tab stop
table
text.ctxt
text column
text frame
text style range
text variable instance
word
text Properties
| Property | Type | Access | Description |
|---|---|---|---|
| align to baseline | boolean | r/w | If true, aligns the baseline of the text to the baseline grid. |
| all graphics | List of graphic | read | Lists all graphics contained by the text. |
| all page items | List of page item | read | Lists all page items contained by the text. |
| applied character style | character style | r/w | The character style applied to the text. Can also accept: string. |
| applied conditions | List of condition | r/w | The applied conditions. |
| applied font | any | 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. |
| applied language | specifier | r/w | The language of the text. Can return: language with vendors or language. Can also accept: string. |
| applied nested styles | List of character style | read | The applied character styles dictated by nested styles. |
| applied numbering list | any | r/w | The list to be part of. Can return: numbering list or string. |
| applied paragraph style | paragraph style | r/w | The paragraph style applied to the text. Can also accept: string. |
| ascent | number | read | The maximum ascent of any character in the text. |
| associated XML elements | List of XML item | read | The XML elements associated with the text. |
| auto leading | real | r/w | The percent of the type size to use for auto leading. (Range: 0 to 500). |
| balance ragged lines | any | 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 no balancing/vee shape/fully balanced/pyramid shape. |
| baseline | number | read | The vertical offset of the text. |
| baseline shift | number | r/w | The baseline shift applied to the text. |
| bullet char | bullet | read | Bullet character. |
| bullets alignment | left align, center align, right align, left align, center align, right align, left align, center align, right align, |
r/w | The alignment of the bullet character. |
| bullets and numbering list type | no list, bullet list, numbered list, no list, bullet list, numbered list, no list, bullet list, numbered list, |
r/w | List type for bullets and numbering. |
| bullets character style | any | r/w | The character style to be used for the text after string. Can return: character style or string. |
| bullets text after | text | r/w | The text after string expression for bullets. |
| capitalization | normal, small caps, all caps, cap to small cap, normal, small caps, all caps, cap to small cap, normal, small caps, all caps, cap to small cap, |
r/w | The capitalization scheme. |
| character direction | default direction, left to right direction, right to left direction, default direction, left to right direction, right to left direction, default direction, left to right direction, right to left direction, |
r/w | The direction of the character. |
| class | type | read | The class descriptor type. |
| composer | text | r/w | The text composer to use to compose the text. |
| contents | any | r/w | The contents of the text. Can return: string or auto page number/next page number/previous page number/section marker/bullet character/copyright symbol/degree symbol/ellipsis character/forced line break/paragraph symbol/registered trademark/section sym… |
| descent | number | read | The maximum descent of any character in the text. |
| desired glyph scaling | real | r/w | The desired width (as a percentage) of individual characters. (Range: 50 to 200) |
| desired letter spacing | real | r/w | The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) |
| desired word spacing | real | r/w | The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000) |
| diacritic position | default position, loose position, medium position, tight position, opentype position, default position, loose position, medium position, tight position, opentype position, default position, loose position, medium position, tight position, opentype position, |
r/w | Position of diacriticical characters. |
| digits type | default digits, arabic digits, hindi digits, farsi digits, Native digits, full farsi digits, thai digits, lao digits, devanagari digits, bengali digits, gurmukhi digits, gujarati digits, oriya digits, tamil digits, telugu digits, kannada digits, malayalam digits, tibetan digits, khmer digits, burmese digits, default digits, arabic digits, hindi digits, farsi digits, Native digits, full farsi digits, thai digits, lao digits, devanagari digits, bengali digits, gurmukhi digits, gujarati digits, oriya digits, tamil digits, telugu digits, kannada digits, malayalam digits, tibetan digits, khmer digits, burmese digits, default digits, arabic digits, hindi digits, farsi digits, Native digits, full farsi digits, thai digits, lao digits, devanagari digits, bengali digits, gurmukhi digits, gujarati digits, oriya digits, tamil digits, telugu digits, kannada digits, malayalam digits, tibetan digits, khmer digits, burmese digits, |
r/w | The digits type. |
| drop cap characters | integer | r/w | The number of characters to drop cap. Can return: small integer (0 – 150). |
| drop cap lines | integer | r/w | The number of lines to drop cap. Can return: small integer (0 – 25). |
| drop cap style | character style | r/w | The character style to apply to the drop cap. Can also accept: string. |
| dropcap detail | integer | r/w | Details about the drop cap based on the glyph outlines. 1 = left side bearing. 2 = descenders. 0×100,0×200,0×400 are used for Japanese frame grid. |
| end baseline | number | read | Vertical offset of the end of the text. |
| end horizontal offset | number | read | Horizontal offset of the end of the text. |
| end join | miter end join, round end join, bevel end join, miter end join, round end join, bevel end join, miter end join, round end join, bevel end join, |
r/w | The stroke join type applied to the characters of the text. |
| fill color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can also accept: string. |
| fill tint | 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.) |
| first line indent | number | r/w | The amount to indent the first line. |
| font style | text | r/w | The name of the font style. |
| gradient fill angle | real | r/w | The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180) |
| gradient fill length | real | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. |
| gradient fill start | List of | r/w | The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. |
| gradient stroke angle | real | r/w | The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180) |
| gradient stroke length | real | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. |
| gradient stroke start | List of | r/w | The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. |
| grid align first line only | boolean | r/w | If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid. |
| horizontal offset | number | read | The horizontal offset of the text. |
| horizontal scale | real | r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| hyphen weight | integer | r/w | The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100). Can return: small integer (0 – 10). |
| hyphenate across columns | boolean | r/w | If true, allows the last word in a text column to be hyphenated. |
| hyphenate after first | integer | r/w | The mininum number of letters at the beginning of a word that can be broken by a hyphen. Can return: small integer (1 – 15). |
| hyphenate before last | integer | r/w | The minimum number of letters at the end of a word that can be broken by a hyphen. Can return: small integer (1 – 15). |
| hyphenate capitalized words | boolean | r/w | If true, allows hyphenation of capitalized words. |
| hyphenate ladder limit | integer | r/w | The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero. Can return: small integer (0 – 25). |
| hyphenate last word | boolean | r/w | If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. |
| hyphenate words longer than | integer | r/w | The minimum number of letters a word must have in order to qualify for hyphenation. Can return: small integer (3 – 25). |
| hyphenation | boolean | r/w | If true, allows hyphenation. |
| hyphenation zone | number | 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. |
| ignore edge alignment | boolean | r/w | If true, ignores optical edge alignment for the paragraph. |
| index | integer | read | The index of the text in the collection or parent object. |
| justification | left align, center align, right align, left justified, right justified, center justified, fully justified, to binding side, away from binding side, left align, center align, right align, left justified, right justified, center justified, fully justified, to binding side, away from binding side, left align, center align, right align, left justified, right justified, center justified, fully justified, to binding side, away from binding side, |
r/w | The paragraph alignment. |
| kashidas | default kashidas, kashidas off, default kashidas, kashidas off, default kashidas, kashidas off, |
r/w | Use of Kashidas for justification |
| keep all lines together | boolean | r/w | If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. |
| keep first lines | integer | r/w | The minimum number of lines to keep together in a paragraph before allowing a page break. Can return: small integer (1 – 50). |
| keep last lines | integer | r/w | The minimum number of lines to keep together in a paragraph after a page break. Can return: small integer (1 – 50). |
| keep lines together | boolean | r/w | If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. |
| keep rule above in frame | boolean | r/w | If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true. |
| keep with next | integer | r/w | The minimum number of lines to keep with the next paragraph. Can return: small integer (0 – 5). |
| kerning method | text | r/w | The type of pair kerning. |
| kerning value | real | r/w | The amount of space to add or remove between characters, specified in thousands of an em. |
| keyboard direction | default direction, left to right direction, right to left direction, default direction, left to right direction, right to left direction, default direction, left to right direction, right to left direction, |
r/w | The keyboard direction of the character. |
| last line indent | number | r/w | The amount to indent the last line in the paragraph. |
| leading | any | r/w | The leading applied to the text. Can return: number or string or auto. |
| left indent | number | r/w | The width of the left indent. |
| length | integer | read | The number of objects in the collection. |
| ligatures | boolean | r/w | If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. |
| maximum glyph scaling | real | r/w | The maximum width (as a percentage) of individual characters. (Range: 50 to 200) |
| maximum letter spacing | real | 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. |
| maximum word spacing | real | 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) |
| minimum glyph scaling | real | r/w | The minimum width (as a percentage) of individual characters. (Range: 50 to 200) |
| minimum letter spacing | real | 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. |
| minimum word spacing | real | 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) |
| miter limit | real | r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. Can return: fixed (0 – 1000). |
| no break | boolean | r/w | If true, keeps the text on the same line. |
| numbering alignment | left align, center align, right align, left align, center align, right align, left align, center align, right align, |
r/w | The alignment of the number. |
| numbering apply restart policy | boolean | r/w | If true, apply the numbering restart policy. |
| numbering character style | any | r/w | The character style to be used for the number string. Can return: character style or string. |
| numbering continue | boolean | r/w | Continue the numbering at this level. |
| numbering expression | text | r/w | The number string expression for numbering. |
| numbering format | any | r/w | Numbering format options. Can return: upper roman/lower roman/upper letters/lower letters/arabic/format none/single leading zeros/double leading zeros/triple leading zeros or string. |
| numbering level | integer | r/w | The level of the paragraph. |
| numbering restart policies | numbering restart policy | read | Numbering restart policies. |
| numbering start at | integer | r/w | Determines starting number in a numbered list. |
| object reference | text.ctxt | read | An object reference for the object. |
| OpenType features | List of any | r/w | OpenType features. Can return: list of list of 2 strings or integers. |
| OTF contextual alternate | boolean | r/w | If true, uses contextual alternate forms in OpenType fonts. |
| OTF discretionary ligature | boolean | r/w | If true, uses discretionary ligatures in OpenType fonts. |
| OTF figure style | tabular lining, proportional oldstyle, proportional lining, tabular oldstyle, default, tabular lining, proportional oldstyle, proportional lining, tabular oldstyle, default, tabular lining, proportional oldstyle, proportional lining, tabular oldstyle, default, |
r/w | The figure style in OpenType fonts. |
| OTF fraction | boolean | r/w | If true, uses fractions in OpenType fonts. |
| OTF historical | boolean | r/w | If true, use historical forms in OpenType fonts. |
| OTF justification alternate | boolean | r/w | If true, use alternate justification forms in OpenType fonts |
| OTF locale | boolean | r/w | If true, uses localized forms in OpenType fonts. |
| OTF mark | boolean | r/w | If true, uses mark positioning in OpenType fonts. |
| OTF ordinal | boolean | r/w | If true, uses ordinals in OpenType fonts. |
| OTF overlap swash | boolean | r/w | If true, use overlapping swash forms in OpenType fonts |
| OTF slashed zero | boolean | r/w | If true, use a slashed zeroes in OpenType fonts. |
| OTF stretched alternate | boolean | r/w | If true, use stretched alternate forms in OpenType fonts |
| OTF stylistic alternate | boolean | r/w | If true, use stylistic alternate forms in OpenType fonts |
| OTF stylistic sets | integer | r/w | The stylistic sets to use in OpenType fonts. |
| OTF swash | boolean | r/w | If true, uses swash forms in OpenType fonts. |
| OTF titling | boolean | r/w | If true, uses titling forms in OpenType fonts. |
| overprint fill | boolean | r/w | If true, the fill color of the characters will overprint. |
| overprint stroke | boolean | r/w | If true, the stroke of the characters will overprint. |
| paragraph direction | left to right direction, right to left direction, left to right direction, right to left direction, left to right direction, right to left direction, |
r/w | Paragraph direction. |
| paragraph justification | default justification, arabic justification, naskh justification, default justification, arabic justification, naskh justification, default justification, arabic justification, naskh justification, |
r/w | Paragraph justification. |
| parent | specifier | read | The parent of the text (a xml story, text path, text frame, text, character, word, line, text column, paragraph, text style range, insertion point, story, cell, XML element, footnote, change, note or hidden text). Can return: xml story, text path, text… |
| parent story | story | read | The story that contains the text. |
| parent text frames | List of specifier | read | An array of the text frames that contain the text. Can return: list of text frames or text paths. |
| point size | number | r/w | The text size. |
| position | normal, superscript, subscript, OT superscript, OT subscript, OT numerator, OT denominator, normal, superscript, subscript, OT superscript, OT subscript, OT numerator, OT denominator, normal, superscript, subscript, OT superscript, OT subscript, OT numerator, OT denominator, |
r/w | The text position relative to the baseline. |
| positional form | none, calculate, initial, medial, final, isolated, none, calculate, initial, medial, final, isolated, none, calculate, initial, medial, final, isolated, |
r/w | The OpenType positional form. |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| right indent | number | r/w | The width of the right indent. |
| rule above | boolean | r/w | If true, places a rule above the paragraph. |
| rule above color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: swatch or string. |
| rule above gap color | any | 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. |
| rule above gap overprint | boolean | r/w | If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid. |
| rule above gap tint | real | 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. |
| rule above left indent | number | 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. |
| rule above line weight | number | r/w | The line weight of the rule above. |
| rule above offset | number | r/w | The amount to offset the paragraph rule above from the baseline of the first line the paragraph. |
| rule above overprint | boolean | r/w | If true, the paragraph rule above will overprint. |
| rule above right indent | number | 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. |
| rule above tint | real | r/w | The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) |
| rule above type | any | r/w | The stroke type of the rule above the paragraph. Can return: stroke style or string. |
| rule above width | text width, column width, text width, column width, text width, column width, |
r/w | The basis (text width or column width) used to calculate the width of the paragraph rule above. |
| rule below | boolean | r/w | If true, applies a paragraph rule below. |
| rule below color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: swatch or string. |
| rule below gap color | any | 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. |
| rule below gap overprint | boolean | r/w | If true, the gap color of the rule below will overprint. |
| rule below gap tint | real | 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. |
| rule below left indent | number | 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. |
| rule below line weight | number | r/w | The line weight of the rule below. |
| rule below offset | number | r/w | The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph. |
| rule below overprint | boolean | r/w | If true, the rule below will overprint. |
| rule below right indent | number | 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. |
| rule below tint | real | r/w | The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) |
| rule below type | any | r/w | The stroke type of the rule below the paragraph. Can return: stroke style or string. |
| rule below width | text width, column width, text width, column width, text width, column width, |
r/w | The basis (text width or column width) used to calculate the width of the paragraph rule below. |
| single word justification | left align, center align, right align, fully justified, left align, center align, right align, fully justified, left align, center align, right align, fully justified, |
r/w | The alignment to use for lines that contain a single word. |
| skew | real | r/w | The skew angle of the text. (Range: -85 to 85) |
| space after | number | r/w | The height of the paragraph space below. |
| space before | number | r/w | The height of the paragraph space above. |
| start paragraph | anywhere, next column, next frame, next page, next odd page, next even page, anywhere, next column, next frame, next page, next odd page, next even page, anywhere, next column, next frame, next page, next odd page, next even page, anywhere, next column, next frame, next page, next odd page, next even page, |
r/w | The location at which to start the paragraph. |
| strike through color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: swatch or string. |
| strike through gap color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: swatch or string. |
| strike through gap overprint | boolean | r/w | If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. |
| strike through gap tint | 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. |
| strike through offset | number | r/w | The amount by which to offset the strikethrough stroke from the text baseline. |
| strike through overprint | boolean | r/w | If true, the strikethrough stroke will overprint. |
| strike through tint | real | r/w | The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) |
| strike through type | any | r/w | The stroke type of the strikethrough stroke. Can return: stroke style or string. |
| strike through weight | number | r/w | The stroke weight of the strikethrough stroke. |
| strike thru | boolean | r/w | If true, draws a strikethrough line through the text. |
| stroke alignment | center alignment, outside alignment, center alignment, outside alignment, center alignment, outside alignment, |
r/w | The stroke alignment applied to the text. |
| stroke color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can also accept: string. |
| stroke tint | 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.) |
| stroke weight | number | r/w | The stroke weight applied to the characters of the text. |
| style overridden | boolean | read | If true, the applied style has been overridden with additional attributes. |
| tab list | List of any | r/w | A list of the tab stops in the paragraph. Can return: list of record. |
| tracking | real | r/w | The amount by which to loosen or tighten a block of text, specified in thousands of an em. |
| underline | boolean | r/w | If true, underlines the text. |
| underline color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: swatch or string. |
| underline gap color | any | 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. |
| underline gap overprint | boolean | r/w | If true, the gap color of the underline stroke will overprint. |
| underline gap tint | 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. |
| underline offset | number | r/w | The amount by which to offset the underline from the text baseline. |
| underline overprint | boolean | r/w | If true, the underline stroke color will overprint. |
| underline tint | real | r/w | The underline stroke tint (as a percentage). (Range: 0 to 100) |
| underline type | any | r/w | The stroke type of the underline stroke. Can return: stroke style or string. |
| underline weight | number | r/w | The stroke weight of the underline stroke. |
| vertical scale | real | r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| x offset diacritic | real | r/w | The x (horizontal) offset for diacritic adjustment. |
| y offset diacritic | real | r/w | The y (vertical) offset for diacritic adjustment. |