Change text preferences.
change text preference Properties
| Property | Type | Access | Description |
|---|---|---|---|
| applied character style | anything | r/w | The character style to search for or change to. Can return: string or nothing. Can also accept: character style. |
| applied font | anything | r/w | The font applied to the text, specified as either a font object or the name of font family. Can return: font, string or nothing. |
| applied language | anything | r/w | The language to search for or change to. Can return: string or nothing. Can also accept: language or language with vendors. |
| applied numbering list | anything | r/w | The list to be part of. Can return: numbering list, string or nothing. |
| applied paragraph style | anything | r/w | The paragraph style to search for or change to. Can return: string or nothing. Can also accept: paragraph style. |
| auto leading | anything | r/w | The percent of the type size to use for auto leading. (Range: 0 to 500). Can return: fixed or nothing. |
| balance ragged lines | anything | r/w | If true or set to an enumeration value, balances ragged lines in the paragraph(s) of the change text preference. Note: Not valid with a single-line text composer. For information, see composer. Can return: boolean, no balancing/vee shape/fully balanced… |
| baseline shift | anything | r/w | The baseline shift applied to the text. Can return: number or string or nothing. |
| bullet char | anything | r/w | Bullet character. Can return: bullet or nothing. |
| bullets and numbering list type | anything | r/w | List type for bullets and numbering. Can return: no list/bullet list/numbered list or nothing. |
| bullets character style | anything | r/w | The character style to be used for the text after string. Can return: character style, string or nothing. |
| bullets text after | anything | r/w | The text after string expression for bullets. Can return: string or nothing. |
| capitalization | anything | r/w | The capitalization scheme. Can return: normal/small caps/all caps/cap to small cap or nothing. |
| change to | anything | r/w | The replacement change text preference. Can return: string or nothing. |
| class | anything | read | The class descriptor type. Can return: integer or nothing. |
| composer | anything | r/w | The text composer to use to compose the text. Can return: string or nothing. |
| drop cap characters | anything | r/w | The number of characters to drop cap. Can return: small integer (0 – 150) or nothing (0 – 150). |
| drop cap lines | anything | r/w | The number of lines to drop cap. Can return: small integer (0 – 25) or nothing (0 – 25). |
| dropcap detail | anything | r/w | The detailed size and positioning of the drop cap. Can return: integer or nothing. |
| fill color | anything | r/w | The swatch (color, gradient, tint, or mixed ink), applied as a fill color, to search for or change to. Can return: string or nothing. Can also accept: swatch. |
| fill tint | anything | r/w | The tint (as a percentage) of the fill color of the change text preference. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: fixed or nothing. |
| first line indent | anything | r/w | The amount to indent the first line. Can return: number or string or nothing. |
| font style | anything | r/w | The name of the font style. Can return: string or nothing. |
| gradient fill angle | anything | r/w | The angle of a linear gradient applied to the fill of the change text preference. (Range: -180 to 180). Can return: fixed or nothing. |
| gradient fill length | anything | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the change text preference. Can return: fixed or nothing. |
| gradient fill start | anything | r/w | The starting point (in page coordinates) of a gradient applied to the fill of the change text preference, in the format [x, y]. Can return: list of 2 numbers or strings or nothing. |
| gradient stroke angle | anything | r/w | The angle of a linear gradient applied to the stroke of the change text preference. (Range: -180 to 180). Can return: fixed or nothing. |
| gradient stroke length | anything | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the change text preference. Can return: fixed or nothing. |
| gradient stroke start | anything | r/w | The starting point (in page coordinates) of a gradient applied to the stroke of the change text preference, in the format [x, y]. Can return: list of 2 numbers or strings or nothing. |
| horizontal scale | anything | r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: fixed or nothing. |
| hyphenate across columns | anything | r/w | If true, allows the last word in a text column to be hyphenated. Can return: boolean or nothing. |
| hyphenate last word | anything | r/w | If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. Can return: boolean or nothing. |
| ignore edge alignment | anything | r/w | If true, ignores optical edge alignment for the paragraph. Can return: boolean or nothing. |
| justification | anything | r/w | The paragraph alignment. Can return: left align/center align/right align/left justified/right justified/center justified/fully justified/to binding side/away from binding side or nothing. |
| keep all lines together | anything | r/w | If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. Can return: boolean or nothing. |
| keep first lines | anything | r/w | The minimum number of lines to keep together in a paragraph before allowing a page break. Can return: small integer (1 – 50) or nothing (1 – 50). |
| keep last lines | anything | r/w | The minimum number of lines to keep together in a paragraph after a page break. Can return: small integer (1 – 50) or nothing (1 – 50). |
| keep lines together | anything | r/w | If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. Can return: boolean or nothing. |
| keep rule above in frame | anything | r/w | If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true. Can return: boolean or nothing. |
| keep with next | anything | r/w | The minimum number of lines to keep with the next paragraph. Can return: small integer (0 – 5) or nothing (0 – 5). |
| kerning method | anything | r/w | The type of pair kerning. Can return: string or nothing. |
| kerning value | anything | r/w | The amount of space to add or remove between characters, specified in thousands of an em. . Can return: fixed or nothing. |
| last line indent | anything | r/w | The amount to indent the last line in the change text preference. Can return: number or string or nothing. |
| leading | anything | r/w | The leading applied to the text. Can return: number or string, auto or nothing. |
| left indent | anything | r/w | The width of the left indent. Can return: number or string or nothing. |
| ligatures | anything | r/w | If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: boolean or nothing. |
| markup tag | anything | r/w | The XML tag applied to the element. Can return: XML tag or nothing. Can also accept: string. |
| no break | anything | r/w | If true, keeps the text on the same line. . Can return: boolean or nothing. |
| numbering apply restart policy | anything | r/w | If true, apply the numbering restart policy. Can return: boolean or nothing. |
| numbering character style | anything | r/w | The character style to be used for the number string. Can return: character style, string or nothing. |
| numbering continue | anything | r/w | Continue the numbering at this level. Can return: boolean or nothing. |
| numbering expression | anything | r/w | The number string expression for numbering. Can return: string or nothing. |
| numbering format | anything | r/w | Numbering format options. Can return: upper roman/lower roman/upper letters/lower letters/arabic/format none/single leading zeros, string or nothing. |
| numbering level | anything | r/w | The level of the paragraph. Can return: integer or nothing. |
| numbering restart policies | anything | read | Numbering restart policies. Can return: numbering restart policy or nothing. |
| numbering start at | anything | r/w | Determines starting number in a numbered list. Can return: integer or nothing. |
| object reference | anything | read | An object reference for the change text preference. Can return: change text preference or nothing. |
| OTF contextual alternate | anything | r/w | If true, uses contextual alternate forms in OpenType fonts. Can return: boolean or nothing. |
| OTF discretionary ligature | anything | r/w | If true, uses discretionary ligatures in OpenType fonts. Can return: boolean or nothing. |
| OTF figure style | anything | r/w | The figure style in OpenType fonts. Can return: tabular lining/proportional oldstyle/proportional lining/tabular oldstyle/default or nothing. |
| OTF fraction | anything | r/w | If true, uses fractions in OpenType fonts. Can return: boolean or nothing. |
| OTF historical | anything | r/w | If true, use historical forms in OpenType fonts. Can return: boolean or nothing. |
| OTF locale | anything | r/w | If true, uses localized forms in OpenType fonts. Can return: boolean or nothing. |
| OTF mark | anything | r/w | If true, uses mark positioning in OpenType fonts. Can return: boolean or nothing. |
| OTF ordinal | anything | r/w | If true, uses ordinals in OpenType fonts. Can return: boolean or nothing. |
| OTF slashed zero | anything | r/w | If true, use a slashed zeroes in OpenType fonts. Can return: boolean or nothing. |
| OTF stylistic sets | anything | r/w | The stylistic sets to use in OpenType fonts. Can return: integer or nothing. |
| OTF swash | anything | r/w | If true, uses swash forms in OpenType fonts. Can return: boolean or nothing. |
| OTF titling | anything | r/w | If true, uses titling forms in OpenType fonts. Can return: boolean or nothing. |
| overprint fill | anything | r/w | If true, the fill color of the characters will overprint. Can return: boolean or nothing. |
| overprint stroke | anything | r/w | If true, the stroke of the characters will overprint. Can return: boolean or nothing. |
| parent | anything | read | The parent of the change text preference (a application). Can return: application or nothing. |
| point size | anything | r/w | The text size. Can return: number or string or nothing. |
| position | anything | r/w | The text position relative to the baseline. Can return: normal/superscript/subscript/OT superscript/OT subscript/OT numerator/OT denominator or nothing. |
| positional form | anything | r/w | The OpenType positional form. Can return: none/calculate/initial/medial/final/isolated or nothing. |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| right indent | anything | r/w | The width of the right indent. Can return: number or string or nothing. |
| single word justification | anything | r/w | The alignment to use for lines that contain a single word. Can return: left align/center align/right align/fully justified or nothing. |
| skew | anything | r/w | The skew angle of the text. (Range: -85 to 85). Can return: fixed or nothing. |
| space after | anything | r/w | The height of the paragraph space below. Can return: number or string or nothing. |
| space before | anything | r/w | The height of the paragraph space above. Can return: number or string or nothing. |
| start paragraph | anything | r/w | The location at which to start the paragraph. Can return: anywhere/next column/next frame/next page/next odd page/next even page or nothing. |
| strike through color | anything | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: swatch, string or nothing. |
| strike through gap color | anything | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: swatch, string or nothing. |
| strike through gap overprint | anything | r/w | If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. Can return: boolean or nothing. |
| strike through gap tint | anything | 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. Can return: fixed or nothing. |
| strike through offset | anything | r/w | The amount by which to offset the strikethrough stroke from the text baseline. Can return: number or string or nothing. |
| strike through overprint | anything | r/w | If true, the strikethrough stroke will overprint. Can return: boolean or nothing. |
| strike through tint | anything | r/w | The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: fixed or nothing. |
| strike through type | anything | r/w | The stroke type of the strikethrough stroke. Can return: stroke style, string or nothing. |
| strike through weight | anything | r/w | The stroke weight of the strikethrough stroke. Can return: number or string or nothing. |
| strike thru | anything | r/w | If true, draws a strikethrough line through the text. Can return: boolean or nothing. |
| stroke color | anything | r/w | The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, to search for or change to. Can return: string or nothing. Can also accept: swatch. |
| stroke tint | anything | r/w | The tint (as a percentage) of the stroke color of the change text preference. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: fixed or nothing. |
| stroke weight | anything | r/w | The stroke weight applied to the characters of the text. Can return: number or string or nothing. |
| tracking | anything | r/w | The amount by which to loosen or tighten a block of text, specified in thousands of an em. Can return: fixed or nothing. |
| underline | anything | r/w | If true, underlines the text. Can return: boolean or nothing. |
| underline color | anything | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: swatch, string or nothing. |
| underline gap color | anything | 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, string or nothing. |
| underline gap overprint | anything | r/w | If true, the gap color of the underline stroke will overprint. Can return: boolean or nothing. |
| underline gap tint | anything | 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. Can return: fixed or nothing. |
| underline offset | anything | r/w | The amount by which to offset the underline from the text baseline. Can return: number or string or nothing. |
| underline overprint | anything | r/w | If true, the underline stroke color will overprint. Can return: boolean or nothing. |
| underline tint | anything | r/w | The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: fixed or nothing. |
| underline type | anything | r/w | The stroke type of the underline stroke. Can return: stroke style, string or nothing. |
| underline weight | anything | r/w | The stroke weight of the underline stroke. Can return: number or string or nothing. |
| vertical scale | anything | r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: fixed or nothing. |