TextItem

Description

The text object contained in an art layer.

Properties

alternateLigatures readonly If true, alternate ligatures are used.
antiAliasMethod readonly The method of anti-aliasing to use.
autoKerning readonly Options for auto kerning.
autoLeadingAmount readonly The percentage to use for auto leading. Range: 0.01 to 5000.00.
baselineShift readonly The amount of baseline offset of text.
capitalization readonly The case of the text.
color readonly The text color.
contents readonly The actual text in the layer.
desiredGlyphScaling readonly The desired amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.
desiredLetterScaling readonly The amount of space (as a percentage) between letters. Range: 100 - 500; at 0, no space is added between letters. Valid only for justified text.
desiredWordScaling readonly The amount (as a percentage) of space between words. Range: 0 -1000; at 100, no additional space is added between words. Valid only for justified text.
direction readonly The text orientation.
fauxBold readonly If true, faux bold is used.
fauxItalic readonly If true, faux italic is used.
firstLineIndent readonly The amount to indent the first line of paragraphs. Range: -1296 to 1296.
font readonly The text face of the character.
hangingPuntuation readonly If true, uses Roman hanging punctuation.
height readonly The height of the bounding box for paragraph text.
horizontalScale readonly Character scaling (horizontal) in proportion to horizontal scale. Range: 0 - 1000 as a percentage.
hyphenLimit readonly The maximum number of consecutive lines that can end with a hyphenated word.
hyphenateAfterFirst readonly The number of letters after which hyphenation in word wrap is allowed. Range: 1 to 15.
hyphenateBeforeLast readonly The number of letters before which hyphenation in word wrap is allowed. Range: 1 to 15.
hyphenateCapitalWords readonly If true, capitalized words can be hyphenated.
hyphenateWordsLongerThan readonly The minimum number of letters a word must have in order for hyphenation in word wrap to be allowed. Range: 2 to 25.
hyphenation readonly If true, hyphenation is used.
hyphenationZone readonly The distance at the end of a line that will cause a word to break in unjustified type. Range: 0 - 720 picas.
justification readonly The paragraph justification.
kind readonly The type of text.
language readonly The language.
leading readonly The leading amount.
leftIndent readonly The amount to indent text from the left. Range: -1296 to 1296.
ligatures readonly If true, ligatures are used.
maximumGlyphScaling readonly The maximum amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.
maximumLetterScaling readonly The maximum amount (as a percentage) of space between letters. Range: 100 - 500; at 0, no space is added between letters. Valid only for justified text.
maximumWordScaling readonly The maximum amount (as a percentage) of space between words (0 -1000; at 100, no additional space is added between words). Valid only for justified text.
minimumGlyphScaling readonly The minimum amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.
minimumLetterScaling readonly The minimum amount of space (as a percentage) between letters. Range: 100 to 500; at 0, no space is added between letters. Valid only for justified text.
minimumWordScaling readonly The minimum amount (as a percentage) of space between words. Range: 0 -1000; at 100, no additional space is added between words. Valid only for justified text.
noBreak readonly If true, words are not allowed to break at the end of a line. When enacted on large amounts of consecutive characters, can prevent word wrap and thus may prevent some text from appearing on the screen.
oldStyle readonly If true, old style is used.
parent readonly The object’s container.
position readonly The position of the origin for the text. The array must contain two values. Setting this property is basically equivalent to clicking the text tool at a point in the document to create the point of origin for text.
rightIndent readonly The amount to indent text from the right. Range: -1296 to 1296.
size readonly The font size in points.
spaceAfter readonly The amount of space after each paragraph. Range: -1296 to 1296.
spaceBefore readonly The amount of space before each paragraph. Range: -1296 to 1296.
strikeThru readonly The strike through option to use.
textComposer readonly The text composing engine to use.
tracking readonly The amount of uniform spacing between multiple characters. Range: -1000 to 10000.
typename readonly The class name of the object.
underline readonly Options for underlining the text.
useAutoLeading readonly If true, uses the font’s built-in leading information.
verticalScale readonly Character scaling (vertical) in proportion to horizontal scale. Range: 0 - 1000 as a percentage.
warpBend readonly The warp bend percentage. Range: -100 to 100.
warpDirection readonly The warp direction.
warpHorizontalDistortion readonly The warp horizontal distortion percentage. Range: -100 to 100.
warpStyle readonly The style of warp.
warpVerticalDistortion readonly The warp vertical distortion percentage. Range: -100 to 100.
width readonly The width of the bounding box for paragraph text.

Methods

convertToShape readonly Converts the text object and its containing layer to a fill layer with the text changed to a clipping path.
createPath readonly Creates a clipping path from the outlines of the actual text items (such as letters or words).