Text

A text object.

Go to Property Listing | Method Listing

Hierarchy:

Class: Text

Property Listing

Property	Type	Access	Description
alignToBaseline	Boolean	read/write	If true, aligns the baseline of the text to the baseline grid.
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Text.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Text.
appliedCharacterStyle	CharacterStyle String	read/write	The character style applied to the text. Can also accept: String.
appliedFont	Font String	read/write	The font applied to the Text, specified as either a font object or the name of font family. Can return: Font or String.
appliedLanguage	LanguageWithVendors LanguageCanalsoaccept:String	read/write	The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String.
appliedParagraphStyle	ParagraphStyle String	read/write	The paragraph style applied to the text. Can also accept: String.
ascent	Number String	readonly	The maximum ascent of any character in the text.
associatedXMLElements	Array of XMLItem	readonly	The XML elements associated with the Text.
autoLeading	Number (range 0 - 500)	read/write	The percent of the type size to use for auto leading. (Range: 0 to 500).
balanceRaggedLines	Boolean BalanceLinesStyle BalanceLinesStyle.FULLY_BALANCED BalanceLinesStyle.NO_BALANCING BalanceLinesStyle.PYRAMID_SHAPE BalanceLinesStyle.VEE_SHAPE	read/write	If true or set to an enumeration value, balances ragged lines. Note: Not valid with a single-line text composer. Can return: Boolean or BalanceLinesStyle enumerator.
baseline	Number String	readonly	The vertical offset of the text.
baselineShift	Number String	read/write	The baseline shift applied to the text.
bulletChar	Bullet	readonly	Bullet character.
bulletsAndNumberingColor	AutoEnum AutoEnum.AUTO_VALUE Swatch String	read/write	Color of the bullet or number character. Can return: AutoEnum enumerator, Swatch or String.
bulletsAndNumberingListType	ListType ListType.BULLET_LIST ListType.NO_LIST ListType.NUMBERED_LIST	read/write	List type for bullets and numbering.
bulletsAndNumberingSize	AutoEnum AutoEnum.AUTO_VALUE Real	read/write	Point size of the bullet or number character. Can return: AutoEnum enumerator or Real.
buttons	Buttons Button	readonly	A collection of buttons.
capitalization	Capitalization Capitalization.ALL_CAPS Capitalization.CAP_TO_SMALL_CAP Capitalization.NORMAL Capitalization.SMALL_CAPS	read/write	The capitalization scheme.
characters	Characters Character	readonly	A collection of characters.
composer	String	read/write	The text composer to use to compose the text.
contents	String SpecialCharacters SpecialCharacters.AUTO_PAGE_NUMBER SpecialCharacters.BULLET_CHARACTER SpecialCharacters.COLUMN_BREAK SpecialCharacters.COPYRIGHT_SYMBOL SpecialCharacters.DEGREE_SYMBOL SpecialCharacters.DISCRETIONARY_HYPHEN SpecialCharacters.DOUBLE_LEFT_QUOTE SpecialCharacters.DOUBLE_RIGHT_QUOTE SpecialCharacters.ELLIPSIS_CHARACTER SpecialCharacters.EM_DASH SpecialCharacters.EM_SPACE SpecialCharacters.END_NESTED_STYLE SpecialCharacters.EN_DASH SpecialCharacters.EN_SPACE SpecialCharacters.EVEN_PAGE_BREAK SpecialCharacters.FIGURE_SPACE SpecialCharacters.FLUSH_SPACE SpecialCharacters.FOOTNOTE_SYMBOL SpecialCharacters.FORCED_LINE_BREAK SpecialCharacters.FRAME_BREAK SpecialCharacters.HAIR_SPACE SpecialCharacters.INDENT_HERE_TAB SpecialCharacters.NEXT_PAGE_NUMBER SpecialCharacters.NONBREAKING_HYPHEN SpecialCharacters.NONBREAKING_SPACE SpecialCharacters.ODD_PAGE_BREAK SpecialCharacters.PAGE_BREAK SpecialCharacters.PARAGRAPH_SYMBOL SpecialCharacters.PREVIOUS_PAGE_NUMBER SpecialCharacters.PUNCTUATION_SPACE SpecialCharacters.REGISTERED_TRADEMARK SpecialCharacters.RIGHT_INDENT_TAB SpecialCharacters.SECTION_MARKER SpecialCharacters.SECTION_SYMBOL SpecialCharacters.SINGLE_LEFT_QUOTE SpecialCharacters.SINGLE_RIGHT_QUOTE SpecialCharacters.THIN_SPACE SpecialCharacters.TRADEMARK_SYMBOL	read/write	The contents of the text. Can return: String or SpecialCharacters enumerator.
descent	Number String	readonly	The maximum descent of any character in the text.
desiredGlyphScaling	Number (range 50 - 200)	read/write	The desired width (as a percentage) of individual characters. (Range: 50 to 200)
desiredLetterSpacing	Number	read/write	The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500)
desiredWordSpacing	Number (range 0 - 1000)	read/write	The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)
dropCapCharacters	Number	read/write	Number of characters for drop cap.
dropCapLines	Number	read/write	Number of lines for drop cap.
dropCapStyle	CharacterStyle String	read/write	The character style to apply to the drop cap. Can also accept: String.
fillColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Text. . Can also accept: String.
fillTint	Number (range 0 - 100)	read/write	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.)
firstLineIndent	Number String	read/write	The amount to indent the first line.
fontStyle	String	read/write	The name of the font style.
footnotes	Footnotes Footnote	readonly	A collection of footnotes.
formFields	FormFields FormField	readonly	A collection of form fields.
gradientFillAngle	Number	read/write	The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)
gradientFillLength	Number	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.
gradientFillStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y].
gradientStrokeAngle	Number	read/write	The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180)
gradientStrokeLength	Number	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text.
gradientStrokeStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y].
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
gridAlignFirstLineOnly	Boolean	read/write	If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid.
groups	Groups Group	readonly	A collection of groups.
horizontalOffset	Number String	readonly	The horizontal offset of the text.
horizontalScale	Number	read/write	The horizontal scaling applied to the Text.
hyphenWeight	Number	read/write	Hyphen weight.
hyphenateAfterFirst	Number	read/write	Hyphenate after this many letters.
hyphenateBeforeLast	Number	read/write	Hyphenate before this many letters.
hyphenateCapitalizedWords	Boolean	read/write	If true, allows hyphenation of capitalized words.
hyphenateLadderLimit	Number	read/write	Number of consecutive hyphens to allow.
hyphenateLastWord	Boolean	read/write	If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.
hyphenateWordsLongerThan	Number	read/write	Hyphenate words that have more than this number of letters.
hyphenation	Boolean	read/write	If true, allows hyphenation.
hyphenationZone	Number String	read/write	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.
index	Number	readonly	The index of the text in the collection or parent object.
insertionPoints	InsertionPoints InsertionPoint	readonly	A collection of insertion points.
justification	Justification Justification.AWAY_FROM_BINDING_SIDE Justification.CENTER_ALIGN Justification.CENTER_JUSTIFIED Justification.FULLY_JUSTIFIED Justification.LEFT_ALIGN Justification.LEFT_JUSTIFIED Justification.RIGHT_ALIGN Justification.RIGHT_JUSTIFIED Justification.TO_BINDING_SIDE	read/write	The paragraph alignment.
keepAllLinesTogether	Boolean	read/write	If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.
keepFirstLines	Number	read/write	Keep at least this many lines together at the end of a column.
keepLastLines	Number	read/write	Keep at least this many lines together at the start of a column.
keepLinesTogether	Boolean	read/write	If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.
keepWithNext	Number	read/write	Keep at least this many lines together with the following paragraph.
kerningMethod	String	read/write	The type of pair kerning.
kerningValue	Number	read/write	The amount of space to add or remove between characters, specified in thousands of an em.
lastLineIndent	Number String	read/write	The amount to indent the last line in the paragraph.
leading	Unit Leading Leading.AUTO	read/write	The leading applied to the text. Can return: Unit or Leading enumerator.
leftIndent	Number String	read/write	The width of the left indent.
length	Number	readonly	The number of objects in the collection.
ligatures	Boolean	read/write	If true, replaces specific character combinations (e.g., fl, fi) with ligature characters.
lines	Lines Line	readonly	A collection of lines.
maximumGlyphScaling	Number (range 50 - 200)	read/write	The maximum width (as a percentage) of individual characters. (Range: 50 to 200)
maximumLetterSpacing	Number	read/write	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.
maximumWordSpacing	Number (range 0 - 1000)	read/write	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)
minimumGlyphScaling	Number (range 50 - 200)	read/write	The minimum width (as a percentage) of individual characters. (Range: 50 to 200)
minimumLetterSpacing	Number	read/write	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.
minimumWordSpacing	Number (range 0 - 1000)	read/write	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)
nestedStyles	NestedStyles NestedStyle	readonly	A collection of nested styles.
noBreak	Boolean	read/write	If true, keeps the text on the same line.
notes	Notes Note	readonly	A collection of notes.
numberSeparator	Number	read/write	The numbering separator as a unicode ID.
numberStartAt	Number	read/write	Starting number in a numbered list.
numberingFont	Font String AutoEnum AutoEnum.AUTO_VALUE	read/write	Font of the number character. Can return: Font, String or AutoEnum enumerator.
numberingFontStyle	NothingEnum.NOTHING String AutoEnum AutoEnum.AUTO_VALUE	read/write	Font style of the number character. Can return: String, NothingEnum enumerator or AutoEnum enumerator.
numberingStyle	NumberingStyle NumberingStyle.ARABIC NumberingStyle.LOWER_LETTERS NumberingStyle.LOWER_ROMAN NumberingStyle.UPPER_LETTERS NumberingStyle.UPPER_ROMAN String	read/write	Numbering style. Can return: NumberingStyle enumerator or String.
opentypeFeatures	Array of 2 Strings Array of Longs	read/write	OpenType features. Can return: Array of Array of 2 Strings or Longs.
otfContextualAlternate	Boolean	read/write	If true, uses contextual alternate forms in OpenType fonts.
otfDiscretionaryLigature	Boolean	read/write	If true, uses discretionary ligatures in OpenType fonts.
otfFigureStyle	OTFFigureStyle OTFFigureStyle.DEFAULT_VALUE OTFFigureStyle.PROPORTIONAL_LINING OTFFigureStyle.PROPORTIONAL_OLDSTYLE OTFFigureStyle.TABULAR_LINING OTFFigureStyle.TABULAR_OLDSTYLE	read/write	The figure style in OpenType fonts.
otfFraction	Boolean	read/write	If true, uses fractions in OpenType fonts.
otfHistorical	Boolean	read/write	If true, use historical forms in OpenType fonts.
otfOrdinal	Boolean	read/write	If true, uses ordinals in OpenType fonts.
otfSlashedZero	Boolean	read/write	If true, use a slashed zeroes in OpenType fonts.
otfStylisticSets	Number	read/write	The stylistic sets to use in OpenType fonts.
otfSwash	Boolean	read/write	If true, uses swash forms in OpenType fonts.
otfTitling	Boolean	read/write	If true, uses titling forms in OpenType fonts.
ovals	Ovals Oval	readonly	A collection of ellipses.
overprintFill	Boolean	read/write	If true, the fill color of the characters will overprint.
overprintStroke	Boolean	read/write	If true, the stroke of the characters will overprint.
pageItems	PageItems PageItem	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
paragraphs	Paragraphs Paragraph	readonly	A collection of paragraphs.
parent	Cell Character Footnote InsertionPoint Line Paragraph Story Text TextColumn TextFrame TextStyleRange Word XMLElement Note TextPath	readonly	The parent of the Text (a TextPath, TextFrame, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, InsertionPoint, Story, Cell, XMLElement, Footnote or Note).
parentStory	Story	readonly	The story that contains the text.
parentTextFrames	Array of TextFrames Array of TextPaths TextPath	readonly	An array of the text frames that contain the text. Can return: Array of TextFrames or TextPaths.
pointSize	Number String	read/write	The text size.
polygons	Polygons Polygon	readonly	A collection of polygons.
position	Position Position.NORMAL Position.OT_DENOMINATOR Position.OT_NUMERATOR Position.OT_SUBSCRIPT Position.OT_SUPERSCRIPT Position.SUBSCRIPT Position.SUPERSCRIPT	read/write	The text position relative to the baseline.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
rightIndent	Number String	read/write	The width of the right indent.
ruleAbove	Boolean	read/write	If true, places a rule above the paragraph.
ruleAboveColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.
ruleAboveGapColor	Swatch String	read/write	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.
ruleAboveGapOverprint	Boolean	read/write	If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid.
ruleAboveGapTint	Number (range 0 - 100)	read/write	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.
ruleAboveLeftIndent	Number String	read/write	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.
ruleAboveLineWeight	Number	read/write	The stoke weight of the paragraph rule above.
ruleAboveOffset	Number String	read/write	The amount to offset the paragraph rule above from the baseline of the first line the paragraph.
ruleAboveOverprint	Boolean	read/write	If true, the paragraph rule above will overprint.
ruleAboveRightIndent	Number String	read/write	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.
ruleAboveTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)
ruleAboveType	StrokeStyle String	read/write	The stroke type of the rule above the paragraph. Can return: StrokeStyle or String.
ruleAboveWidth	RuleWidth RuleWidth.COLUMN_WIDTH RuleWidth.TEXT_WIDTH	read/write	The basis (text width or column width) used to calculate the width of the paragraph rule above.
ruleBelow	Boolean	read/write	If true, applies a paragraph rule below.
ruleBelowColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.
ruleBelowGapColor	Swatch String	read/write	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.
ruleBelowGapOverPrint	Boolean	read/write	If true, overprint the paragraph rule below stroke gap color.
ruleBelowGapTint	Number (range 0 - 100)	read/write	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.
ruleBelowLeftIndent	Number String	read/write	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.
ruleBelowLineWeight	Number	read/write	The stroke weight of the paragraph rule below.
ruleBelowOffset	Number String	read/write	The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.
ruleBelowOverPrint	Boolean	read/write	If true, overprint the paragraph rule below.
ruleBelowRightIndent	Number String	read/write	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.
ruleBelowTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)
ruleBelowType	StrokeStyle String	read/write	The stroke type of the rule below the paragraph. Can return: StrokeStyle or String.
ruleBelowWidth	RuleWidth RuleWidth.COLUMN_WIDTH RuleWidth.TEXT_WIDTH	read/write	The basis (text width or column width) used to calculate the width of the paragraph rule below.
singleWordJustification	SingleWordJustification SingleWordJustification.CENTER_ALIGN SingleWordJustification.FULLY_JUSTIFIED SingleWordJustification.LEFT_ALIGN SingleWordJustification.RIGHT_ALIGN	read/write	The alignment to use for lines that contain a single word.
skew	Number	read/write	The skew angle of the Text.
spaceAfter	Number String	read/write	The height of the paragraph space below.
spaceBefore	Number String	read/write	The height of the paragraph space above.
startParagraph	StartParagraph StartParagraph.ANYWHERE StartParagraph.NEXT_COLUMN StartParagraph.NEXT_EVEN_PAGE StartParagraph.NEXT_FRAME StartParagraph.NEXT_ODD_PAGE StartParagraph.NEXT_PAGE	read/write	The location at which to start the paragraph.
strikeThroughColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapOverprint	Boolean	read/write	If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.
strikeThroughGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid.
strikeThroughOffset	Number String	read/write	The amount by which to offset the strikethrough stroke from the text baseline.
strikeThroughOverprint	Boolean	read/write	If true, the strikethrough stroke will overprint.
strikeThroughTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)
strikeThroughType	StrokeStyle String	read/write	The stroke type of the strikethrough stroke. Can return: StrokeStyle or String.
strikeThroughWeight	Number String	read/write	The stroke weight of the strikethrough stroke.
strikeThru	Boolean	read/write	If true, draws a strikethrough line through the text.
strokeColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Text. Can also accept: String.
strokeTint	Number (range 0 - 100)	read/write	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.)
strokeWeight	Number String	read/write	The stroke weight applied to the characters of the text.
tabList	Array of Arrays of Property Name/Value Pairs.	read/write	A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs.
tabStops	TabStops TabStop	readonly	A collection of tab stops.
tables	Tables Table	readonly	A collection of tables.
textColumns	TextColumns TextColumn	readonly	A collection of text columns.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
textStyleRanges	TextStyleRanges TextStyleRange	readonly	A collection of text style ranges.
texts	Texts Text	readonly	A collection of text objects.
tracking	Number	read/write	The amount by which to loosen or tighten a block of text, specified in thousands of an em.
underline	Boolean	read/write	If true, underlines the text.
underlineColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.
underlineGapColor	Swatch String	read/write	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.
underlineGapOverprint	Boolean	read/write	If true, the gap color of the underline stroke will overprint.
underlineGapTint	Number (range 0 - 100)	read/write	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.
underlineOffset	Number String	read/write	The amount by which to offset the underline from the text baseline.
underlineOverprint	Boolean	read/write	If true, the underline stroke color will overprint.
underlineTint	Number (range 0 - 100)	read/write	The underline stroke tint (as a percentage). (Range: 0 to 100)
underlineType	StrokeStyle String	read/write	The stroke type of the underline stroke. Can return: StrokeStyle or String.
underlineWeight	Number String	read/write	The stroke weight of the underline stroke.
verticalScale	Number	read/write	The vertical scaling applied to the Text.
words	Words Word	readonly	A collection of words.

Method Listing

undefined applyBullets (bulletChar:Number, bulletType:BulletCharacterType, bulletFont:Varies Font String, bulletFontStyle:String, bulletSize:Number, bulletColor:Swatch, [bulletAlignment:ListAlignment=ListAlignment], listLeftIndent:Number, listFirstLineIndent:Number, listFirstTabPosition:Number)

Apply bullets

Parameter	Type	Description
bulletChar	Number	The bullet character as a unicode ID or a glyph ID (Optional)
bulletType	BulletCharacterType BulletCharacterType.GLYPH_WITH_FONT BulletCharacterType.UNICODE_ONLY BulletCharacterType.UNICODE_WITH_FONT	The type of bullet character (Optional)
bulletFont	Font String	The bullet font. Can accept: Font or String. (Optional)
bulletFontStyle	String	The bullet font style (Optional)
bulletSize	Number	The size of the bullet character (Optional)
bulletColor	Swatch	The color of the bullet character (Optional)
bulletAlignment	ListAlignment ListAlignment.CUSTOM_ALIGNED_LIST ListAlignment.FLUSH_LEFT_LIST ListAlignment.HANGING_LIST	The alignment of the bulleted list (Optional) (default: ListAlignment.HANGING_LIST)
listLeftIndent	Number	The left indent of the bulleted list (Optional)
listFirstLineIndent	Number	The first line indent of the bulleted list (Optional)
listFirstTabPosition	Number	The first tab position in the bulleted list (Optional)

undefined applyNumbers (numberingStyle:NumberingStyle, numberingSeparator:Number, startingValue:Number, numberFont:Varies Font String, numberFontStyle:String, numberSize:Number, numberColor:Swatch, [numberAlignment:ListAlignment=ListAlignment], listLeftIndent:Number, listFirstLineIndent:Number, listFirstTabPosition:Number)

Apply numbers

Parameter	Type	Description
numberingStyle	NumberingStyle NumberingStyle.ARABIC NumberingStyle.LOWER_LETTERS NumberingStyle.LOWER_ROMAN NumberingStyle.UPPER_LETTERS NumberingStyle.UPPER_ROMAN	The numbering style to be used (Optional)
numberingSeparator	Number	The separator used for numbering (Optional)
startingValue	Number	The value with which to start numbering (Optional)
numberFont	Font String	The number font. Can accept: Font or String. (Optional)
numberFontStyle	String	The number font style (Optional)
numberSize	Number	The size of the number character(s) (Optional)
numberColor	Swatch	The color of the number character(s) (Optional)
numberAlignment	ListAlignment ListAlignment.CUSTOM_ALIGNED_LIST ListAlignment.FLUSH_LEFT_LIST ListAlignment.HANGING_LIST	The alignment of the numbered list (Optional) (default: ListAlignment.HANGING_LIST)
listLeftIndent	Number	The left indent of the numbered list (Optional)
listFirstLineIndent	Number	The first line indent of the numbered list (Optional)
listFirstTabPosition	Number	The first tab position in the numbered list (Optional)

undefined applyStyle (using:Varies ParagraphStyle CharacterStyle, [clearingOverrides:Boolean=Boolean])

Applies the specified character style or paragraph style.

Parameter	Type	Description
using	ParagraphStyle CharacterStyle	The style to apply. Can accept: ParagraphStyle or CharacterStyle.
clearingOverrides	Boolean	If true, clears existing text attributes or character styles before applying the style. Note: Valid only when the using parameter specifies a paragraph style. (Optional) (default: true)

Parameter

Type

Description

using

ParagraphStyle

CharacterStyle

The style to apply. Can accept: ParagraphStyle or CharacterStyle.

clearingOverrides

Boolean

If true, clears existing text attributes or character styles before applying the style. Note: Valid only when the using parameter specifies a paragraph style. (Optional)

(default: true)

undefined changecase (using:ChangecaseMode)

Sets the case of the text.

Parameter	Type	Description
using	ChangecaseMode ChangecaseMode.LOWERCASE ChangecaseMode.SENTENCECASE ChangecaseMode.TITLECASE ChangecaseMode.UPPERCASE	The text case option.

Parameter

Type

Description

using

ChangecaseMode

ChangecaseMode.LOWERCASE

ChangecaseMode.SENTENCECASE

ChangecaseMode.TITLECASE

ChangecaseMode.UPPERCASE

The text case option.

undefined clearOverrides ([overridesToClear:OverrideType=OverrideType])

Clears the specified types of override.

Parameter	Type	Description
overridesToClear	OverrideType OverrideType.ALL OverrideType.CHARACTER_ONLY OverrideType.PARAGRAPH_ONLY	The types of override to clear. (Optional) (default: OverrideType.ALL)

Parameter

Type

Description

overridesToClear

OverrideType

OverrideType.ALL

OverrideType.CHARACTER_ONLY

OverrideType.PARAGRAPH_ONLY

The types of override to clear. (Optional)

(default: OverrideType.ALL)

undefined convertBulletsAndNumberingToText ()

Convert bullets and numbering to text.

Note convertToNote ()

Converts the text to a note.

Table convertToTable (columnSeparator:String, rowSeparator:String, [numberOfColumns:Number=Number])

Converts the text to a table.

Parameter	Type	Description
columnSeparator	String	The character that starts a new column in the new table. (Optional)
rowSeparator	String	The character starts a new row in the new table. (Optional)
numberOfColumns	Number	The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) (default: 1)

Parameter

Type

Description

columnSeparator

String

The character that starts a new column in the new table. (Optional)

rowSeparator

String

The character starts a new row in the new table. (Optional)

numberOfColumns

Number

The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional)

(default: 1)

PageItem createOutlines ([deleteOriginal:Boolean=Boolean])

Converts text to outlines. Each line of text becomes a polygon object. When the converted text is a single letter that has no internal spaces or detached parts, the polygon contains only a single path. Note: To determine whether a font allows the creation of outlines, see allow outlines.

Parameter	Type	Description
deleteOriginal	Boolean	If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true)

Parameter

Type

Description

deleteOriginal

Boolean

If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)

(default: true)

undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset)

Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat ExportFormat.EPS_TYPE ExportFormat.INCOPY ExportFormat.INCOPY_CS2_STORY ExportFormat.INDESIGN_INTERCHANGE ExportFormat.INDESIGN_SNIPPET ExportFormat.JPG ExportFormat.PDF_TYPE ExportFormat.RTF ExportFormat.SVG ExportFormat.SVG_COMPRESSED ExportFormat.TAGGED_TEXT ExportFormat.TEXT_TYPE ExportFormat.XML String	The export format. Can accept: ExportFormat enumerator or String.
to	File	The path of the export file.
showingOptions	Boolean	If true, prompts the user to select export options. (Optional) (default: false)
using	PDFExportPreset	The export style to use. (Optional)

Object getElements ()

Resolves the object specifier, creating an array of object references.

undefined markup (using:XMLElement)

Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

Text move (to:LocationOptions, reference:Varies Cell Column Row Story Table Text PageItem)

Moves the text to the specified location.

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location relative to the reference object or within the containing object.
reference	Cell Column Row Story Table Text PageItem	The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)

Varies place (fileName:File, [showingOptions:Boolean=Boolean], withProperties:Object)

Place a file

Parameter	Type	Description
fileName	File	The file to place
showingOptions	Boolean	Whether to display the import options dialog (Optional) (default: false)
withProperties	Object	Initial values for properties of the placed object(s) (Optional)

Parameter

Type

Description

fileName

File

The file to place

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

withProperties

Object

Initial values for properties of the placed object(s) (Optional)

undefined recompose ()

Recomposes the text in the Text.

undefined remove ()

Deletes the Text.

undefined removeBulletsAndNumbers ()

Remove bullets and numbers

Text search (for:String, wholeWord:Boolean, caseSensitive:Boolean, replacingWith:String, withFindAttributes:Object, withChangeAttributes:Object)

Look for occurrences of text that matches specific criteria

Parameter	Type	Description
for	String	What to look for (Optional)
wholeWord	Boolean	If true, then disregard text embedded within a larger word (Optional)
caseSensitive	Boolean	If true, then search only for text that matches case (Optional)
replacingWith	String	What to replace the found text with, either a string or a special character (Optional)
withFindAttributes	Object	A record of find preference settings to use (Optional)
withChangeAttributes	Object	A record of change preference settings to use (Optional)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the Text in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

The selection status of the Text in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

String toSource ()

Generates a string which, if executed, will return the Text.