.. _TextItem: ================================================ TextItem ================================================ Description ----------- The text object contained in an art layer. Properties ^^^^^^^^^^ +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`alternateLigatures` readonly | If true, alternate ligatures are used. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`antiAliasMethod` readonly | The method of anti-aliasing to use. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`autoKerning` readonly | Options for auto kerning. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`autoLeadingAmount` readonly | The percentage to use for auto leading. Range: 0.01 to 5000.00. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`baselineShift` readonly | The amount of baseline offset of text. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`capitalization` readonly | The case of the text. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`color` readonly | The text color. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`contents` readonly | The actual text in the layer. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`direction` readonly | The text orientation. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`fauxBold` readonly | If true, faux bold is used. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`fauxItalic` readonly | If true, faux italic is used. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`firstLineIndent` readonly | The amount to indent the first line of paragraphs. Range: -1296 to 1296. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`font` readonly | The text face of the character. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`hangingPuntuation` readonly | If true, uses Roman hanging punctuation. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`height` readonly | The height of the bounding box for paragraph text. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`horizontalScale` readonly | Character scaling (horizontal) in proportion to horizontal scale. Range: 0 - 1000 as a percentage. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`hyphenLimit` readonly | The maximum number of consecutive lines that can end with a hyphenated word. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`hyphenateAfterFirst` readonly | The number of letters after which hyphenation in word wrap is allowed. Range: 1 to 15. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`hyphenateBeforeLast` readonly | The number of letters before which hyphenation in word wrap is allowed. Range: 1 to 15. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`hyphenateCapitalWords` readonly | If true, capitalized words can be hyphenated. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`hyphenation` readonly | If true, hyphenation is used. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`hyphenationZone` readonly | The distance at the end of a line that will cause a word to break in unjustified type. Range: 0 - 720 picas. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`justification` readonly | The paragraph justification. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`kind` readonly | The type of text. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`language` readonly | The language. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`leading` readonly | The leading amount. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`leftIndent` readonly | The amount to indent text from the left. Range: -1296 to 1296. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ligatures` readonly | If true, ligatures are used. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`oldStyle` readonly | If true, old style is used. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`parent` readonly | The object's container. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`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. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`rightIndent` readonly | The amount to indent text from the right. Range: -1296 to 1296. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`size` readonly | The font size in points. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`spaceAfter` readonly | The amount of space after each paragraph. Range: -1296 to 1296. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`spaceBefore` readonly | The amount of space before each paragraph. Range: -1296 to 1296. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`strikeThru` readonly | The strike through option to use. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`textComposer` readonly | The text composing engine to use. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`tracking` readonly | The amount of uniform spacing between multiple characters. Range: -1000 to 10000. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`typename` readonly | The class name of the object. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`underline` readonly | Options for underlining the text. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`useAutoLeading` readonly | If true, uses the font's built-in leading information. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`verticalScale` readonly | Character scaling (vertical) in proportion to horizontal scale. Range: 0 - 1000 as a percentage. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`warpBend` readonly | The warp bend percentage. Range: -100 to 100. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`warpDirection` readonly | The warp direction. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`warpHorizontalDistortion` readonly | The warp horizontal distortion percentage. Range: -100 to 100. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`warpStyle` readonly | The style of warp. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`warpVerticalDistortion` readonly | The warp vertical distortion percentage. Range: -100 to 100. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`width` readonly | The width of the bounding box for paragraph text. | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Methods ^^^^^^^ +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`convertToShape` readonly | Converts the text object and its containing layer to a fill layer with the text changed to a clipping path. | +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`createPath` readonly | Creates a clipping path from the outlines of the actual text items (such as letters or words). | +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ .. container:: hide .. toctree:: :hidden: :maxdepth: 1 TextItem/parent.rst TextItem/typename.rst TextItem/antiAliasMethod.rst TextItem/autoKerning.rst TextItem/color.rst TextItem/useAutoLeading.rst TextItem/tracking.rst TextItem/verticalScale.rst TextItem/horizontalScale.rst TextItem/baselineShift.rst TextItem/contents.rst TextItem/font.rst TextItem/leading.rst TextItem/ligatures.rst TextItem/alternateLigatures.rst TextItem/oldStyle.rst TextItem/position.rst TextItem/direction.rst TextItem/size.rst TextItem/fauxBold.rst TextItem/fauxItalic.rst TextItem/capitalization.rst TextItem/strikeThru.rst TextItem/underline.rst TextItem/language.rst TextItem/noBreak.rst TextItem/kind.rst TextItem/justification.rst TextItem/leftIndent.rst TextItem/firstLineIndent.rst TextItem/rightIndent.rst TextItem/spaceBefore.rst TextItem/spaceAfter.rst TextItem/hangingPuntuation.rst TextItem/textComposer.rst TextItem/hyphenation.rst TextItem/minimumGlyphScaling.rst TextItem/desiredGlyphScaling.rst TextItem/maximumGlyphScaling.rst TextItem/minimumLetterScaling.rst TextItem/desiredLetterScaling.rst TextItem/maximumLetterScaling.rst TextItem/minimumWordScaling.rst TextItem/desiredWordScaling.rst TextItem/maximumWordScaling.rst TextItem/autoLeadingAmount.rst TextItem/hyphenateWordsLongerThan.rst TextItem/hyphenateAfterFirst.rst TextItem/hyphenateBeforeLast.rst TextItem/hyphenLimit.rst TextItem/hyphenationZone.rst TextItem/hyphenateCapitalWords.rst TextItem/width.rst TextItem/height.rst TextItem/warpStyle.rst TextItem/warpDirection.rst TextItem/warpBend.rst TextItem/warpHorizontalDistortion.rst TextItem/warpVerticalDistortion.rst TextItem/createPath.rst TextItem/convertToShape.rst