Package | com.adobe.incopy |
Class | public class Text |
Inheritance | Text ![]() ![]() |
Subclasses | Character, InsertionPoint, Line, Paragraph, TextColumn, TextStyleRange, Word |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
alignToBaseline : Boolean
If true, aligns the baseline of the text to the baseline grid. | Text | ||
allGraphics : Object [read-only]
Lists all graphics contained by the Text. | Text | ||
allowArbitraryHyphenation : Boolean
If true, words unassociated with a hyphenation dictionary can break to the next line on any character. | Text | ||
allPageItems : Object [read-only]
Lists all page items contained by the Text. | Text | ||
appliedCharacterStyle : CharacterStyle
The character style applied to the text. | Text | ||
appliedConditions : Object
The applied conditions. | Text | ||
appliedFont : Object
The font applied to the Text, specified as either a font object or the name of font family. | Text | ||
appliedLanguage : Object
The language of the text. | Text | ||
appliedNestedStyles : Object [read-only]
The applied character styles dictated by nested styles. | Text | ||
appliedNumberingList : Object
The list to be part of. | Text | ||
appliedParagraphStyle : ParagraphStyle
The paragraph style applied to the text. | Text | ||
ascent : Object [read-only]
The maximum ascent of any character in the text. | Text | ||
associatedXMLElements : Object [read-only]
The XML elements associated with the Text. | Text | ||
autoLeading : Number
The percent of the type size to use for auto leading. | Text | ||
autoTcy : Number
The number of half-width characters at or below which the characters automatically run horizontally in vertical text. | Text | ||
autoTcyIncludeRoman : Boolean
If true, auto tcy includes Roman characters. | Text | ||
balanceRaggedLines : Object
If true or set to an enumeration value, balances ragged lines. | Text | ||
baseline : Object [read-only]
The vertical offset of the text. | Text | ||
baselineShift : Object
The baseline shift applied to the text. | Text | ||
bulletChar : Bullet [read-only]
Bullet character. | Text | ||
bulletsAlignment : ListAlignment
The alignment of the bullet character. | Text | ||
bulletsAndNumberingListType : ListType
List type for bullets and numbering. | Text | ||
bulletsCharacterStyle : Object
The character style to be used for the text after string. | Text | ||
bulletsTextAfter : String
The text after string expression for bullets. | Text | ||
bunriKinshi : Boolean
If true, adds the double period (..), ellipse (...), and double hyphen (--) to the selected kinsoku set. | Text | ||
buttons : Buttons [read-only]
A collection of buttons. | Text | ||
capitalization : Capitalization
The capitalization scheme. | Text | ||
characterAlignment : CharacterAlignment
The alignment of small characters to the largest character in the line. | Text | ||
characterDirection : CharacterDirectionOptions
The direction of the character. | Text | ||
characterRotation : Number
The rotation angle (in degrees) of individual characters. | Text | ||
characters : Characters [read-only]
A collection of characters. | Text | ||
cjkGridTracking : Boolean
If true, uses grid tracking to track non-Roman characters in CJK grids. | Text | ||
composer : String
The text composer to use to compose the text. | Text | ||
contents : Object
The contents of the text. | Text | ||
descent : Object [read-only]
The maximum descent of any character in the text. | Text | ||
desiredGlyphScaling : Number
The desired width (as a percentage) of individual characters. | Text | ||
desiredLetterSpacing : Number
The desired letter spacing, specified as a percentge of the built-in space between letters in the font. | Text | ||
desiredWordSpacing : Number
The desired word spacing, specified as a percentage of the font word space value. | Text | ||
diacriticPosition : DiacriticPositionOptions
Position of diacriticical characters. | Text | ||
digitsType : DigitsTypeOptions
The digits type. | Text | ||
dropCapCharacters : Number
The number of characters to drop cap. | Text | ||
dropcapDetail : Number
Details about the drop cap based on the glyph outlines. | Text | ||
dropCapLines : Number
The number of lines to drop cap. | Text | ||
dropCapStyle : CharacterStyle
The character style to apply to the drop cap. | Text | ||
endBaseline : Object [read-only]
Vertical offset of the end of the text. | Text | ||
endHorizontalOffset : Object [read-only]
Horizontal offset of the end of the text. | Text | ||
endJoin : OutlineJoin
The stroke join type applied to the characters of the text. | Text | ||
epstexts : EPSTexts [read-only]
EPSTexts
| Text | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Text | ||
events : Events [read-only]
A collection of events. | Text | ||
fillColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Text. | Text | ||
fillTint : Number
The tint (as a percentage) of the fill color of the Text. | Text | ||
firstLineIndent : Object
The amount to indent the first line. | Text | ||
fontStyle : String
The name of the font style. | Text | ||
footnotes : Footnotes [read-only]
A collection of footnotes. | Text | ||
formFields : FormFields [read-only]
A collection of form fields. | Text | ||
glyphForm : AlternateGlyphForms
The glyph variant to substitute for standard glyphs. | Text | ||
gradientFillAngle : Number
The angle of a linear gradient applied to the fill of the text. | Text | ||
gradientFillLength : Number
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. | Text | ||
gradientFillStart : Object
The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. | Text | ||
gradientStrokeAngle : Number
The angle of a linear gradient applied to the stroke of the text. | Text | ||
gradientStrokeLength : Number
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. | Text | ||
gradientStrokeStart : Object
The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. | Text | ||
graphicLines : GraphicLines [read-only]
A collection of graphic lines. | Text | ||
gridAlignFirstLineOnly : Boolean
If true, aligns only the first line to the frame grid or baseline grid. | Text | ||
gridAlignment : GridAlignment
The alignment to the frame grid or baseline grid. | Text | ||
gridGyoudori : Number
The manual gyoudori setting. | Text | ||
groups : Groups [read-only]
A collection of groups. | Text | ||
hiddenTexts : HiddenTexts [read-only]
A collection of hidden text objects. | Text | ||
horizontalOffset : Object [read-only]
The horizontal offset of the text. | Text | ||
horizontalScale : Number
The horizontal scaling applied to the Text. | Text | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
hyphenateAcrossColumns : Boolean
If true, allows the last word in a text column to be hyphenated. | Text | ||
hyphenateAfterFirst : Number
The mininum number of letters at the beginning of a word that can be broken by a hyphen. | Text | ||
hyphenateBeforeLast : Number
The minimum number of letters at the end of a word that can be broken by a hyphen. | Text | ||
hyphenateCapitalizedWords : Boolean
If true, allows hyphenation of capitalized words. | Text | ||
hyphenateLadderLimit : Number
The maximum number of hyphens that can appear on consecutive lines. | Text | ||
hyphenateLastWord : Boolean
If true, allows hyphenation in the last word in a paragraph. | Text | ||
hyphenateWordsLongerThan : Number
The minimum number of letters a word must have in order to qualify for hyphenation. | Text | ||
hyphenation : Boolean
If true, allows hyphenation. | Text | ||
hyphenationZone : Object
The amount of white space allowed at the end of a line of non-justified text before hypenation begins. | Text | ||
hyphenWeight : Number
The relative desirability of better spacing vs. | Text | ||
ignoreEdgeAlignment : Boolean
If true, ignores optical edge alignment for the paragraph. | Text | ||
index : Number [read-only]
The index of the text in the collection or parent object. | Text | ||
insertionPoints : InsertionPoints [read-only]
A collection of insertion points. | Text | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Text | ||
jidori : Number
The number of grid squares in which to arrange the text. | Text | ||
justification : Justification
The paragraph alignment. | Text | ||
kashidas : KashidasOptions
Use of Kashidas for justification
| Text | ||
keepAllLinesTogether : Boolean
If true, keeps all lines of the paragraph together. | Text | ||
keepFirstLines : Number
The minimum number of lines to keep together in a paragraph before allowing a page break. | Text | ||
keepLastLines : Number
The minimum number of lines to keep together in a paragraph after a page break. | Text | ||
keepLinesTogether : Boolean
If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. | Text | ||
keepRuleAboveInFrame : Boolean
If true, forces the rule above the paragraph to remain in the frame bounds. | Text | ||
keepWithNext : Number
The minimum number of lines to keep with the next paragraph. | Text | ||
keepWithPrevious : Boolean
If the first line in the paragraph should be kept with the last line of previous paragraph. | Text | ||
kentenAlignment : KentenAlignment
The alignment of kenten characters relative to the parent characters. | Text | ||
kentenCharacterSet : KentenCharacterSet
The character set used for the custom kenten character. | Text | ||
kentenCustomCharacter : String
The character used for kenten. | Text | ||
kentenFillColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. | Text | ||
kentenFont : Object
The font to use for kenten characters. | Text | ||
kentenFontSize : Number
The size (in points) of kenten characters. | Text | ||
kentenFontStyle : Object
The font style of kenten characters. | Text | ||
kentenKind : KentenCharacter
The style of kenten characters. | Text | ||
kentenOverprintFill : AdornmentOverprint
The method of overprinting the kenten fill. | Text | ||
kentenOverprintStroke : AdornmentOverprint
The method of overprinting the kenten stroke. | Text | ||
kentenPlacement : Number
The distance between kenten characters and their parent characters. | Text | ||
kentenPosition : RubyKentenPosition
The kenten position relative to the parent character. | Text | ||
kentenStrokeColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. | Text | ||
kentenStrokeTint : Number
The stroke tint (as a percentage) of kenten characters. | Text | ||
kentenTint : Number
The fill tint (as a percentage) of kenten characters. | Text | ||
kentenWeight : Number
The stroke weight (in points) of kenten characters. | Text | ||
kentenXScale : Number
The horizontal size of kenten characters as a percent of the original size. | Text | ||
kentenYScale : Number
The vertical size of kenten charachers as a percent of the original size. | Text | ||
kerningMethod : String
The type of pair kerning. | Text | ||
kerningValue : Number
The amount of space to add or remove between characters, specified in thousands of an em. | Text | ||
keyboardDirection : CharacterDirectionOptions
The keyboard direction of the character. | Text | ||
kinsokuHangType : KinsokuHangTypes
The type of hanging punctuation to allow. | Text | ||
kinsokuSet : Object
The kinsoku set that determines legitimate line breaks. | Text | ||
kinsokuType : KinsokuType
The type of kinsoku processing for preventing kinsoku characters from beginning or ending a line. | Text | ||
lastLineIndent : Object
The amount to indent the last line in the paragraph. | Text | ||
leading : Object
The leading applied to the text. | Text | ||
leadingAki : Number
The amount of space before each character. | Text | ||
leadingModel : LeadingModel
The point from which leading is measured from line to line. | Text | ||
leftIndent : Object
The width of the left indent. | Text | ||
length : Number [read-only]
The number of objects in the collection. | Text | ||
ligatures : Boolean
If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. | Text | ||
lines : Lines [read-only]
A collection of lines. | Text | ||
maximumGlyphScaling : Number
The maximum width (as a percentage) of individual characters. | Text | ||
maximumLetterSpacing : Number
The maximum letter spacing, specified as a percentge of the built-in space between letters in the font. | Text | ||
maximumWordSpacing : Number
The maximum word spacing, specified as a percentage of the font word space value. | Text | ||
minimumGlyphScaling : Number
The minimum width (as a percentage) of individual characters. | Text | ||
minimumLetterSpacing : Number
The minimum letter spacing, specified as a percentge of the built-in space between letters in the font. | Text | ||
minimumWordSpacing : Number
The minimum word spacing, specified as a percentage of the font word space value. | Text | ||
miterLimit : Number
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | Text | ||
mojikumi : Object
The mojikumi table. | Text | ||
multiStateObjects : MultiStateObjects [read-only]
A collection of multi-state objects. | Text | ||
nestedGrepStyles : NestedGrepStyles [read-only]
A collection of nested GREP styles. | Text | ||
nestedLineStyles : NestedLineStyles [read-only]
A collection of nested line styles. | Text | ||
nestedStyles : NestedStyles [read-only]
A collection of nested styles. | Text | ||
noBreak : Boolean
If true, keeps the text on the same line. | Text | ||
notes : Notes [read-only]
A collection of notes. | Text | ||
numberingAlignment : ListAlignment
The alignment of the number. | Text | ||
numberingApplyRestartPolicy : Boolean
If true, apply the numbering restart policy. | Text | ||
numberingCharacterStyle : Object
The character style to be used for the number string. | Text | ||
numberingContinue : Boolean
Continue the numbering at this level. | Text | ||
numberingExpression : String
The number string expression for numbering. | Text | ||
numberingFormat : Object
Numbering format options. | Text | ||
numberingLevel : Number
The level of the paragraph. | Text | ||
numberingRestartPolicies : NumberingRestartPolicy [read-only]
Numbering restart policies. | Text | ||
numberingStartAt : Number
Determines starting number in a numbered list. | Text | ||
opentypeFeatures : Object
OpenType features. | Text | ||
otfContextualAlternate : Boolean
If true, uses contextual alternate forms in OpenType fonts. | Text | ||
otfDiscretionaryLigature : Boolean
If true, uses discretionary ligatures in OpenType fonts. | Text | ||
otfFigureStyle : OTFFigureStyle
The figure style in OpenType fonts. | Text | ||
otfFraction : Boolean
If true, uses fractions in OpenType fonts. | Text | ||
otfHistorical : Boolean
If true, use historical forms in OpenType fonts. | Text | ||
otfHVKana : Boolean
If true, switches hiragana fonts, which have different glyphs for horizontal and vertical. | Text | ||
otfJustificationAlternate : Boolean
If true, use alternate justification forms in OpenType fonts
| Text | ||
otfLocale : Boolean
If true, uses localized forms in OpenType fonts. | Text | ||
otfMark : Boolean
If true, uses mark positioning in OpenType fonts. | Text | ||
otfOrdinal : Boolean
If true, uses ordinals in OpenType fonts. | Text | ||
otfOverlapSwash : Boolean
If true, use overlapping swash forms in OpenType fonts
| Text | ||
otfProportionalMetrics : Boolean
If true, kerns according to proportional CJK metrics in OpenType fonts. | Text | ||
otfRomanItalics : Boolean
If true, applies italics to half-width alphanumerics. | Text | ||
otfSlashedZero : Boolean
If true, use a slashed zeroes in OpenType fonts. | Text | ||
otfStretchedAlternate : Boolean
If true, use stretched alternate forms in OpenType fonts
| Text | ||
otfStylisticAlternate : Boolean
If true, use stylistic alternate forms in OpenType fonts
| Text | ||
otfStylisticSets : Number
The stylistic sets to use in OpenType fonts. | Text | ||
otfSwash : Boolean
If true, uses swash forms in OpenType fonts. | Text | ||
otfTitling : Boolean
If true, uses titling forms in OpenType fonts. | Text | ||
ovals : Ovals [read-only]
A collection of ellipses. | Text | ||
overprintFill : Boolean
If true, the fill color of the characters will overprint. | Text | ||
overprintStroke : Boolean
If true, the stroke of the characters will overprint. | Text | ||
pageItems : PageItems [read-only]
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. | Text | ||
paragraphDirection : ParagraphDirectionOptions
Paragraph direction. | Text | ||
paragraphGyoudori : Boolean
If true, the gyoudori mode applies to the entire paragraph. | Text | ||
paragraphJustification : ParagraphJustificationOptions
Paragraph justification. | Text | ||
paragraphs : Paragraphs [read-only]
A collection of paragraphs. | Text | ||
parent : Object [read-only]
The parent of the Text (a XmlStory, TextPath, TextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story, Cell, XMLElement, Footnote, Note, Change or HiddenText). | Text | ||
parentStory : Story [read-only]
The story that contains the text. | Text | ||
parentTextFrames : Object [read-only]
An array of the text frames that contain the text. | Text | ||
pointSize : Object
The text size. | Text | ||
polygons : Polygons [read-only]
A collection of polygons. | Text | ||
position : Position
The text position relative to the baseline. | Text | ||
positionalForm : PositionalForms
The OpenType positional form. | Text | ||
preferences : Preferences [read-only]
A collection of preferences objects. | Text | ||
properties : Object
A property that allows setting of several properties at the same time. | Text | ||
rectangles : Rectangles [read-only]
A collection of rectangles. | Text | ||
rensuuji : Boolean
If true, disallows line breaks in numbers. | Text | ||
rightIndent : Object
The width of the right indent. | Text | ||
rotateSingleByteCharacters : Boolean
If true, rotates Roman characters in vertical text. | Text | ||
rubyAlignment : RubyAlignments
The ruby alignment. | Text | ||
rubyAutoAlign : Boolean
If true, auto aligns ruby. | Text | ||
rubyAutoScaling : Boolean
If true, automatically scales ruby to the specified percent of parent text size. | Text | ||
rubyAutoTcyAutoScale : Boolean
If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em. | Text | ||
rubyAutoTcyDigits : Number
The number of digits included in auto tcy (tate-chuu-yoko) in ruby. | Text | ||
rubyAutoTcyIncludeRoman : Boolean
If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. | Text | ||
rubyFill : Object
The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. | Text | ||
rubyFlag : Boolean
If true, ruby is on. | Text | ||
rubyFont : Object
The font applied to ruby characters. | Text | ||
rubyFontSize : Number
The size (in points) of ruby characters. | Text | ||
rubyFontStyle : Object
The font style of ruby characters. | Text | ||
rubyOpenTypePro : Boolean
If true, uses OpenType Pro fonts for ruby. | Text | ||
rubyOverhang : Boolean
If true, constrains ruby overhang to the specified amount. | Text | ||
rubyOverprintFill : AdornmentOverprint
The method of overprinting the ruby fill. | Text | ||
rubyOverprintStroke : AdornmentOverprint
The method of overprinting the ruby stroke. | Text | ||
rubyParentOverhangAmount : RubyOverhang
The amount by which ruby characters can overhang the parent text. | Text | ||
rubyParentScalingPercent : Number
The amount (as a percentage) to scale the parent text size to determine the ruby text size. | Text | ||
rubyParentSpacing : RubyParentSpacing
The ruby spacing relative to the parent text. | Text | ||
rubyPosition : RubyKentenPosition
The position of ruby characters relative to the parent text. | Text | ||
rubyString : String
The ruby string contents. | Text | ||
rubyStroke : Object
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. | Text | ||
rubyStrokeTint : Number
The stroke tint (as a percentage) of ruby characters. | Text | ||
rubyTint : Number
The tint (as a percentage) of the ruby fill color. | Text | ||
rubyType : RubyTypes
The ruby type. | Text | ||
rubyWeight : Number
The stroke weight (in points) of ruby characters. | Text | ||
rubyXOffset : Number
The amount of horizontal space between ruby and parent characters. | Text | ||
rubyXScale : Number
The horizontal size of ruby characters, specified as a percent of the original size. | Text | ||
rubyYOffset : Number
The amount of vertical space between ruby and parent characters. | Text | ||
rubyYScale : Number
The vertical size of ruby characters, specified as a percent of the original size. | Text | ||
ruleAbove : Boolean
If true, places a rule above the paragraph. | Text | ||
ruleAboveColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. | Text | ||
ruleAboveGapColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule above. | Text | ||
ruleAboveGapOverprint : Boolean
If true, the stroke gap of the paragraph rule above will overprint. | Text | ||
ruleAboveGapTint : Number
The tint (as a percentage) of the stroke gap color of the paragraph rule. | Text | ||
ruleAboveLeftIndent : Object
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. | Text | ||
ruleAboveLineWeight : Object
The line weight of the rule above. | Text | ||
ruleAboveOffset : Object
The amount to offset the paragraph rule above from the baseline of the first line the paragraph. | Text | ||
ruleAboveOverprint : Boolean
If true, the paragraph rule above will overprint. | Text | ||
ruleAboveRightIndent : Object
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. | Text | ||
ruleAboveTint : Number
The tint (as a percentage) of the paragraph rule above. | Text | ||
ruleAboveType : Object
The stroke type of the rule above the paragraph. | Text | ||
ruleAboveWidth : RuleWidth
The basis (text width or column width) used to calculate the width of the paragraph rule above. | Text | ||
ruleBelow : Boolean
If true, applies a paragraph rule below. | Text | ||
ruleBelowColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. | Text | ||
ruleBelowGapColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule below. | Text | ||
ruleBelowGapOverprint : Boolean
If true, the gap color of the rule below will overprint. | Text | ||
ruleBelowGapTint : Number
The tint (as a percentage) of the stroke gap color of the paragraph rule below. | Text | ||
ruleBelowLeftIndent : Object
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. | Text | ||
ruleBelowLineWeight : Object
The line weight of the rule below. | Text | ||
ruleBelowOffset : Object
The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph. | Text | ||
ruleBelowOverprint : Boolean
If true, the rule below will overprint. | Text | ||
ruleBelowRightIndent : Object
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. | Text | ||
ruleBelowTint : Number
The tint (as a percentage) of the paragraph rule below. | Text | ||
ruleBelowType : Object
The stroke type of the rule below the paragraph. | Text | ||
ruleBelowWidth : RuleWidth
The basis (text width or column width) used to calculate the width of the paragraph rule below. | Text | ||
scaleAffectsLineHeight : Boolean
If true, the line changes size when characters are scaled. | Text | ||
shataiAdjustRotation : Boolean
If true, applies shatai rotation. | Text | ||
shataiAdjustTsume : Boolean
If true, adjusts shatai tsume. | Text | ||
shataiDegreeAngle : Number
The shatai lens angle (in degrees). | Text | ||
shataiMagnification : Number
The amount (as a percentage) of shatai obliquing to apply. | Text | ||
singleWordJustification : SingleWordJustification
The alignment to use for lines that contain a single word. | Text | ||
skew : Number
The skew angle of the Text. | Text | ||
spaceAfter : Object
The height of the paragraph space below. | Text | ||
spaceBefore : Object
The height of the paragraph space above. | Text | ||
spanColumnMinSpaceAfter : Object
The minimum space after a span or a split column
| Text | ||
spanColumnMinSpaceBefore : Object
The minimum space before a span or a split column
| Text | ||
spanColumnType : SpanColumnTypeOptions
Whether a paragraph should be a single column, span columns or split columns
| Text | ||
spanSplitColumnCount : Object
The number of columns a paragraph spans or the number of split columns. | Text | ||
splineItems : SplineItems [read-only]
The spline items collection. | Text | ||
splitColumnInsideGutter : Object
The inside gutter if the paragraph splits columns
| Text | ||
splitColumnOutsideGutter : Object
The outside gutter if the paragraph splits columns
| Text | ||
startParagraph : StartParagraph
The location at which to start the paragraph. | Text | ||
strikeThroughColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. | Text | ||
strikeThroughGapColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. | Text | ||
strikeThroughGapOverprint : Boolean
If true, the gap color of the strikethrough stroke will overprint. | Text | ||
strikeThroughGapTint : Number
The tint (as a percentage) of the strikethrough stroke gap color. | Text | ||
strikeThroughOffset : Object
The amount by which to offset the strikethrough stroke from the text baseline. | Text | ||
strikeThroughOverprint : Boolean
If true, the strikethrough stroke will overprint. | Text | ||
strikeThroughTint : Number
The tint (as a percentage) of the strikethrough stroke. | Text | ||
strikeThroughType : Object
The stroke type of the strikethrough stroke. | Text | ||
strikeThroughWeight : Object
The stroke weight of the strikethrough stroke. | Text | ||
strikeThru : Boolean
If true, draws a strikethrough line through the text. | Text | ||
strokeAlignment : TextStrokeAlign
The stroke alignment applied to the text. | Text | ||
strokeColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Text. | Text | ||
strokeTint : Number
The tint (as a percentage) of the stroke color of the Text. | Text | ||
strokeWeight : Object
The stroke weight applied to the characters of the text. | Text | ||
styleOverridden : Boolean [read-only]
If true, the applied style has been overridden with additional attributes. | Text | ||
tables : Tables [read-only]
A collection of tables. | Text | ||
tabList : Object
A list of the tab stops in the paragraph. | Text | ||
tabStops : TabStops [read-only]
A collection of tab stops. | Text | ||
tatechuyoko : Boolean
If true, makes the character horizontal in vertical text. | Text | ||
tatechuyokoXOffset : Number
The horizontal offset for horizontal characters in vertical text. | Text | ||
tatechuyokoYOffset : Number
The vertical offset for horizontal characters in vertical text. | Text | ||
textColumns : TextColumns [read-only]
A collection of text columns. | Text | ||
textFrames : TextFrames [read-only]
A collection of text frames. | Text | ||
texts : Texts [read-only]
A collection of text objects. | Text | ||
textStyleRanges : TextStyleRanges [read-only]
A collection of text style ranges. | Text | ||
textVariableInstances : TextVariableInstances [read-only]
A collection of text variable instances. | Text | ||
tracking : Number
The amount by which to loosen or tighten a block of text, specified in thousands of an em. | Text | ||
trailingAki : Number
The amount of space after each character. | Text | ||
treatIdeographicSpaceAsSpace : Boolean
If true, ideographic spaces will not wrap to the next line like text characters. | Text | ||
tsume : Number
The amount of horizontal character compression. | Text | ||
underline : Boolean
If true, underlines the text. | Text | ||
underlineColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. | Text | ||
underlineGapColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the gap of the underline stroke. | Text | ||
underlineGapOverprint : Boolean
If true, the gap color of the underline stroke will overprint. | Text | ||
underlineGapTint : Number
The tint (as a percentage) of the gap color of the underline stroke. | Text | ||
underlineOffset : Object
The amount by which to offset the underline from the text baseline. | Text | ||
underlineOverprint : Boolean
If true, the underline stroke color will overprint. | Text | ||
underlineTint : Number
The underline stroke tint (as a percentage). | Text | ||
underlineType : Object
The stroke type of the underline stroke. | Text | ||
underlineWeight : Object
The stroke weight of the underline stroke. | Text | ||
verticalScale : Number
The vertical scaling applied to the Text. | Text | ||
warichu : Boolean
If true, turns on warichu. | Text | ||
warichuAlignment : WarichuAlignment
The warichu alignment. | Text | ||
warichuCharsAfterBreak : Number
The minimum number of characters allowed after a line break. | Text | ||
warichuCharsBeforeBreak : Number
The minimum number of characters allowed before a line break. | Text | ||
warichuLines : Number
The number of lines of warichu within a single normal line. | Text | ||
warichuLineSpacing : Number
The gap between lines of warichu characters. | Text | ||
warichuSize : Number
The amount (as a percentage) to scale parent text size to determine warichu size. | Text | ||
words : Words [read-only]
A collection of words. | Text | ||
xOffsetDiacritic : Number
The x (horizontal) offset for diacritic adjustment. | Text | ||
yOffsetDiacritic : Number
The y (vertical) offset for diacritic adjustment. | Text |
Method | Defined By | ||
---|---|---|---|
addEventListenerText(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Text | ||
applyCharacterStyle(usingParam:CharacterStyle = null):void
Apply a character style. | Text | ||
applyConditions(usingParam:Array = null, removeExistingParam:Boolean = false):void
Apply one or more conditions. | Text | ||
applyParagraphStyle(usingParam:ParagraphStyle = null, clearingOverridesParam:Boolean = true):void
Apply a paragraph style. | Text | ||
autoTag():void
Tag the object or the parent story using default tags defined in XML preference. | Text | ||
changecase(usingParam:ChangecaseMode = null):void
Sets the case of the text. | Text | ||
changeGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value and replaces the glyphs with the change to value. | Text | ||
changeGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value. | Text | ||
changeText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value. | Text | ||
changeTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value and replaces the text with the change character type value. | Text | ||
clearOverrides(overridesToClearParam:OverrideType = null):void
Clears the specified types of override. | Text | ||
Convert bullets and numbering to text. | Text | ||
Converts the text to a note. | Text | ||
convertToTable(columnSeparatorParam:String = null, rowSeparatorParam:String = null, numberOfColumnsParam:Number = 1):Table
Converts the text to a table. | Text | ||
createOutlines():Object
Converts text to outlines. | Text | ||
Duplicates the text in the specified location. | Text | ||
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Exports the object(s) to a file. | Text | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
findGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value. | Text | ||
findGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value. | Text | ||
findHyperlinks(sortOrderParam:RangeSortOrder = null):Object
Finds hyperlink sources that intersecting with specified text range. | Text | ||
findText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value. | Text | ||
findTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value. | Text | ||
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object
Resolves the object specifier, creating an array of object references. | Text | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
markup(usingParam:XMLElement = null):void
Associates the object with the specified XML element while preserving existing content. | Text | ||
Moves the text to the specified location. | Text | ||
place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object
Places the file. | Text | ||
recompose():void
Recomposes the text in the Text. | Text | ||
remove():void
Deletes the Text. | Text | ||
removeEventListenerText(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Text | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
select(existingSelectionParam:SelectionOptions = null):void
Selects the object. | Text | ||
showText():void
Jump to the text range. | Text | ||
toSpecifier():String
Retrieves the object specifier. | Text | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
alignToBaseline | property |
alignToBaseline:Boolean
Since : | CS5 |
If true, aligns the baseline of the text to the baseline grid.
public function get alignToBaseline():Boolean
public function set alignToBaseline(value:Boolean):void
allGraphics | property |
allGraphics:Object
[read-only] Since : | CS5 |
Lists all graphics contained by the Text.
public function get allGraphics():Object
allowArbitraryHyphenation | property |
allowArbitraryHyphenation:Boolean
Since : | CS5 |
If true, words unassociated with a hyphenation dictionary can break to the next line on any character.
public function get allowArbitraryHyphenation():Boolean
public function set allowArbitraryHyphenation(value:Boolean):void
allPageItems | property |
allPageItems:Object
[read-only] Since : | CS5 |
Lists all page items contained by the Text.
public function get allPageItems():Object
appliedCharacterStyle | property |
appliedCharacterStyle:CharacterStyle
Since : | CS5 |
The character style applied to the text. Can also accept: String.
public function get appliedCharacterStyle():CharacterStyle
public function set appliedCharacterStyle(value:CharacterStyle):void
appliedConditions | property |
appliedConditions:Object
Since : | CS5 |
The applied conditions.
public function get appliedConditions():Object
public function set appliedConditions(value:Object):void
appliedFont | property |
appliedFont:Object
Since : | CS5 |
The font applied to the Text, specified as either a font object or the name of font family. Can return: Font or String.
public function get appliedFont():Object
public function set appliedFont(value:Object):void
appliedLanguage | property |
appliedLanguage:Object
Since : | CS5 |
The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String.
public function get appliedLanguage():Object
public function set appliedLanguage(value:Object):void
appliedNestedStyles | property |
appliedNestedStyles:Object
[read-only] Since : | CS5 |
The applied character styles dictated by nested styles.
public function get appliedNestedStyles():Object
appliedNumberingList | property |
appliedNumberingList:Object
Since : | CS5 |
The list to be part of. Can return: NumberingList or String.
public function get appliedNumberingList():Object
public function set appliedNumberingList(value:Object):void
appliedParagraphStyle | property |
appliedParagraphStyle:ParagraphStyle
Since : | CS5 |
The paragraph style applied to the text. Can also accept: String.
public function get appliedParagraphStyle():ParagraphStyle
public function set appliedParagraphStyle(value:ParagraphStyle):void
ascent | property |
ascent:Object
[read-only] Since : | CS5 |
The maximum ascent of any character in the text.
public function get ascent():Object
associatedXMLElements | property |
associatedXMLElements:Object
[read-only] Since : | CS5 |
The XML elements associated with the Text.
public function get associatedXMLElements():Object
autoLeading | property |
autoLeading:Number
Since : | CS5 |
The percent of the type size to use for auto leading. (Range: 0 to 500).
public function get autoLeading():Number
public function set autoLeading(value:Number):void
autoTcy | property |
autoTcy:Number
Since : | CS5 |
The number of half-width characters at or below which the characters automatically run horizontally in vertical text.
public function get autoTcy():Number
public function set autoTcy(value:Number):void
autoTcyIncludeRoman | property |
autoTcyIncludeRoman:Boolean
Since : | CS5 |
If true, auto tcy includes Roman characters.
public function get autoTcyIncludeRoman():Boolean
public function set autoTcyIncludeRoman(value:Boolean):void
balanceRaggedLines | property |
balanceRaggedLines:Object
Since : | CS5 |
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.
public function get balanceRaggedLines():Object
public function set balanceRaggedLines(value:Object):void
baseline | property |
baseline:Object
[read-only] Since : | CS5 |
The vertical offset of the text.
public function get baseline():Object
baselineShift | property |
baselineShift:Object
Since : | CS5 |
The baseline shift applied to the text.
public function get baselineShift():Object
public function set baselineShift(value:Object):void
bulletChar | property |
bulletChar:Bullet
[read-only] Since : | CS5 |
Bullet character.
public function get bulletChar():Bullet
bulletsAlignment | property |
bulletsAlignment:ListAlignment
Since : | CS5 |
The alignment of the bullet character.
public function get bulletsAlignment():ListAlignment
public function set bulletsAlignment(value:ListAlignment):void
bulletsAndNumberingListType | property |
bulletsAndNumberingListType:ListType
Since : | CS5 |
List type for bullets and numbering.
public function get bulletsAndNumberingListType():ListType
public function set bulletsAndNumberingListType(value:ListType):void
bulletsCharacterStyle | property |
bulletsCharacterStyle:Object
Since : | CS5 |
The character style to be used for the text after string. Can return: CharacterStyle or String.
public function get bulletsCharacterStyle():Object
public function set bulletsCharacterStyle(value:Object):void
bulletsTextAfter | property |
bulletsTextAfter:String
Since : | CS5 |
The text after string expression for bullets.
public function get bulletsTextAfter():String
public function set bulletsTextAfter(value:String):void
bunriKinshi | property |
bunriKinshi:Boolean
Since : | CS5 |
If true, adds the double period (..), ellipse (...), and double hyphen (--) to the selected kinsoku set. Note: Valid only when a kinsoku set is in effect.
public function get bunriKinshi():Boolean
public function set bunriKinshi(value:Boolean):void
buttons | property |
buttons:Buttons
[read-only] Since : | CS5 |
A collection of buttons.
public function get buttons():Buttons
capitalization | property |
capitalization:Capitalization
Since : | CS5 |
The capitalization scheme.
public function get capitalization():Capitalization
public function set capitalization(value:Capitalization):void
characterAlignment | property |
characterAlignment:CharacterAlignment
Since : | CS5 |
The alignment of small characters to the largest character in the line.
public function get characterAlignment():CharacterAlignment
public function set characterAlignment(value:CharacterAlignment):void
characterDirection | property |
characterDirection:CharacterDirectionOptions
Since : | CS5 |
The direction of the character.
public function get characterDirection():CharacterDirectionOptions
public function set characterDirection(value:CharacterDirectionOptions):void
characterRotation | property |
characterRotation:Number
Since : | CS5 |
The rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise.
public function get characterRotation():Number
public function set characterRotation(value:Number):void
characters | property |
characters:Characters
[read-only] Since : | CS5 |
A collection of characters.
public function get characters():Characters
cjkGridTracking | property |
cjkGridTracking:Boolean
Since : | CS5 |
If true, uses grid tracking to track non-Roman characters in CJK grids.
public function get cjkGridTracking():Boolean
public function set cjkGridTracking(value:Boolean):void
composer | property |
composer:String
Since : | CS5 |
The text composer to use to compose the text.
public function get composer():String
public function set composer(value:String):void
contents | property |
contents:Object
Since : | CS5 |
The contents of the text. Can return: String or SpecialCharacters enumerator.
public function get contents():Object
public function set contents(value:Object):void
descent | property |
descent:Object
[read-only] Since : | CS5 |
The maximum descent of any character in the text.
public function get descent():Object
desiredGlyphScaling | property |
desiredGlyphScaling:Number
Since : | CS5 |
The desired width (as a percentage) of individual characters. (Range: 50 to 200)
public function get desiredGlyphScaling():Number
public function set desiredGlyphScaling(value:Number):void
desiredLetterSpacing | property |
desiredLetterSpacing:Number
Since : | CS5 |
The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500)
public function get desiredLetterSpacing():Number
public function set desiredLetterSpacing(value:Number):void
desiredWordSpacing | property |
desiredWordSpacing:Number
Since : | CS5 |
The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)
public function get desiredWordSpacing():Number
public function set desiredWordSpacing(value:Number):void
diacriticPosition | property |
diacriticPosition:DiacriticPositionOptions
Since : | CS5 |
Position of diacriticical characters.
public function get diacriticPosition():DiacriticPositionOptions
public function set diacriticPosition(value:DiacriticPositionOptions):void
digitsType | property |
digitsType:DigitsTypeOptions
Since : | CS5 |
The digits type.
public function get digitsType():DigitsTypeOptions
public function set digitsType(value:DigitsTypeOptions):void
dropCapCharacters | property |
dropCapCharacters:Number
Since : | CS5 |
The number of characters to drop cap.
public function get dropCapCharacters():Number
public function set dropCapCharacters(value:Number):void
dropcapDetail | property |
dropcapDetail:Number
Since : | CS5 |
Details about the drop cap based on the glyph outlines. 1 = left side bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid.
public function get dropcapDetail():Number
public function set dropcapDetail(value:Number):void
dropCapLines | property |
dropCapLines:Number
Since : | CS5 |
The number of lines to drop cap.
public function get dropCapLines():Number
public function set dropCapLines(value:Number):void
dropCapStyle | property |
dropCapStyle:CharacterStyle
Since : | CS5 |
The character style to apply to the drop cap. Can also accept: String.
public function get dropCapStyle():CharacterStyle
public function set dropCapStyle(value:CharacterStyle):void
endBaseline | property |
endBaseline:Object
[read-only] Since : | CS5 |
Vertical offset of the end of the text.
public function get endBaseline():Object
endHorizontalOffset | property |
endHorizontalOffset:Object
[read-only] Since : | CS5 |
Horizontal offset of the end of the text.
public function get endHorizontalOffset():Object
endJoin | property |
endJoin:OutlineJoin
Since : | CS5 |
The stroke join type applied to the characters of the text.
public function get endJoin():OutlineJoin
public function set endJoin(value:OutlineJoin):void
epstexts | property |
epstexts:EPSTexts
[read-only] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
fillColor | property |
fillColor:Swatch
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Text. . Can also accept: String.
public function get fillColor():Swatch
public function set fillColor(value:Swatch):void
fillTint | property |
fillTint:Number
Since : | CS5 |
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.)
public function get fillTint():Number
public function set fillTint(value:Number):void
firstLineIndent | property |
firstLineIndent:Object
Since : | CS5 |
The amount to indent the first line.
public function get firstLineIndent():Object
public function set firstLineIndent(value:Object):void
fontStyle | property |
fontStyle:String
Since : | CS5 |
The name of the font style.
public function get fontStyle():String
public function set fontStyle(value:String):void
footnotes | property |
footnotes:Footnotes
[read-only] Since : | CS5 |
A collection of footnotes.
public function get footnotes():Footnotes
formFields | property |
formFields:FormFields
[read-only] Since : | CS5 |
A collection of form fields.
public function get formFields():FormFields
glyphForm | property |
glyphForm:AlternateGlyphForms
Since : | CS5 |
The glyph variant to substitute for standard glyphs.
public function get glyphForm():AlternateGlyphForms
public function set glyphForm(value:AlternateGlyphForms):void
gradientFillAngle | property |
gradientFillAngle:Number
Since : | CS5 |
The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)
public function get gradientFillAngle():Number
public function set gradientFillAngle(value:Number):void
gradientFillLength | property |
gradientFillLength:Number
Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.
public function get gradientFillLength():Number
public function set gradientFillLength(value:Number):void
gradientFillStart | property |
gradientFillStart:Object
Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y].
public function get gradientFillStart():Object
public function set gradientFillStart(value:Object):void
gradientStrokeAngle | property |
gradientStrokeAngle:Number
Since : | CS5 |
The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180)
public function get gradientStrokeAngle():Number
public function set gradientStrokeAngle(value:Number):void
gradientStrokeLength | property |
gradientStrokeLength:Number
Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text.
public function get gradientStrokeLength():Number
public function set gradientStrokeLength(value:Number):void
gradientStrokeStart | property |
gradientStrokeStart:Object
Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y].
public function get gradientStrokeStart():Object
public function set gradientStrokeStart(value:Object):void
graphicLines | property |
graphicLines:GraphicLines
[read-only] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
gridAlignFirstLineOnly | property |
gridAlignFirstLineOnly:Boolean
Since : | CS5 |
If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid.
public function get gridAlignFirstLineOnly():Boolean
public function set gridAlignFirstLineOnly(value:Boolean):void
gridAlignment | property |
gridAlignment:GridAlignment
Since : | CS5 |
The alignment to the frame grid or baseline grid.
public function get gridAlignment():GridAlignment
public function set gridAlignment(value:GridAlignment):void
gridGyoudori | property |
gridGyoudori:Number
Since : | CS5 |
The manual gyoudori setting.
public function get gridGyoudori():Number
public function set gridGyoudori(value:Number):void
groups | property |
groups:Groups
[read-only] Since : | CS5 |
A collection of groups.
public function get groups():Groups
hiddenTexts | property |
hiddenTexts:HiddenTexts
[read-only] Since : | CS5 |
A collection of hidden text objects.
public function get hiddenTexts():HiddenTexts
horizontalOffset | property |
horizontalOffset:Object
[read-only] Since : | CS5 |
The horizontal offset of the text.
public function get horizontalOffset():Object
horizontalScale | property |
horizontalScale:Number
Since : | CS5 |
The horizontal scaling applied to the Text.
public function get horizontalScale():Number
public function set horizontalScale(value:Number):void
hyphenateAcrossColumns | property |
hyphenateAcrossColumns:Boolean
Since : | CS5 |
If true, allows the last word in a text column to be hyphenated.
public function get hyphenateAcrossColumns():Boolean
public function set hyphenateAcrossColumns(value:Boolean):void
hyphenateAfterFirst | property |
hyphenateAfterFirst:Number
Since : | CS5 |
The mininum number of letters at the beginning of a word that can be broken by a hyphen.
public function get hyphenateAfterFirst():Number
public function set hyphenateAfterFirst(value:Number):void
hyphenateBeforeLast | property |
hyphenateBeforeLast:Number
Since : | CS5 |
The minimum number of letters at the end of a word that can be broken by a hyphen.
public function get hyphenateBeforeLast():Number
public function set hyphenateBeforeLast(value:Number):void
hyphenateCapitalizedWords | property |
hyphenateCapitalizedWords:Boolean
Since : | CS5 |
If true, allows hyphenation of capitalized words.
public function get hyphenateCapitalizedWords():Boolean
public function set hyphenateCapitalizedWords(value:Boolean):void
hyphenateLadderLimit | property |
hyphenateLadderLimit:Number
Since : | CS5 |
The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero.
public function get hyphenateLadderLimit():Number
public function set hyphenateLadderLimit(value:Number):void
hyphenateLastWord | property |
hyphenateLastWord:Boolean
Since : | CS5 |
If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.
public function get hyphenateLastWord():Boolean
public function set hyphenateLastWord(value:Boolean):void
hyphenateWordsLongerThan | property |
hyphenateWordsLongerThan:Number
Since : | CS5 |
The minimum number of letters a word must have in order to qualify for hyphenation.
public function get hyphenateWordsLongerThan():Number
public function set hyphenateWordsLongerThan(value:Number):void
hyphenation | property |
hyphenation:Boolean
Since : | CS5 |
If true, allows hyphenation.
public function get hyphenation():Boolean
public function set hyphenation(value:Boolean):void
hyphenationZone | property |
hyphenationZone:Object
Since : | CS5 |
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.
public function get hyphenationZone():Object
public function set hyphenationZone(value:Object):void
hyphenWeight | property |
hyphenWeight:Number
Since : | CS5 |
The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100)
public function get hyphenWeight():Number
public function set hyphenWeight(value:Number):void
ignoreEdgeAlignment | property |
ignoreEdgeAlignment:Boolean
Since : | CS5 |
If true, ignores optical edge alignment for the paragraph.
public function get ignoreEdgeAlignment():Boolean
public function set ignoreEdgeAlignment(value:Boolean):void
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the text in the collection or parent object.
public function get index():Number
insertionPoints | property |
insertionPoints:InsertionPoints
[read-only] Since : | CS5 |
A collection of insertion points.
public function get insertionPoints():InsertionPoints
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
jidori | property |
jidori:Number
Since : | CS5 |
The number of grid squares in which to arrange the text.
public function get jidori():Number
public function set jidori(value:Number):void
justification | property |
justification:Justification
Since : | CS5 |
The paragraph alignment.
public function get justification():Justification
public function set justification(value:Justification):void
kashidas | property |
kashidas:KashidasOptions
Since : | CS5 |
Use of Kashidas for justification
public function get kashidas():KashidasOptions
public function set kashidas(value:KashidasOptions):void
keepAllLinesTogether | property |
keepAllLinesTogether:Boolean
Since : | CS5 |
If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.
public function get keepAllLinesTogether():Boolean
public function set keepAllLinesTogether(value:Boolean):void
keepFirstLines | property |
keepFirstLines:Number
Since : | CS5 |
The minimum number of lines to keep together in a paragraph before allowing a page break.
public function get keepFirstLines():Number
public function set keepFirstLines(value:Number):void
keepLastLines | property |
keepLastLines:Number
Since : | CS5 |
The minimum number of lines to keep together in a paragraph after a page break.
public function get keepLastLines():Number
public function set keepLastLines(value:Number):void
keepLinesTogether | property |
keepLinesTogether:Boolean
Since : | CS5 |
If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.
public function get keepLinesTogether():Boolean
public function set keepLinesTogether(value:Boolean):void
keepRuleAboveInFrame | property |
keepRuleAboveInFrame:Boolean
Since : | CS5 |
If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true.
public function get keepRuleAboveInFrame():Boolean
public function set keepRuleAboveInFrame(value:Boolean):void
keepWithNext | property |
keepWithNext:Number
Since : | CS5 |
The minimum number of lines to keep with the next paragraph.
public function get keepWithNext():Number
public function set keepWithNext(value:Number):void
keepWithPrevious | property |
keepWithPrevious:Boolean
Since : | CS5 |
If the first line in the paragraph should be kept with the last line of previous paragraph.
public function get keepWithPrevious():Boolean
public function set keepWithPrevious(value:Boolean):void
kentenAlignment | property |
kentenAlignment:KentenAlignment
Since : | CS5 |
The alignment of kenten characters relative to the parent characters.
public function get kentenAlignment():KentenAlignment
public function set kentenAlignment(value:KentenAlignment):void
kentenCharacterSet | property |
kentenCharacterSet:KentenCharacterSet
Since : | CS5 |
The character set used for the custom kenten character. Note: Valid only when kenten kind is custom.
public function get kentenCharacterSet():KentenCharacterSet
public function set kentenCharacterSet(value:KentenCharacterSet):void
kentenCustomCharacter | property |
kentenCustomCharacter:String
Since : | CS5 |
The character used for kenten. Note: Valid only when kenten kind is custom.
public function get kentenCustomCharacter():String
public function set kentenCustomCharacter(value:String):void
kentenFillColor | property |
kentenFillColor:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch or String.
public function get kentenFillColor():Object
public function set kentenFillColor(value:Object):void
kentenFont | property |
kentenFont:Object
Since : | CS5 |
The font to use for kenten characters. Can return: Font or String.
public function get kentenFont():Object
public function set kentenFont(value:Object):void
kentenFontSize | property |
kentenFontSize:Number
Since : | CS5 |
The size (in points) of kenten characters.
public function get kentenFontSize():Number
public function set kentenFontSize(value:Number):void
kentenFontStyle | property |
kentenFontStyle:Object
Since : | CS5 |
The font style of kenten characters. Can return: String or NothingEnum enumerator.
public function get kentenFontStyle():Object
public function set kentenFontStyle(value:Object):void
kentenKind | property |
kentenKind:KentenCharacter
Since : | CS5 |
The style of kenten characters.
public function get kentenKind():KentenCharacter
public function set kentenKind(value:KentenCharacter):void
kentenOverprintFill | property |
kentenOverprintFill:AdornmentOverprint
Since : | CS5 |
The method of overprinting the kenten fill.
public function get kentenOverprintFill():AdornmentOverprint
public function set kentenOverprintFill(value:AdornmentOverprint):void
kentenOverprintStroke | property |
kentenOverprintStroke:AdornmentOverprint
Since : | CS5 |
The method of overprinting the kenten stroke.
public function get kentenOverprintStroke():AdornmentOverprint
public function set kentenOverprintStroke(value:AdornmentOverprint):void
kentenPlacement | property |
kentenPlacement:Number
Since : | CS5 |
The distance between kenten characters and their parent characters.
public function get kentenPlacement():Number
public function set kentenPlacement(value:Number):void
kentenPosition | property |
kentenPosition:RubyKentenPosition
Since : | CS5 |
The kenten position relative to the parent character.
public function get kentenPosition():RubyKentenPosition
public function set kentenPosition(value:RubyKentenPosition):void
kentenStrokeColor | property |
kentenStrokeColor:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch or String.
public function get kentenStrokeColor():Object
public function set kentenStrokeColor(value:Object):void
kentenStrokeTint | property |
kentenStrokeTint:Number
Since : | CS5 |
The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100)
public function get kentenStrokeTint():Number
public function set kentenStrokeTint(value:Number):void
kentenTint | property |
kentenTint:Number
Since : | CS5 |
The fill tint (as a percentage) of kenten characters. (Range: 0 to 100)
public function get kentenTint():Number
public function set kentenTint(value:Number):void
kentenWeight | property |
kentenWeight:Number
Since : | CS5 |
The stroke weight (in points) of kenten characters.
public function get kentenWeight():Number
public function set kentenWeight(value:Number):void
kentenXScale | property |
kentenXScale:Number
Since : | CS5 |
The horizontal size of kenten characters as a percent of the original size.
public function get kentenXScale():Number
public function set kentenXScale(value:Number):void
kentenYScale | property |
kentenYScale:Number
Since : | CS5 |
The vertical size of kenten charachers as a percent of the original size.
public function get kentenYScale():Number
public function set kentenYScale(value:Number):void
kerningMethod | property |
kerningMethod:String
Since : | CS5 |
The type of pair kerning.
public function get kerningMethod():String
public function set kerningMethod(value:String):void
kerningValue | property |
kerningValue:Number
Since : | CS5 |
The amount of space to add or remove between characters, specified in thousands of an em.
public function get kerningValue():Number
public function set kerningValue(value:Number):void
keyboardDirection | property |
keyboardDirection:CharacterDirectionOptions
Since : | CS5 |
The keyboard direction of the character.
public function get keyboardDirection():CharacterDirectionOptions
public function set keyboardDirection(value:CharacterDirectionOptions):void
kinsokuHangType | property |
kinsokuHangType:KinsokuHangTypes
Since : | CS5 |
The type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect.
public function get kinsokuHangType():KinsokuHangTypes
public function set kinsokuHangType(value:KinsokuHangTypes):void
kinsokuSet | property |
kinsokuSet:Object
Since : | CS5 |
The kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator or String.
public function get kinsokuSet():Object
public function set kinsokuSet(value:Object):void
kinsokuType | property |
kinsokuType:KinsokuType
Since : | CS5 |
The type of kinsoku processing for preventing kinsoku characters from beginning or ending a line. Note: Valid only when a kinsoku set is defined.
public function get kinsokuType():KinsokuType
public function set kinsokuType(value:KinsokuType):void
lastLineIndent | property |
lastLineIndent:Object
Since : | CS5 |
The amount to indent the last line in the paragraph.
public function get lastLineIndent():Object
public function set lastLineIndent(value:Object):void
leading | property |
leading:Object
Since : | CS5 |
The leading applied to the text. Can return: Unit or Leading enumerator.
public function get leading():Object
public function set leading(value:Object):void
leadingAki | property |
leadingAki:Number
Since : | CS5 |
The amount of space before each character.
public function get leadingAki():Number
public function set leadingAki(value:Number):void
leadingModel | property |
leadingModel:LeadingModel
Since : | CS5 |
The point from which leading is measured from line to line.
public function get leadingModel():LeadingModel
public function set leadingModel(value:LeadingModel):void
leftIndent | property |
leftIndent:Object
Since : | CS5 |
The width of the left indent.
public function get leftIndent():Object
public function set leftIndent(value:Object):void
length | property |
length:Number
[read-only] Since : | CS5 |
The number of objects in the collection.
public function get length():Number
ligatures | property |
ligatures:Boolean
Since : | CS5 |
If true, replaces specific character combinations (e.g., fl, fi) with ligature characters.
public function get ligatures():Boolean
public function set ligatures(value:Boolean):void
lines | property |
lines:Lines
[read-only] Since : | CS5 |
A collection of lines.
public function get lines():Lines
maximumGlyphScaling | property |
maximumGlyphScaling:Number
Since : | CS5 |
The maximum width (as a percentage) of individual characters. (Range: 50 to 200)
public function get maximumGlyphScaling():Number
public function set maximumGlyphScaling(value:Number):void
maximumLetterSpacing | property |
maximumLetterSpacing:Number
Since : | CS5 |
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.
public function get maximumLetterSpacing():Number
public function set maximumLetterSpacing(value:Number):void
maximumWordSpacing | property |
maximumWordSpacing:Number
Since : | CS5 |
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)
public function get maximumWordSpacing():Number
public function set maximumWordSpacing(value:Number):void
minimumGlyphScaling | property |
minimumGlyphScaling:Number
Since : | CS5 |
The minimum width (as a percentage) of individual characters. (Range: 50 to 200)
public function get minimumGlyphScaling():Number
public function set minimumGlyphScaling(value:Number):void
minimumLetterSpacing | property |
minimumLetterSpacing:Number
Since : | CS5 |
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.
public function get minimumLetterSpacing():Number
public function set minimumLetterSpacing(value:Number):void
minimumWordSpacing | property |
minimumWordSpacing:Number
Since : | CS5 |
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)
public function get minimumWordSpacing():Number
public function set minimumWordSpacing(value:Number):void
miterLimit | property |
miterLimit:Number
Since : | CS5 |
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.
public function get miterLimit():Number
public function set miterLimit(value:Number):void
mojikumi | property |
mojikumi:Object
Since : | CS5 |
The mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String or MojikumiTableDefaults enumerator.
public function get mojikumi():Object
public function set mojikumi(value:Object):void
multiStateObjects | property |
multiStateObjects:MultiStateObjects
[read-only] Since : | CS5 |
A collection of multi-state objects.
public function get multiStateObjects():MultiStateObjects
nestedGrepStyles | property |
nestedGrepStyles:NestedGrepStyles
[read-only] Since : | CS5 |
A collection of nested GREP styles.
public function get nestedGrepStyles():NestedGrepStyles
nestedLineStyles | property |
nestedLineStyles:NestedLineStyles
[read-only] Since : | CS5 |
A collection of nested line styles.
public function get nestedLineStyles():NestedLineStyles
nestedStyles | property |
nestedStyles:NestedStyles
[read-only] Since : | CS5 |
A collection of nested styles.
public function get nestedStyles():NestedStyles
noBreak | property |
noBreak:Boolean
Since : | CS5 |
If true, keeps the text on the same line.
public function get noBreak():Boolean
public function set noBreak(value:Boolean):void
notes | property |
notes:Notes
[read-only] Since : | CS5 |
A collection of notes.
public function get notes():Notes
numberingAlignment | property |
numberingAlignment:ListAlignment
Since : | CS5 |
The alignment of the number.
public function get numberingAlignment():ListAlignment
public function set numberingAlignment(value:ListAlignment):void
numberingApplyRestartPolicy | property |
numberingApplyRestartPolicy:Boolean
Since : | CS5 |
If true, apply the numbering restart policy.
public function get numberingApplyRestartPolicy():Boolean
public function set numberingApplyRestartPolicy(value:Boolean):void
numberingCharacterStyle | property |
numberingCharacterStyle:Object
Since : | CS5 |
The character style to be used for the number string. Can return: CharacterStyle or String.
public function get numberingCharacterStyle():Object
public function set numberingCharacterStyle(value:Object):void
numberingContinue | property |
numberingContinue:Boolean
Since : | CS5 |
Continue the numbering at this level.
public function get numberingContinue():Boolean
public function set numberingContinue(value:Boolean):void
numberingExpression | property |
numberingExpression:String
Since : | CS5 |
The number string expression for numbering.
public function get numberingExpression():String
public function set numberingExpression(value:String):void
numberingFormat | property |
numberingFormat:Object
Since : | CS5 |
Numbering format options. Can return: NumberingStyle enumerator or String.
public function get numberingFormat():Object
public function set numberingFormat(value:Object):void
numberingLevel | property |
numberingLevel:Number
Since : | CS5 |
The level of the paragraph.
public function get numberingLevel():Number
public function set numberingLevel(value:Number):void
numberingRestartPolicies | property |
numberingRestartPolicies:NumberingRestartPolicy
[read-only] Since : | CS5 |
Numbering restart policies.
public function get numberingRestartPolicies():NumberingRestartPolicy
numberingStartAt | property |
numberingStartAt:Number
Since : | CS5 |
Determines starting number in a numbered list.
public function get numberingStartAt():Number
public function set numberingStartAt(value:Number):void
opentypeFeatures | property |
opentypeFeatures:Object
Since : | CS5 |
OpenType features. Can return: Array of Array of 2 Strings or Long Integers.
public function get opentypeFeatures():Object
public function set opentypeFeatures(value:Object):void
otfContextualAlternate | property |
otfContextualAlternate:Boolean
Since : | CS5 |
If true, uses contextual alternate forms in OpenType fonts.
public function get otfContextualAlternate():Boolean
public function set otfContextualAlternate(value:Boolean):void
otfDiscretionaryLigature | property |
otfDiscretionaryLigature:Boolean
Since : | CS5 |
If true, uses discretionary ligatures in OpenType fonts.
public function get otfDiscretionaryLigature():Boolean
public function set otfDiscretionaryLigature(value:Boolean):void
otfFigureStyle | property |
otfFigureStyle:OTFFigureStyle
Since : | CS5 |
The figure style in OpenType fonts.
public function get otfFigureStyle():OTFFigureStyle
public function set otfFigureStyle(value:OTFFigureStyle):void
otfFraction | property |
otfFraction:Boolean
Since : | CS5 |
If true, uses fractions in OpenType fonts.
public function get otfFraction():Boolean
public function set otfFraction(value:Boolean):void
otfHistorical | property |
otfHistorical:Boolean
Since : | CS5 |
If true, use historical forms in OpenType fonts.
public function get otfHistorical():Boolean
public function set otfHistorical(value:Boolean):void
otfHVKana | property |
otfHVKana:Boolean
Since : | CS5 |
If true, switches hiragana fonts, which have different glyphs for horizontal and vertical.
public function get otfHVKana():Boolean
public function set otfHVKana(value:Boolean):void
otfJustificationAlternate | property |
otfJustificationAlternate:Boolean
Since : | CS5 |
If true, use alternate justification forms in OpenType fonts
public function get otfJustificationAlternate():Boolean
public function set otfJustificationAlternate(value:Boolean):void
otfLocale | property |
otfLocale:Boolean
Since : | CS5 |
If true, uses localized forms in OpenType fonts.
public function get otfLocale():Boolean
public function set otfLocale(value:Boolean):void
otfMark | property |
otfMark:Boolean
Since : | CS5 |
If true, uses mark positioning in OpenType fonts.
public function get otfMark():Boolean
public function set otfMark(value:Boolean):void
otfOrdinal | property |
otfOrdinal:Boolean
Since : | CS5 |
If true, uses ordinals in OpenType fonts.
public function get otfOrdinal():Boolean
public function set otfOrdinal(value:Boolean):void
otfOverlapSwash | property |
otfOverlapSwash:Boolean
Since : | CS5 |
If true, use overlapping swash forms in OpenType fonts
public function get otfOverlapSwash():Boolean
public function set otfOverlapSwash(value:Boolean):void
otfProportionalMetrics | property |
otfProportionalMetrics:Boolean
Since : | CS5 |
If true, kerns according to proportional CJK metrics in OpenType fonts.
public function get otfProportionalMetrics():Boolean
public function set otfProportionalMetrics(value:Boolean):void
otfRomanItalics | property |
otfRomanItalics:Boolean
Since : | CS5 |
If true, applies italics to half-width alphanumerics.
public function get otfRomanItalics():Boolean
public function set otfRomanItalics(value:Boolean):void
otfSlashedZero | property |
otfSlashedZero:Boolean
Since : | CS5 |
If true, use a slashed zeroes in OpenType fonts.
public function get otfSlashedZero():Boolean
public function set otfSlashedZero(value:Boolean):void
otfStretchedAlternate | property |
otfStretchedAlternate:Boolean
Since : | CS5 |
If true, use stretched alternate forms in OpenType fonts
public function get otfStretchedAlternate():Boolean
public function set otfStretchedAlternate(value:Boolean):void
otfStylisticAlternate | property |
otfStylisticAlternate:Boolean
Since : | CS5 |
If true, use stylistic alternate forms in OpenType fonts
public function get otfStylisticAlternate():Boolean
public function set otfStylisticAlternate(value:Boolean):void
otfStylisticSets | property |
otfStylisticSets:Number
Since : | CS5 |
The stylistic sets to use in OpenType fonts.
public function get otfStylisticSets():Number
public function set otfStylisticSets(value:Number):void
otfSwash | property |
otfSwash:Boolean
Since : | CS5 |
If true, uses swash forms in OpenType fonts.
public function get otfSwash():Boolean
public function set otfSwash(value:Boolean):void
otfTitling | property |
otfTitling:Boolean
Since : | CS5 |
If true, uses titling forms in OpenType fonts.
public function get otfTitling():Boolean
public function set otfTitling(value:Boolean):void
ovals | property |
ovals:Ovals
[read-only] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
overprintFill | property |
overprintFill:Boolean
Since : | CS5 |
If true, the fill color of the characters will overprint.
public function get overprintFill():Boolean
public function set overprintFill(value:Boolean):void
overprintStroke | property |
overprintStroke:Boolean
Since : | CS5 |
If true, the stroke of the characters will overprint.
public function get overprintStroke():Boolean
public function set overprintStroke(value:Boolean):void
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
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.
public function get pageItems():PageItems
paragraphDirection | property |
paragraphDirection:ParagraphDirectionOptions
Since : | CS5 |
Paragraph direction.
public function get paragraphDirection():ParagraphDirectionOptions
public function set paragraphDirection(value:ParagraphDirectionOptions):void
paragraphGyoudori | property |
paragraphGyoudori:Boolean
Since : | CS5 |
If true, the gyoudori mode applies to the entire paragraph. If false, the gyoudori mode applies to each line in the paragraph.
public function get paragraphGyoudori():Boolean
public function set paragraphGyoudori(value:Boolean):void
paragraphJustification | property |
paragraphJustification:ParagraphJustificationOptions
Since : | CS5 |
Paragraph justification.
public function get paragraphJustification():ParagraphJustificationOptions
public function set paragraphJustification(value:ParagraphJustificationOptions):void
paragraphs | property |
paragraphs:Paragraphs
[read-only] Since : | CS5 |
A collection of paragraphs.
public function get paragraphs():Paragraphs
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the Text (a XmlStory, TextPath, TextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story, Cell, XMLElement, Footnote, Note, Change or HiddenText).
public function get parent():Object
parentStory | property |
parentStory:Story
[read-only] Since : | CS5 |
The story that contains the text.
public function get parentStory():Story
parentTextFrames | property |
parentTextFrames:Object
[read-only] Since : | CS5 |
An array of the text frames that contain the text. Can return: Array of TextFrames or TextPaths.
public function get parentTextFrames():Object
pointSize | property |
pointSize:Object
Since : | CS5 |
The text size.
public function get pointSize():Object
public function set pointSize(value:Object):void
polygons | property |
polygons:Polygons
[read-only] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
position | property |
position:Position
Since : | CS5 |
The text position relative to the baseline.
public function get position():Position
public function set position(value:Position):void
positionalForm | property |
positionalForm:PositionalForms
Since : | CS5 |
The OpenType positional form.
public function get positionalForm():PositionalForms
public function set positionalForm(value:PositionalForms):void
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rectangles | property |
rectangles:Rectangles
[read-only] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
rensuuji | property |
rensuuji:Boolean
Since : | CS5 |
If true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers.
public function get rensuuji():Boolean
public function set rensuuji(value:Boolean):void
rightIndent | property |
rightIndent:Object
Since : | CS5 |
The width of the right indent.
public function get rightIndent():Object
public function set rightIndent(value:Object):void
rotateSingleByteCharacters | property |
rotateSingleByteCharacters:Boolean
Since : | CS5 |
If true, rotates Roman characters in vertical text.
public function get rotateSingleByteCharacters():Boolean
public function set rotateSingleByteCharacters(value:Boolean):void
rubyAlignment | property |
rubyAlignment:RubyAlignments
Since : | CS5 |
The ruby alignment.
public function get rubyAlignment():RubyAlignments
public function set rubyAlignment(value:RubyAlignments):void
rubyAutoAlign | property |
rubyAutoAlign:Boolean
Since : | CS5 |
If true, auto aligns ruby.
public function get rubyAutoAlign():Boolean
public function set rubyAutoAlign(value:Boolean):void
rubyAutoScaling | property |
rubyAutoScaling:Boolean
Since : | CS5 |
If true, automatically scales ruby to the specified percent of parent text size. For information on specifying a percent, see ruby parent scaling percent.
public function get rubyAutoScaling():Boolean
public function set rubyAutoScaling(value:Boolean):void
rubyAutoTcyAutoScale | property |
rubyAutoTcyAutoScale:Boolean
Since : | CS5 |
If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em.
public function get rubyAutoTcyAutoScale():Boolean
public function set rubyAutoTcyAutoScale(value:Boolean):void
rubyAutoTcyDigits | property |
rubyAutoTcyDigits:Number
Since : | CS5 |
The number of digits included in auto tcy (tate-chuu-yoko) in ruby.
public function get rubyAutoTcyDigits():Number
public function set rubyAutoTcyDigits(value:Number):void
rubyAutoTcyIncludeRoman | property |
rubyAutoTcyIncludeRoman:Boolean
Since : | CS5 |
If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby.
public function get rubyAutoTcyIncludeRoman():Boolean
public function set rubyAutoTcyIncludeRoman(value:Boolean):void
rubyFill | property |
rubyFill:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch or String.
public function get rubyFill():Object
public function set rubyFill(value:Object):void
rubyFlag | property |
rubyFlag:Boolean
Since : | CS5 |
If true, ruby is on.
public function get rubyFlag():Boolean
public function set rubyFlag(value:Boolean):void
rubyFont | property |
rubyFont:Object
Since : | CS5 |
The font applied to ruby characters. Can return: Font or String.
public function get rubyFont():Object
public function set rubyFont(value:Object):void
rubyFontSize | property |
rubyFontSize:Number
Since : | CS5 |
The size (in points) of ruby characters.
public function get rubyFontSize():Number
public function set rubyFontSize(value:Number):void
rubyFontStyle | property |
rubyFontStyle:Object
Since : | CS5 |
The font style of ruby characters. Can return: String or NothingEnum enumerator.
public function get rubyFontStyle():Object
public function set rubyFontStyle(value:Object):void
rubyOpenTypePro | property |
rubyOpenTypePro:Boolean
Since : | CS5 |
If true, uses OpenType Pro fonts for ruby.
public function get rubyOpenTypePro():Boolean
public function set rubyOpenTypePro(value:Boolean):void
rubyOverhang | property |
rubyOverhang:Boolean
Since : | CS5 |
If true, constrains ruby overhang to the specified amount. For information on specifying an amount, see ruby parent overhang amount.
public function get rubyOverhang():Boolean
public function set rubyOverhang(value:Boolean):void
rubyOverprintFill | property |
rubyOverprintFill:AdornmentOverprint
Since : | CS5 |
The method of overprinting the ruby fill.
public function get rubyOverprintFill():AdornmentOverprint
public function set rubyOverprintFill(value:AdornmentOverprint):void
rubyOverprintStroke | property |
rubyOverprintStroke:AdornmentOverprint
Since : | CS5 |
The method of overprinting the ruby stroke.
public function get rubyOverprintStroke():AdornmentOverprint
public function set rubyOverprintStroke(value:AdornmentOverprint):void
rubyParentOverhangAmount | property |
rubyParentOverhangAmount:RubyOverhang
Since : | CS5 |
The amount by which ruby characters can overhang the parent text.
public function get rubyParentOverhangAmount():RubyOverhang
public function set rubyParentOverhangAmount(value:RubyOverhang):void
rubyParentScalingPercent | property |
rubyParentScalingPercent:Number
Since : | CS5 |
The amount (as a percentage) to scale the parent text size to determine the ruby text size.
public function get rubyParentScalingPercent():Number
public function set rubyParentScalingPercent(value:Number):void
rubyParentSpacing | property |
rubyParentSpacing:RubyParentSpacing
Since : | CS5 |
The ruby spacing relative to the parent text.
public function get rubyParentSpacing():RubyParentSpacing
public function set rubyParentSpacing(value:RubyParentSpacing):void
rubyPosition | property |
rubyPosition:RubyKentenPosition
Since : | CS5 |
The position of ruby characters relative to the parent text.
public function get rubyPosition():RubyKentenPosition
public function set rubyPosition(value:RubyKentenPosition):void
rubyString | property |
rubyString:String
Since : | CS5 |
The ruby string contents.
public function get rubyString():String
public function set rubyString(value:String):void
rubyStroke | property |
rubyStroke:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch or String.
public function get rubyStroke():Object
public function set rubyStroke(value:Object):void
rubyStrokeTint | property |
rubyStrokeTint:Number
Since : | CS5 |
The stroke tint (as a percentage) of ruby characters.
public function get rubyStrokeTint():Number
public function set rubyStrokeTint(value:Number):void
rubyTint | property |
rubyTint:Number
Since : | CS5 |
The tint (as a percentage) of the ruby fill color. (Range: 0 to 100)
public function get rubyTint():Number
public function set rubyTint(value:Number):void
rubyType | property |
rubyType:RubyTypes
Since : | CS5 |
The ruby type.
public function get rubyType():RubyTypes
public function set rubyType(value:RubyTypes):void
rubyWeight | property |
rubyWeight:Number
Since : | CS5 |
The stroke weight (in points) of ruby characters.
public function get rubyWeight():Number
public function set rubyWeight(value:Number):void
rubyXOffset | property |
rubyXOffset:Number
Since : | CS5 |
The amount of horizontal space between ruby and parent characters.
public function get rubyXOffset():Number
public function set rubyXOffset(value:Number):void
rubyXScale | property |
rubyXScale:Number
Since : | CS5 |
The horizontal size of ruby characters, specified as a percent of the original size.
public function get rubyXScale():Number
public function set rubyXScale(value:Number):void
rubyYOffset | property |
rubyYOffset:Number
Since : | CS5 |
The amount of vertical space between ruby and parent characters.
public function get rubyYOffset():Number
public function set rubyYOffset(value:Number):void
rubyYScale | property |
rubyYScale:Number
Since : | CS5 |
The vertical size of ruby characters, specified as a percent of the original size.
public function get rubyYScale():Number
public function set rubyYScale(value:Number):void
ruleAbove | property |
ruleAbove:Boolean
Since : | CS5 |
If true, places a rule above the paragraph.
public function get ruleAbove():Boolean
public function set ruleAbove(value:Boolean):void
ruleAboveColor | property |
ruleAboveColor:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.
public function get ruleAboveColor():Object
public function set ruleAboveColor(value:Object):void
ruleAboveGapColor | property |
ruleAboveGapColor:Object
Since : | CS5 |
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.
public function get ruleAboveGapColor():Object
public function set ruleAboveGapColor(value:Object):void
ruleAboveGapOverprint | property |
ruleAboveGapOverprint:Boolean
Since : | CS5 |
If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid.
public function get ruleAboveGapOverprint():Boolean
public function set ruleAboveGapOverprint(value:Boolean):void
ruleAboveGapTint | property |
ruleAboveGapTint:Number
Since : | CS5 |
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.
public function get ruleAboveGapTint():Number
public function set ruleAboveGapTint(value:Number):void
ruleAboveLeftIndent | property |
ruleAboveLeftIndent:Object
Since : | CS5 |
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.
public function get ruleAboveLeftIndent():Object
public function set ruleAboveLeftIndent(value:Object):void
ruleAboveLineWeight | property |
ruleAboveLineWeight:Object
Since : | CS5 |
The line weight of the rule above.
public function get ruleAboveLineWeight():Object
public function set ruleAboveLineWeight(value:Object):void
ruleAboveOffset | property |
ruleAboveOffset:Object
Since : | CS5 |
The amount to offset the paragraph rule above from the baseline of the first line the paragraph.
public function get ruleAboveOffset():Object
public function set ruleAboveOffset(value:Object):void
ruleAboveOverprint | property |
ruleAboveOverprint:Boolean
Since : | CS5 |
If true, the paragraph rule above will overprint.
public function get ruleAboveOverprint():Boolean
public function set ruleAboveOverprint(value:Boolean):void
ruleAboveRightIndent | property |
ruleAboveRightIndent:Object
Since : | CS5 |
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.
public function get ruleAboveRightIndent():Object
public function set ruleAboveRightIndent(value:Object):void
ruleAboveTint | property |
ruleAboveTint:Number
Since : | CS5 |
The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)
public function get ruleAboveTint():Number
public function set ruleAboveTint(value:Number):void
ruleAboveType | property |
ruleAboveType:Object
Since : | CS5 |
The stroke type of the rule above the paragraph. Can return: StrokeStyle or String.
public function get ruleAboveType():Object
public function set ruleAboveType(value:Object):void
ruleAboveWidth | property |
ruleAboveWidth:RuleWidth
Since : | CS5 |
The basis (text width or column width) used to calculate the width of the paragraph rule above.
public function get ruleAboveWidth():RuleWidth
public function set ruleAboveWidth(value:RuleWidth):void
ruleBelow | property |
ruleBelow:Boolean
Since : | CS5 |
If true, applies a paragraph rule below.
public function get ruleBelow():Boolean
public function set ruleBelow(value:Boolean):void
ruleBelowColor | property |
ruleBelowColor:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.
public function get ruleBelowColor():Object
public function set ruleBelowColor(value:Object):void
ruleBelowGapColor | property |
ruleBelowGapColor:Object
Since : | CS5 |
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.
public function get ruleBelowGapColor():Object
public function set ruleBelowGapColor(value:Object):void
ruleBelowGapOverprint | property |
ruleBelowGapOverprint:Boolean
Since : | CS5 |
If true, the gap color of the rule below will overprint.
public function get ruleBelowGapOverprint():Boolean
public function set ruleBelowGapOverprint(value:Boolean):void
ruleBelowGapTint | property |
ruleBelowGapTint:Number
Since : | CS5 |
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.
public function get ruleBelowGapTint():Number
public function set ruleBelowGapTint(value:Number):void
ruleBelowLeftIndent | property |
ruleBelowLeftIndent:Object
Since : | CS5 |
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.
public function get ruleBelowLeftIndent():Object
public function set ruleBelowLeftIndent(value:Object):void
ruleBelowLineWeight | property |
ruleBelowLineWeight:Object
Since : | CS5 |
The line weight of the rule below.
public function get ruleBelowLineWeight():Object
public function set ruleBelowLineWeight(value:Object):void
ruleBelowOffset | property |
ruleBelowOffset:Object
Since : | CS5 |
The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.
public function get ruleBelowOffset():Object
public function set ruleBelowOffset(value:Object):void
ruleBelowOverprint | property |
ruleBelowOverprint:Boolean
Since : | CS5 |
If true, the rule below will overprint.
public function get ruleBelowOverprint():Boolean
public function set ruleBelowOverprint(value:Boolean):void
ruleBelowRightIndent | property |
ruleBelowRightIndent:Object
Since : | CS5 |
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.
public function get ruleBelowRightIndent():Object
public function set ruleBelowRightIndent(value:Object):void
ruleBelowTint | property |
ruleBelowTint:Number
Since : | CS5 |
The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)
public function get ruleBelowTint():Number
public function set ruleBelowTint(value:Number):void
ruleBelowType | property |
ruleBelowType:Object
Since : | CS5 |
The stroke type of the rule below the paragraph. Can return: StrokeStyle or String.
public function get ruleBelowType():Object
public function set ruleBelowType(value:Object):void
ruleBelowWidth | property |
ruleBelowWidth:RuleWidth
Since : | CS5 |
The basis (text width or column width) used to calculate the width of the paragraph rule below.
public function get ruleBelowWidth():RuleWidth
public function set ruleBelowWidth(value:RuleWidth):void
scaleAffectsLineHeight | property |
scaleAffectsLineHeight:Boolean
Since : | CS5 |
If true, the line changes size when characters are scaled.
public function get scaleAffectsLineHeight():Boolean
public function set scaleAffectsLineHeight(value:Boolean):void
shataiAdjustRotation | property |
shataiAdjustRotation:Boolean
Since : | CS5 |
If true, applies shatai rotation.
public function get shataiAdjustRotation():Boolean
public function set shataiAdjustRotation(value:Boolean):void
shataiAdjustTsume | property |
shataiAdjustTsume:Boolean
Since : | CS5 |
If true, adjusts shatai tsume.
public function get shataiAdjustTsume():Boolean
public function set shataiAdjustTsume(value:Boolean):void
shataiDegreeAngle | property |
shataiDegreeAngle:Number
Since : | CS5 |
The shatai lens angle (in degrees).
public function get shataiDegreeAngle():Number
public function set shataiDegreeAngle(value:Number):void
shataiMagnification | property |
shataiMagnification:Number
Since : | CS5 |
The amount (as a percentage) of shatai obliquing to apply.
public function get shataiMagnification():Number
public function set shataiMagnification(value:Number):void
singleWordJustification | property |
singleWordJustification:SingleWordJustification
Since : | CS5 |
The alignment to use for lines that contain a single word.
public function get singleWordJustification():SingleWordJustification
public function set singleWordJustification(value:SingleWordJustification):void
skew | property |
skew:Number
Since : | CS5 |
The skew angle of the Text.
public function get skew():Number
public function set skew(value:Number):void
spaceAfter | property |
spaceAfter:Object
Since : | CS5 |
The height of the paragraph space below.
public function get spaceAfter():Object
public function set spaceAfter(value:Object):void
spaceBefore | property |
spaceBefore:Object
Since : | CS5 |
The height of the paragraph space above.
public function get spaceBefore():Object
public function set spaceBefore(value:Object):void
spanColumnMinSpaceAfter | property |
spanColumnMinSpaceAfter:Object
Since : | CS5 |
The minimum space after a span or a split column
public function get spanColumnMinSpaceAfter():Object
public function set spanColumnMinSpaceAfter(value:Object):void
spanColumnMinSpaceBefore | property |
spanColumnMinSpaceBefore:Object
Since : | CS5 |
The minimum space before a span or a split column
public function get spanColumnMinSpaceBefore():Object
public function set spanColumnMinSpaceBefore(value:Object):void
spanColumnType | property |
spanColumnType:SpanColumnTypeOptions
Since : | CS5 |
Whether a paragraph should be a single column, span columns or split columns
public function get spanColumnType():SpanColumnTypeOptions
public function set spanColumnType(value:SpanColumnTypeOptions):void
spanSplitColumnCount | property |
spanSplitColumnCount:Object
Since : | CS5 |
The number of columns a paragraph spans or the number of split columns. Can return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator.
public function get spanSplitColumnCount():Object
public function set spanSplitColumnCount(value:Object):void
splineItems | property |
splineItems:SplineItems
[read-only] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
splitColumnInsideGutter | property |
splitColumnInsideGutter:Object
Since : | CS5 |
The inside gutter if the paragraph splits columns
public function get splitColumnInsideGutter():Object
public function set splitColumnInsideGutter(value:Object):void
splitColumnOutsideGutter | property |
splitColumnOutsideGutter:Object
Since : | CS5 |
The outside gutter if the paragraph splits columns
public function get splitColumnOutsideGutter():Object
public function set splitColumnOutsideGutter(value:Object):void
startParagraph | property |
startParagraph:StartParagraph
Since : | CS5 |
The location at which to start the paragraph.
public function get startParagraph():StartParagraph
public function set startParagraph(value:StartParagraph):void
strikeThroughColor | property |
strikeThroughColor:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.
public function get strikeThroughColor():Object
public function set strikeThroughColor(value:Object):void
strikeThroughGapColor | property |
strikeThroughGapColor:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String.
public function get strikeThroughGapColor():Object
public function set strikeThroughGapColor(value:Object):void
strikeThroughGapOverprint | property |
strikeThroughGapOverprint:Boolean
Since : | CS5 |
If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.
public function get strikeThroughGapOverprint():Boolean
public function set strikeThroughGapOverprint(value:Boolean):void
strikeThroughGapTint | property |
strikeThroughGapTint:Number
Since : | CS5 |
The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid.
public function get strikeThroughGapTint():Number
public function set strikeThroughGapTint(value:Number):void
strikeThroughOffset | property |
strikeThroughOffset:Object
Since : | CS5 |
The amount by which to offset the strikethrough stroke from the text baseline.
public function get strikeThroughOffset():Object
public function set strikeThroughOffset(value:Object):void
strikeThroughOverprint | property |
strikeThroughOverprint:Boolean
Since : | CS5 |
If true, the strikethrough stroke will overprint.
public function get strikeThroughOverprint():Boolean
public function set strikeThroughOverprint(value:Boolean):void
strikeThroughTint | property |
strikeThroughTint:Number
Since : | CS5 |
The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)
public function get strikeThroughTint():Number
public function set strikeThroughTint(value:Number):void
strikeThroughType | property |
strikeThroughType:Object
Since : | CS5 |
The stroke type of the strikethrough stroke. Can return: StrokeStyle or String.
public function get strikeThroughType():Object
public function set strikeThroughType(value:Object):void
strikeThroughWeight | property |
strikeThroughWeight:Object
Since : | CS5 |
The stroke weight of the strikethrough stroke.
public function get strikeThroughWeight():Object
public function set strikeThroughWeight(value:Object):void
strikeThru | property |
strikeThru:Boolean
Since : | CS5 |
If true, draws a strikethrough line through the text.
public function get strikeThru():Boolean
public function set strikeThru(value:Boolean):void
strokeAlignment | property |
strokeAlignment:TextStrokeAlign
Since : | CS5 |
The stroke alignment applied to the text.
public function get strokeAlignment():TextStrokeAlign
public function set strokeAlignment(value:TextStrokeAlign):void
strokeColor | property |
strokeColor:Swatch
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Text. Can also accept: String.
public function get strokeColor():Swatch
public function set strokeColor(value:Swatch):void
strokeTint | property |
strokeTint:Number
Since : | CS5 |
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.)
public function get strokeTint():Number
public function set strokeTint(value:Number):void
strokeWeight | property |
strokeWeight:Object
Since : | CS5 |
The stroke weight applied to the characters of the text.
public function get strokeWeight():Object
public function set strokeWeight(value:Object):void
styleOverridden | property |
styleOverridden:Boolean
[read-only] Since : | CS5 |
If true, the applied style has been overridden with additional attributes.
public function get styleOverridden():Boolean
tables | property |
tables:Tables
[read-only] Since : | CS5 |
A collection of tables.
public function get tables():Tables
tabList | property |
tabList:Object
Since : | CS5 |
A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs.
public function get tabList():Object
public function set tabList(value:Object):void
tabStops | property |
tabStops:TabStops
[read-only] Since : | CS5 |
A collection of tab stops.
public function get tabStops():TabStops
tatechuyoko | property |
tatechuyoko:Boolean
Since : | CS5 |
If true, makes the character horizontal in vertical text.
public function get tatechuyoko():Boolean
public function set tatechuyoko(value:Boolean):void
tatechuyokoXOffset | property |
tatechuyokoXOffset:Number
Since : | CS5 |
The horizontal offset for horizontal characters in vertical text.
public function get tatechuyokoXOffset():Number
public function set tatechuyokoXOffset(value:Number):void
tatechuyokoYOffset | property |
tatechuyokoYOffset:Number
Since : | CS5 |
The vertical offset for horizontal characters in vertical text.
public function get tatechuyokoYOffset():Number
public function set tatechuyokoYOffset(value:Number):void
textColumns | property |
textColumns:TextColumns
[read-only] Since : | CS5 |
A collection of text columns.
public function get textColumns():TextColumns
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
texts | property |
texts:Texts
[read-only] Since : | CS5 |
A collection of text objects.
public function get texts():Texts
textStyleRanges | property |
textStyleRanges:TextStyleRanges
[read-only] Since : | CS5 |
A collection of text style ranges.
public function get textStyleRanges():TextStyleRanges
textVariableInstances | property |
textVariableInstances:TextVariableInstances
[read-only] Since : | CS5 |
A collection of text variable instances.
public function get textVariableInstances():TextVariableInstances
tracking | property |
tracking:Number
Since : | CS5 |
The amount by which to loosen or tighten a block of text, specified in thousands of an em.
public function get tracking():Number
public function set tracking(value:Number):void
trailingAki | property |
trailingAki:Number
Since : | CS5 |
The amount of space after each character.
public function get trailingAki():Number
public function set trailingAki(value:Number):void
treatIdeographicSpaceAsSpace | property |
treatIdeographicSpaceAsSpace:Boolean
Since : | CS5 |
If true, ideographic spaces will not wrap to the next line like text characters.
public function get treatIdeographicSpaceAsSpace():Boolean
public function set treatIdeographicSpaceAsSpace(value:Boolean):void
tsume | property |
tsume:Number
Since : | CS5 |
The amount of horizontal character compression.
public function get tsume():Number
public function set tsume(value:Number):void
underline | property |
underline:Boolean
Since : | CS5 |
If true, underlines the text.
public function get underline():Boolean
public function set underline(value:Boolean):void
underlineColor | property |
underlineColor:Object
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.
public function get underlineColor():Object
public function set underlineColor(value:Object):void
underlineGapColor | property |
underlineGapColor:Object
Since : | CS5 |
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.
public function get underlineGapColor():Object
public function set underlineGapColor(value:Object):void
underlineGapOverprint | property |
underlineGapOverprint:Boolean
Since : | CS5 |
If true, the gap color of the underline stroke will overprint.
public function get underlineGapOverprint():Boolean
public function set underlineGapOverprint(value:Boolean):void
underlineGapTint | property |
underlineGapTint:Number
Since : | CS5 |
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.
public function get underlineGapTint():Number
public function set underlineGapTint(value:Number):void
underlineOffset | property |
underlineOffset:Object
Since : | CS5 |
The amount by which to offset the underline from the text baseline.
public function get underlineOffset():Object
public function set underlineOffset(value:Object):void
underlineOverprint | property |
underlineOverprint:Boolean
Since : | CS5 |
If true, the underline stroke color will overprint.
public function get underlineOverprint():Boolean
public function set underlineOverprint(value:Boolean):void
underlineTint | property |
underlineTint:Number
Since : | CS5 |
The underline stroke tint (as a percentage). (Range: 0 to 100)
public function get underlineTint():Number
public function set underlineTint(value:Number):void
underlineType | property |
underlineType:Object
Since : | CS5 |
The stroke type of the underline stroke. Can return: StrokeStyle or String.
public function get underlineType():Object
public function set underlineType(value:Object):void
underlineWeight | property |
underlineWeight:Object
Since : | CS5 |
The stroke weight of the underline stroke.
public function get underlineWeight():Object
public function set underlineWeight(value:Object):void
verticalScale | property |
verticalScale:Number
Since : | CS5 |
The vertical scaling applied to the Text.
public function get verticalScale():Number
public function set verticalScale(value:Number):void
warichu | property |
warichu:Boolean
Since : | CS5 |
If true, turns on warichu.
public function get warichu():Boolean
public function set warichu(value:Boolean):void
warichuAlignment | property |
warichuAlignment:WarichuAlignment
Since : | CS5 |
The warichu alignment.
public function get warichuAlignment():WarichuAlignment
public function set warichuAlignment(value:WarichuAlignment):void
warichuCharsAfterBreak | property |
warichuCharsAfterBreak:Number
Since : | CS5 |
The minimum number of characters allowed after a line break.
public function get warichuCharsAfterBreak():Number
public function set warichuCharsAfterBreak(value:Number):void
warichuCharsBeforeBreak | property |
warichuCharsBeforeBreak:Number
Since : | CS5 |
The minimum number of characters allowed before a line break.
public function get warichuCharsBeforeBreak():Number
public function set warichuCharsBeforeBreak(value:Number):void
warichuLines | property |
warichuLines:Number
Since : | CS5 |
The number of lines of warichu within a single normal line.
public function get warichuLines():Number
public function set warichuLines(value:Number):void
warichuLineSpacing | property |
warichuLineSpacing:Number
Since : | CS5 |
The gap between lines of warichu characters.
public function get warichuLineSpacing():Number
public function set warichuLineSpacing(value:Number):void
warichuSize | property |
warichuSize:Number
Since : | CS5 |
The amount (as a percentage) to scale parent text size to determine warichu size.
public function get warichuSize():Number
public function set warichuSize(value:Number):void
words | property |
words:Words
[read-only] Since : | CS5 |
A collection of words.
public function get words():Words
xOffsetDiacritic | property |
xOffsetDiacritic:Number
Since : | CS5 |
The x (horizontal) offset for diacritic adjustment.
public function get xOffsetDiacritic():Number
public function set xOffsetDiacritic(value:Number):void
yOffsetDiacritic | property |
yOffsetDiacritic:Number
Since : | CS5 |
The y (vertical) offset for diacritic adjustment.
public function get yOffsetDiacritic():Number
public function set yOffsetDiacritic(value:Number):void
addEventListenerText | () | method |
public function addEventListenerText(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
applyCharacterStyle | () | method |
public function applyCharacterStyle(usingParam:CharacterStyle = null):void
Since : | CS5 |
Apply a character style.
Parameters
usingParam:CharacterStyle (default = null ) — (CharacterStyle) The character style to apply.
|
applyConditions | () | method |
public function applyConditions(usingParam:Array = null, removeExistingParam:Boolean = false):void
Since : | CS5 |
Apply one or more conditions.
Parameters
usingParam:Array (default = null ) — (Array) The condition(s) to apply
| |
removeExistingParam:Boolean (default = false ) — (Boolean) If true, remove existing conditions. (Optional)
|
applyParagraphStyle | () | method |
public function applyParagraphStyle(usingParam:ParagraphStyle = null, clearingOverridesParam:Boolean = true):void
Since : | CS5 |
Apply a paragraph style.
Parameters
usingParam:ParagraphStyle (default = null ) — (ParagraphStyle) The paragraph style to apply.
| |
clearingOverridesParam:Boolean (default = true ) — (Boolean) If true, clear any text attributes before applying the style. (Optional)
|
autoTag | () | method |
public function autoTag():void
Since : | CS5 |
Tag the object or the parent story using default tags defined in XML preference.
changecase | () | method |
public function changecase(usingParam:ChangecaseMode = null):void
Since : | CS5 |
Sets the case of the text.
Parameters
usingParam:ChangecaseMode (default = null ) — (ChangecaseMode) The text case option.
|
changeGlyph | () | method |
public function changeGlyph(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeGrep | () | method |
public function changeGrep(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value and replaces the text with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeText | () | method |
public function changeText(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value and replaces the text with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeTransliterate | () | method |
public function changeTransliterate(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find character type value and replaces the text with the change character type value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
clearOverrides | () | method |
public function clearOverrides(overridesToClearParam:OverrideType = null):void
Since : | CS5 |
Clears the specified types of override.
Parameters
overridesToClearParam:OverrideType (default = null ) — (OverrideType) The types of override to clear. (Optional)
|
convertBulletsAndNumberingToText | () | method |
public function convertBulletsAndNumberingToText():void
Since : | CS5 |
Convert bullets and numbering to text.
convertToNote | () | method |
convertToTable | () | method |
public function convertToTable(columnSeparatorParam:String = null, rowSeparatorParam:String = null, numberOfColumnsParam:Number = 1):Table
Since : | CS5 |
Converts the text to a table.
Parameters
columnSeparatorParam:String (default = null ) — (String) The character that starts a new column in the new table. (Optional)
| |
rowSeparatorParam:String (default = null ) — (String) The character starts a new row in the new table. (Optional)
| |
numberOfColumnsParam:Number (default = 1 ) — (Number) The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional)
|
Table |
createOutlines | () | method |
public function createOutlines():Object
Since : | CS5 |
Converts text to outlines. Each line of text becomes a polygon object.
ReturnsObject |
duplicate | () | method |
public function duplicate(toParam:LocationOptions = null, referenceParam:Object = null):Text
Since : | CS5 |
Duplicates the text in the specified location.
Parameters
toParam:LocationOptions (default = null ) — (LocationOptions) The location relative to the reference object or within the containing object.
| |
referenceParam:Object (default = null ) — (Object) The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)
|
Text |
exportFile | () | method |
public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Exports the object(s) to a file.
Parameters
formatParam:Object (default = null ) — (Object) The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
| |
toParam:File (default = null ) — (File) The path to the export file.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) If true, displays the export options dialog. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
findGlyph | () | method |
public function findGlyph(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds glyphs that match the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findGrep | () | method |
public function findGrep(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findHyperlinks | () | method |
public function findHyperlinks(sortOrderParam:RangeSortOrder = null):Object
Since : | CS5 |
Finds hyperlink sources that intersecting with specified text range.
Parameters
sortOrderParam:RangeSortOrder (default = null ) — (RangeSortOrder) The sort order of found ranges. (Optional)
|
Object |
findText | () | method |
public function findText(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findTransliterate | () | method |
public function findTransliterate(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find character type value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
markup | () | method |
public function markup(usingParam:XMLElement = null):void
Since : | CS5 |
Associates the object with the specified XML element while preserving existing content.
Parameters
usingParam:XMLElement (default = null ) — (XMLElement) The XML element.
|
move | () | method |
public function move(toParam:LocationOptions = null, referenceParam:Object = null):Text
Since : | CS5 |
Moves the text to the specified location.
Parameters
toParam:LocationOptions (default = null ) — (LocationOptions) The location relative to the reference object or within the containing object.
| |
referenceParam:Object (default = null ) — (Object) The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)
|
Text |
place | () | method |
public function place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object
Since : | CS5 |
Places the file.
Parameters
fileNameParam:File (default = null ) — (File) The file to place
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) Whether to display the import options dialog (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the placed object(s) (Optional)
|
Object |
recompose | () | method |
public function recompose():void
Since : | CS5 |
Recomposes the text in the Text.
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the Text.
removeEventListenerText | () | method |
public function removeEventListenerText(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
select | () | method |
public function select(existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
Selects the object.
Parameters
existingSelectionParam:SelectionOptions (default = null ) — (SelectionOptions) The selection status of the Text in relation to previously selected objects. (Optional)
|
showText | () | method |
public function showText():void
Since : | CS5 |
Jump to the text range.
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |