Class
The text object contained in an art layer. convertToShape, createPath
TextItem
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| alternateLigatures | bool | r/w | If true, alternate ligatures are used. |
| antiAliasMethod | AntiAlias: AntiAlias.NONE AntiAlias.SHARP AntiAlias.CRISP AntiAlias.STRONG AntiAlias.SMOOTH |
r/w | The method of anti-aliasing to use. |
| autoKerning | AutoKernType: AutoKernType.MANUAL AutoKernType.METRICS AutoKernType.OPTICAL |
r/w | Options for auto kerning. |
| autoLeadingAmount | number | r/w | The percentage to use for auto leading. Range: 0.01 to 5000.00. |
| baselineShift | UnitValue | r/w | The amount of baseline offset of text. |
| capitalization | Case: Case.NORMAL Case.ALLCAPS Case.SMALLCAPS |
r/w | The case of the text. |
| color | SolidColor | r/w | The text color. |
| contents | string | r/w | The actual text in the layer. |
| desiredGlyphScaling | number | r/w | 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 | number | r/w | 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 | number | r/w | 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 | Direction: Direction.HORIZONTAL Direction.VERTICAL |
r/w | The text orientation. |
| fauxBold | bool | r/w | If true, faux bold is used. |
| fauxItalic | bool | r/w | If true, faux italic is used. |
| firstLineIndent | UnitValue | r/w | The amount to indent the first line of paragraphs. Range: -1296 to 1296. |
| font | string | r/w | The text face of the character. |
| hangingPuntuation | bool | r/w | If true, uses Roman hanging punctuation. |
| height | UnitValue | r/w | The height of the bounding box for paragraph text. |
| horizontalScale | int | r/w | Character scaling (horizontal) in proportion to horizontal scale. Range: 0 - 1000 as a percentage. |
| hyphenLimit | int | r/w | The maximum number of consecutive lines that can end with a hyphenated word. |
| hyphenateAfterFirst | int | r/w | The number of letters after which hyphenation in word wrap is allowed. Range: 1 to 15. |
| hyphenateBeforeLast | int | r/w | The number of letters before which hyphenation in word wrap is allowed. Range: 1 to 15. |
| hyphenateCapitalWords | bool | r/w | If true, capitalized words can be hyphenated. |
| hyphenateWordsLongerThan | int (min: 0) | r/w | The minimum number of letters a word must have in order for hyphenation in word wrap to be allowed. Range: 2 to 25. |
| hyphenation | bool | r/w | If true, hyphenation is used. |
| hyphenationZone | UnitValue | r/w | The distance at the end of a line that will cause a word to break in unjustified type. Range: 0 - 720 picas. |
| justification | Justification: Justification.LEFT Justification.CENTER Justification.RIGHT Justification.LEFTJUSTIFIED Justification.CENTERJUSTIFIED Justification.RIGHTJUSTIFIED Justification.FULLYJUSTIFIED |
r/w | The paragraph justification. |
| kind | TextType: TextType.POINTTEXT TextType.PARAGRAPHTEXT |
r/w | The type of text. |
| language | Language: Language.ENGLISHUSA Language.ENGLISHUK Language.FRENCH Language.CANADIANFRENCH Language.FINNISH Language.GERMAN Language.OLDGERMAN Language.SWISSGERMAN Language.ITALIAN Language.NORWEGIAN Language.NYNORSKNORWEGIAN Language.PORTUGUESE Language.BRAZILLIANPORTUGUESE Language.SPANISH Language.SWEDISH Language.DUTCH Language.DANISH |
r/w | The language. |
| leading | UnitValue | r/w | The leading amount. |
| leftIndent | UnitValue | r/w | The amount to indent text from the left. Range: -1296 to 1296. |
| ligatures | bool | r/w | If true, ligatures are used. |
| maximumGlyphScaling | number | r/w | 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 | number | r/w | 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 | number | r/w | 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 | number | r/w | 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 | number | r/w | 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 | number | r/w | 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 | bool | r/w | 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 | bool | r/w | If true, old style is used. |
| parent | Object | readonly | The object's container. |
| position | UnitPoint | r/w | 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 | UnitValue | r/w | The amount to indent text from the right. Range: -1296 to 1296. |
| size | UnitValue | r/w | The font size. |
| spaceAfter | UnitValue | r/w | The amount of space after each paragraph. Range: -1296 to 1296. |
| spaceBefore | UnitValue | r/w | The amount of space before each paragraph. Range: -1296 to 1296. |
| strikeThru | StrikeThruType: StrikeThruType.STRIKEOFF StrikeThruType.STRIKEHEIGHT StrikeThruType.STRIKEBOX |
r/w | The strike through option to use. |
| textComposer | TextComposer: TextComposer.ADOBESINGLELINE TextComposer.ADOBEEVERYLINE |
r/w | The text composing engine to use. |
| tracking | number | r/w | The amount of uniform spacing between multiple characters. Range: -1000 to 10000. |
| typename | string | readonly | The class name of the object. |
| underline | UnderlineType: UnderlineType.UNDERLINEOFF UnderlineType.UNDERLINERIGHT UnderlineType.UNDERLINELEFT |
r/w | Options for underlining the text. |
| useAutoLeading | bool | r/w | If true, uses the font's built-in leading information. |
| verticalScale | int | r/w | Character scaling (vertical) in proportion to horizontal scale. Range: 0 - 1000 as a percentage. |
| warpBend | number | r/w | The warp bend percentage. Range: -100 to 100. |
| warpDirection | Direction: Direction.HORIZONTAL Direction.VERTICAL |
r/w | The warp direction. |
| warpHorizontalDistortion | number | r/w | The warp horizontal distortion percentage. Range: -100 to 100. |
| warpStyle | WarpStyle: WarpStyle.NONE WarpStyle.ARC WarpStyle.ARCLOWER WarpStyle.ARCUPPER WarpStyle.ARCH WarpStyle.BULGE WarpStyle.SHELLLOWER WarpStyle.SHELLUPPER WarpStyle.FLAG WarpStyle.WAVE WarpStyle.FISH WarpStyle.RISE WarpStyle.FISHEYE WarpStyle.INFLATE WarpStyle.SQUEEZE WarpStyle.TWIST |
r/w | The style of warp. |
| warpVerticalDistortion | number | r/w | The warp vertical distortion percentage. Range: -100 to 100. |
| width | UnitValue | r/w | The width of the bounding box for paragraph text. |
Methods
Instances
void convertToShape ()
Converts the text object and its containing layer to a fill layer with the text changed to a clipping path.
void createPath ()
Creates a clipping path from the outlines of the actual text items (such as letters or words).
Element of
ArtLayer.textItem
| Jongware, 28-Aug-2012 v3.0.3i | Contents :: Index |