Packagecom.adobe.indesign
Classpublic class TextStyleRange
InheritanceTextStyleRange Inheritance Text Inheritance CSHostObject Inheritance flash.utils.Proxy

Text



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

If true, aligns the baseline of the text to the baseline grid.


Implementation
    public function get alignToBaseline():Boolean
    public function set alignToBaseline(value:Boolean):void
allGraphicsproperty 
allGraphics:Object  [read-only] [override]

Lists all graphics contained by the TextStyleRange.


Implementation
    public function get allGraphics():Object
allowArbitraryHyphenationproperty 
allowArbitraryHyphenation:Boolean[override]

If true, words unassociated with a hyphenation dictionary can break to the next line on any character.


Implementation
    public function get allowArbitraryHyphenation():Boolean
    public function set allowArbitraryHyphenation(value:Boolean):void
allPageItemsproperty 
allPageItems:Object  [read-only] [override]

Lists all page items contained by the TextStyleRange.


Implementation
    public function get allPageItems():Object
appliedCharacterStyleproperty 
appliedCharacterStyle:CharacterStyle[override]

The character style applied to the text. Can also accept: String.


Implementation
    public function get appliedCharacterStyle():CharacterStyle
    public function set appliedCharacterStyle(value:CharacterStyle):void
appliedConditionsproperty 
appliedConditions:Object[override]

The applied conditions.


Implementation
    public function get appliedConditions():Object
    public function set appliedConditions(value:Object):void
appliedFontproperty 
appliedFont:Object[override]

The font applied to the TextStyleRange, specified as either a font object or the name of font family. Can return: Font or String.


Implementation
    public function get appliedFont():Object
    public function set appliedFont(value:Object):void
appliedLanguageproperty 
appliedLanguage:Object[override]

The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String.


Implementation
    public function get appliedLanguage():Object
    public function set appliedLanguage(value:Object):void
appliedNestedStylesproperty 
appliedNestedStyles:Object  [read-only] [override]

The applied character styles dictated by nested styles.


Implementation
    public function get appliedNestedStyles():Object
appliedNumberingListproperty 
appliedNumberingList:Object[override]

The list to be part of. Can return: NumberingList or String.


Implementation
    public function get appliedNumberingList():Object
    public function set appliedNumberingList(value:Object):void
appliedParagraphStyleproperty 
appliedParagraphStyle:ParagraphStyle[override]

The paragraph style applied to the text. Can also accept: String.


Implementation
    public function get appliedParagraphStyle():ParagraphStyle
    public function set appliedParagraphStyle(value:ParagraphStyle):void
ascentproperty 
ascent:Object  [read-only] [override]

The maximum ascent of any character in the text.


Implementation
    public function get ascent():Object
associatedXMLElementsproperty 
associatedXMLElements:Object  [read-only] [override]

The XML elements associated with the TextStyleRange.


Implementation
    public function get associatedXMLElements():Object
autoLeadingproperty 
autoLeading:Number[override]

The percent of the type size to use for auto leading. (Range: 0 to 500).


Implementation
    public function get autoLeading():Number
    public function set autoLeading(value:Number):void
autoTcyproperty 
autoTcy:Number[override]

The number of half-width characters at or below which the characters automatically run horizontally in vertical text.


Implementation
    public function get autoTcy():Number
    public function set autoTcy(value:Number):void
autoTcyIncludeRomanproperty 
autoTcyIncludeRoman:Boolean[override]

If true, auto tcy includes Roman characters.


Implementation
    public function get autoTcyIncludeRoman():Boolean
    public function set autoTcyIncludeRoman(value:Boolean):void
balanceRaggedLinesproperty 
balanceRaggedLines:Object[override]

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.


Implementation
    public function get balanceRaggedLines():Object
    public function set balanceRaggedLines(value:Object):void
baselineproperty 
baseline:Object  [read-only] [override]

The vertical offset of the text.


Implementation
    public function get baseline():Object
baselineShiftproperty 
baselineShift:Object[override]

The baseline shift applied to the text.


Implementation
    public function get baselineShift():Object
    public function set baselineShift(value:Object):void
bulletCharproperty 
bulletChar:Bullet  [read-only] [override]

Bullet character.


Implementation
    public function get bulletChar():Bullet
bulletsAlignmentproperty 
bulletsAlignment:ListAlignment[override]

The alignment of the bullet character.


Implementation
    public function get bulletsAlignment():ListAlignment
    public function set bulletsAlignment(value:ListAlignment):void
bulletsAndNumberingListTypeproperty 
bulletsAndNumberingListType:ListType[override]

List type for bullets and numbering.


Implementation
    public function get bulletsAndNumberingListType():ListType
    public function set bulletsAndNumberingListType(value:ListType):void
bulletsCharacterStyleproperty 
bulletsCharacterStyle:Object[override]

The character style to be used for the text after string. Can return: CharacterStyle or String.


Implementation
    public function get bulletsCharacterStyle():Object
    public function set bulletsCharacterStyle(value:Object):void
bulletsTextAfterproperty 
bulletsTextAfter:String[override]

The text after string expression for bullets.


Implementation
    public function get bulletsTextAfter():String
    public function set bulletsTextAfter(value:String):void
bunriKinshiproperty 
bunriKinshi:Boolean[override]

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.


Implementation
    public function get bunriKinshi():Boolean
    public function set bunriKinshi(value:Boolean):void
buttonsproperty 
buttons:Buttons  [read-only] [override]

A collection of buttons.


Implementation
    public function get buttons():Buttons
capitalizationproperty 
capitalization:Capitalization[override]

The capitalization scheme.


Implementation
    public function get capitalization():Capitalization
    public function set capitalization(value:Capitalization):void
characterAlignmentproperty 
characterAlignment:CharacterAlignment[override]

The alignment of small characters to the largest character in the line.


Implementation
    public function get characterAlignment():CharacterAlignment
    public function set characterAlignment(value:CharacterAlignment):void
characterDirectionproperty 
characterDirection:CharacterDirectionOptions[override]

The direction of the character.


Implementation
    public function get characterDirection():CharacterDirectionOptions
    public function set characterDirection(value:CharacterDirectionOptions):void
characterRotationproperty 
characterRotation:Number[override]

The rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise.


Implementation
    public function get characterRotation():Number
    public function set characterRotation(value:Number):void
charactersproperty 
characters:Characters  [read-only] [override]

A collection of characters.


Implementation
    public function get characters():Characters
cjkGridTrackingproperty 
cjkGridTracking:Boolean[override]

If true, uses grid tracking to track non-Roman characters in CJK grids.


Implementation
    public function get cjkGridTracking():Boolean
    public function set cjkGridTracking(value:Boolean):void
composerproperty 
composer:String[override]

The text composer to use to compose the text.


Implementation
    public function get composer():String
    public function set composer(value:String):void
contentsproperty 
contents:Object[override]

The contents of the text. Can return: String or SpecialCharacters enumerator.


Implementation
    public function get contents():Object
    public function set contents(value:Object):void
descentproperty 
descent:Object  [read-only] [override]

The maximum descent of any character in the text.


Implementation
    public function get descent():Object
desiredGlyphScalingproperty 
desiredGlyphScaling:Number[override]

The desired width (as a percentage) of individual characters. (Range: 50 to 200)


Implementation
    public function get desiredGlyphScaling():Number
    public function set desiredGlyphScaling(value:Number):void
desiredLetterSpacingproperty 
desiredLetterSpacing:Number[override]

The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500)


Implementation
    public function get desiredLetterSpacing():Number
    public function set desiredLetterSpacing(value:Number):void
desiredWordSpacingproperty 
desiredWordSpacing:Number[override]

The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)


Implementation
    public function get desiredWordSpacing():Number
    public function set desiredWordSpacing(value:Number):void
diacriticPositionproperty 
diacriticPosition:DiacriticPositionOptions[override]

Position of diacriticical characters.


Implementation
    public function get diacriticPosition():DiacriticPositionOptions
    public function set diacriticPosition(value:DiacriticPositionOptions):void
digitsTypeproperty 
digitsType:DigitsTypeOptions[override]

The digits type.


Implementation
    public function get digitsType():DigitsTypeOptions
    public function set digitsType(value:DigitsTypeOptions):void
dropCapCharactersproperty 
dropCapCharacters:Number[override]

The number of characters to drop cap.


Implementation
    public function get dropCapCharacters():Number
    public function set dropCapCharacters(value:Number):void
dropcapDetailproperty 
dropcapDetail:Number[override]

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.


Implementation
    public function get dropcapDetail():Number
    public function set dropcapDetail(value:Number):void
dropCapLinesproperty 
dropCapLines:Number[override]

The number of lines to drop cap.


Implementation
    public function get dropCapLines():Number
    public function set dropCapLines(value:Number):void
dropCapStyleproperty 
dropCapStyle:CharacterStyle[override]

The character style to apply to the drop cap. Can also accept: String.


Implementation
    public function get dropCapStyle():CharacterStyle
    public function set dropCapStyle(value:CharacterStyle):void
endBaselineproperty 
endBaseline:Object  [read-only] [override]

Vertical offset of the end of the text.


Implementation
    public function get endBaseline():Object
endHorizontalOffsetproperty 
endHorizontalOffset:Object  [read-only] [override]

Horizontal offset of the end of the text.


Implementation
    public function get endHorizontalOffset():Object
endJoinproperty 
endJoin:OutlineJoin[override]

The stroke join type applied to the characters of the text.


Implementation
    public function get endJoin():OutlineJoin
    public function set endJoin(value:OutlineJoin):void
epstextsproperty 
epstexts:EPSTexts  [read-only] [override]

EPSTexts


Implementation
    public function get epstexts():EPSTexts
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
fillColorproperty 
fillColor:Swatch[override]

The swatch (color, gradient, tint, or mixed ink) applied to the fill of the TextStyleRange. . Can also accept: String.


Implementation
    public function get fillColor():Swatch
    public function set fillColor(value:Swatch):void
fillTintproperty 
fillTint:Number[override]

The tint (as a percentage) of the fill color of the TextStyleRange. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)


Implementation
    public function get fillTint():Number
    public function set fillTint(value:Number):void
firstLineIndentproperty 
firstLineIndent:Object[override]

The amount to indent the first line.


Implementation
    public function get firstLineIndent():Object
    public function set firstLineIndent(value:Object):void
fontStyleproperty 
fontStyle:String[override]

The name of the font style.


Implementation
    public function get fontStyle():String
    public function set fontStyle(value:String):void
footnotesproperty 
footnotes:Footnotes  [read-only] [override]

A collection of footnotes.


Implementation
    public function get footnotes():Footnotes
formFieldsproperty 
formFields:FormFields  [read-only] [override]

A collection of form fields.


Implementation
    public function get formFields():FormFields
glyphFormproperty 
glyphForm:AlternateGlyphForms[override]

The glyph variant to substitute for standard glyphs.


Implementation
    public function get glyphForm():AlternateGlyphForms
    public function set glyphForm(value:AlternateGlyphForms):void
gradientFillAngleproperty 
gradientFillAngle:Number[override]

The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)


Implementation
    public function get gradientFillAngle():Number
    public function set gradientFillAngle(value:Number):void
gradientFillLengthproperty 
gradientFillLength:Number[override]

The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.


Implementation
    public function get gradientFillLength():Number
    public function set gradientFillLength(value:Number):void
gradientFillStartproperty 
gradientFillStart:Object[override]

The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y].


Implementation
    public function get gradientFillStart():Object
    public function set gradientFillStart(value:Object):void
gradientStrokeAngleproperty 
gradientStrokeAngle:Number[override]

The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180)


Implementation
    public function get gradientStrokeAngle():Number
    public function set gradientStrokeAngle(value:Number):void
gradientStrokeLengthproperty 
gradientStrokeLength:Number[override]

The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text.


Implementation
    public function get gradientStrokeLength():Number
    public function set gradientStrokeLength(value:Number):void
gradientStrokeStartproperty 
gradientStrokeStart:Object[override]

The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y].


Implementation
    public function get gradientStrokeStart():Object
    public function set gradientStrokeStart(value:Object):void
graphicLinesproperty 
graphicLines:GraphicLines  [read-only] [override]

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
gridAlignFirstLineOnlyproperty 
gridAlignFirstLineOnly:Boolean[override]

If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid.


Implementation
    public function get gridAlignFirstLineOnly():Boolean
    public function set gridAlignFirstLineOnly(value:Boolean):void
gridAlignmentproperty 
gridAlignment:GridAlignment[override]

The alignment to the frame grid or baseline grid.


Implementation
    public function get gridAlignment():GridAlignment
    public function set gridAlignment(value:GridAlignment):void
gridGyoudoriproperty 
gridGyoudori:Number[override]

The manual gyoudori setting.


Implementation
    public function get gridGyoudori():Number
    public function set gridGyoudori(value:Number):void
groupsproperty 
groups:Groups  [read-only] [override]

A collection of groups.


Implementation
    public function get groups():Groups
hiddenTextsproperty 
hiddenTexts:HiddenTexts  [read-only] [override]

A collection of hidden text objects.


Implementation
    public function get hiddenTexts():HiddenTexts
horizontalOffsetproperty 
horizontalOffset:Object  [read-only] [override]

The horizontal offset of the text.


Implementation
    public function get horizontalOffset():Object
horizontalScaleproperty 
horizontalScale:Number[override]

The horizontal scaling applied to the TextStyleRange.


Implementation
    public function get horizontalScale():Number
    public function set horizontalScale(value:Number):void
hyphenateAcrossColumnsproperty 
hyphenateAcrossColumns:Boolean[override]

If true, allows the last word in a text column to be hyphenated.


Implementation
    public function get hyphenateAcrossColumns():Boolean
    public function set hyphenateAcrossColumns(value:Boolean):void
hyphenateAfterFirstproperty 
hyphenateAfterFirst:Number[override]

The mininum number of letters at the beginning of a word that can be broken by a hyphen.


Implementation
    public function get hyphenateAfterFirst():Number
    public function set hyphenateAfterFirst(value:Number):void
hyphenateBeforeLastproperty 
hyphenateBeforeLast:Number[override]

The minimum number of letters at the end of a word that can be broken by a hyphen.


Implementation
    public function get hyphenateBeforeLast():Number
    public function set hyphenateBeforeLast(value:Number):void
hyphenateCapitalizedWordsproperty 
hyphenateCapitalizedWords:Boolean[override]

If true, allows hyphenation of capitalized words.


Implementation
    public function get hyphenateCapitalizedWords():Boolean
    public function set hyphenateCapitalizedWords(value:Boolean):void
hyphenateLadderLimitproperty 
hyphenateLadderLimit:Number[override]

The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero.


Implementation
    public function get hyphenateLadderLimit():Number
    public function set hyphenateLadderLimit(value:Number):void
hyphenateLastWordproperty 
hyphenateLastWord:Boolean[override]

If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.


Implementation
    public function get hyphenateLastWord():Boolean
    public function set hyphenateLastWord(value:Boolean):void
hyphenateWordsLongerThanproperty 
hyphenateWordsLongerThan:Number[override]

The minimum number of letters a word must have in order to qualify for hyphenation.


Implementation
    public function get hyphenateWordsLongerThan():Number
    public function set hyphenateWordsLongerThan(value:Number):void
hyphenationproperty 
hyphenation:Boolean[override]

If true, allows hyphenation.


Implementation
    public function get hyphenation():Boolean
    public function set hyphenation(value:Boolean):void
hyphenationZoneproperty 
hyphenationZone:Object[override]

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.


Implementation
    public function get hyphenationZone():Object
    public function set hyphenationZone(value:Object):void
hyphenWeightproperty 
hyphenWeight:Number[override]

The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100)


Implementation
    public function get hyphenWeight():Number
    public function set hyphenWeight(value:Number):void
ignoreEdgeAlignmentproperty 
ignoreEdgeAlignment:Boolean[override]

If true, ignores optical edge alignment for the paragraph.


Implementation
    public function get ignoreEdgeAlignment():Boolean
    public function set ignoreEdgeAlignment(value:Boolean):void
indexproperty 
index:Number  [read-only] [override]

The index of the text in the collection or parent object.


Implementation
    public function get index():Number
insertionPointsproperty 
insertionPoints:InsertionPoints  [read-only] [override]

A collection of insertion points.


Implementation
    public function get insertionPoints():InsertionPoints
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
jidoriproperty 
jidori:Number[override]

The number of grid squares in which to arrange the text.


Implementation
    public function get jidori():Number
    public function set jidori(value:Number):void
justificationproperty 
justification:Justification[override]

The paragraph alignment.


Implementation
    public function get justification():Justification
    public function set justification(value:Justification):void
kashidasproperty 
kashidas:KashidasOptions[override]

Use of Kashidas for justification


Implementation
    public function get kashidas():KashidasOptions
    public function set kashidas(value:KashidasOptions):void
keepAllLinesTogetherproperty 
keepAllLinesTogether:Boolean[override]

If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.


Implementation
    public function get keepAllLinesTogether():Boolean
    public function set keepAllLinesTogether(value:Boolean):void
keepFirstLinesproperty 
keepFirstLines:Number[override]

The minimum number of lines to keep together in a paragraph before allowing a page break.


Implementation
    public function get keepFirstLines():Number
    public function set keepFirstLines(value:Number):void
keepLastLinesproperty 
keepLastLines:Number[override]

The minimum number of lines to keep together in a paragraph after a page break.


Implementation
    public function get keepLastLines():Number
    public function set keepLastLines(value:Number):void
keepLinesTogetherproperty 
keepLinesTogether:Boolean[override]

If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.


Implementation
    public function get keepLinesTogether():Boolean
    public function set keepLinesTogether(value:Boolean):void
keepRuleAboveInFrameproperty 
keepRuleAboveInFrame:Boolean[override]

If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true.


Implementation
    public function get keepRuleAboveInFrame():Boolean
    public function set keepRuleAboveInFrame(value:Boolean):void
keepWithNextproperty 
keepWithNext:Number[override]

The minimum number of lines to keep with the next paragraph.


Implementation
    public function get keepWithNext():Number
    public function set keepWithNext(value:Number):void
keepWithPreviousproperty 
keepWithPrevious:Boolean[override]

If the first line in the paragraph should be kept with the last line of previous paragraph.


Implementation
    public function get keepWithPrevious():Boolean
    public function set keepWithPrevious(value:Boolean):void
kentenAlignmentproperty 
kentenAlignment:KentenAlignment[override]

The alignment of kenten characters relative to the parent characters.


Implementation
    public function get kentenAlignment():KentenAlignment
    public function set kentenAlignment(value:KentenAlignment):void
kentenCharacterSetproperty 
kentenCharacterSet:KentenCharacterSet[override]

The character set used for the custom kenten character. Note: Valid only when kenten kind is custom.


Implementation
    public function get kentenCharacterSet():KentenCharacterSet
    public function set kentenCharacterSet(value:KentenCharacterSet):void
kentenCustomCharacterproperty 
kentenCustomCharacter:String[override]

The character used for kenten. Note: Valid only when kenten kind is custom.


Implementation
    public function get kentenCustomCharacter():String
    public function set kentenCustomCharacter(value:String):void
kentenFillColorproperty 
kentenFillColor:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch or String.


Implementation
    public function get kentenFillColor():Object
    public function set kentenFillColor(value:Object):void
kentenFontproperty 
kentenFont:Object[override]

The font to use for kenten characters. Can return: Font or String.


Implementation
    public function get kentenFont():Object
    public function set kentenFont(value:Object):void
kentenFontSizeproperty 
kentenFontSize:Number[override]

The size (in points) of kenten characters.


Implementation
    public function get kentenFontSize():Number
    public function set kentenFontSize(value:Number):void
kentenFontStyleproperty 
kentenFontStyle:Object[override]

The font style of kenten characters. Can return: String or NothingEnum enumerator.


Implementation
    public function get kentenFontStyle():Object
    public function set kentenFontStyle(value:Object):void
kentenKindproperty 
kentenKind:KentenCharacter[override]

The style of kenten characters.


Implementation
    public function get kentenKind():KentenCharacter
    public function set kentenKind(value:KentenCharacter):void
kentenOverprintFillproperty 
kentenOverprintFill:AdornmentOverprint[override]

The method of overprinting the kenten fill.


Implementation
    public function get kentenOverprintFill():AdornmentOverprint
    public function set kentenOverprintFill(value:AdornmentOverprint):void
kentenOverprintStrokeproperty 
kentenOverprintStroke:AdornmentOverprint[override]

The method of overprinting the kenten stroke.


Implementation
    public function get kentenOverprintStroke():AdornmentOverprint
    public function set kentenOverprintStroke(value:AdornmentOverprint):void
kentenPlacementproperty 
kentenPlacement:Number[override]

The distance between kenten characters and their parent characters.


Implementation
    public function get kentenPlacement():Number
    public function set kentenPlacement(value:Number):void
kentenPositionproperty 
kentenPosition:RubyKentenPosition[override]

The kenten position relative to the parent character.


Implementation
    public function get kentenPosition():RubyKentenPosition
    public function set kentenPosition(value:RubyKentenPosition):void
kentenStrokeColorproperty 
kentenStrokeColor:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch or String.


Implementation
    public function get kentenStrokeColor():Object
    public function set kentenStrokeColor(value:Object):void
kentenStrokeTintproperty 
kentenStrokeTint:Number[override]

The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100)


Implementation
    public function get kentenStrokeTint():Number
    public function set kentenStrokeTint(value:Number):void
kentenTintproperty 
kentenTint:Number[override]

The fill tint (as a percentage) of kenten characters. (Range: 0 to 100)


Implementation
    public function get kentenTint():Number
    public function set kentenTint(value:Number):void
kentenWeightproperty 
kentenWeight:Number[override]

The stroke weight (in points) of kenten characters.


Implementation
    public function get kentenWeight():Number
    public function set kentenWeight(value:Number):void
kentenXScaleproperty 
kentenXScale:Number[override]

The horizontal size of kenten characters as a percent of the original size.


Implementation
    public function get kentenXScale():Number
    public function set kentenXScale(value:Number):void
kentenYScaleproperty 
kentenYScale:Number[override]

The vertical size of kenten charachers as a percent of the original size.


Implementation
    public function get kentenYScale():Number
    public function set kentenYScale(value:Number):void
kerningMethodproperty 
kerningMethod:String[override]

The type of pair kerning.


Implementation
    public function get kerningMethod():String
    public function set kerningMethod(value:String):void
kerningValueproperty 
kerningValue:Number[override]

The amount of space to add or remove between characters, specified in thousands of an em.


Implementation
    public function get kerningValue():Number
    public function set kerningValue(value:Number):void
keyboardDirectionproperty 
keyboardDirection:CharacterDirectionOptions[override]

The keyboard direction of the character.


Implementation
    public function get keyboardDirection():CharacterDirectionOptions
    public function set keyboardDirection(value:CharacterDirectionOptions):void
kinsokuHangTypeproperty 
kinsokuHangType:KinsokuHangTypes[override]

The type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect.


Implementation
    public function get kinsokuHangType():KinsokuHangTypes
    public function set kinsokuHangType(value:KinsokuHangTypes):void
kinsokuSetproperty 
kinsokuSet:Object[override]

The kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator or String.


Implementation
    public function get kinsokuSet():Object
    public function set kinsokuSet(value:Object):void
kinsokuTypeproperty 
kinsokuType:KinsokuType[override]

The type of kinsoku processing for preventing kinsoku characters from beginning or ending a line. Note: Valid only when a kinsoku set is defined.


Implementation
    public function get kinsokuType():KinsokuType
    public function set kinsokuType(value:KinsokuType):void
lastLineIndentproperty 
lastLineIndent:Object[override]

The amount to indent the last line in the paragraph.


Implementation
    public function get lastLineIndent():Object
    public function set lastLineIndent(value:Object):void
leadingproperty 
leading:Object[override]

The leading applied to the text. Can return: Unit or Leading enumerator.


Implementation
    public function get leading():Object
    public function set leading(value:Object):void
leadingAkiproperty 
leadingAki:Number[override]

The amount of space before each character.


Implementation
    public function get leadingAki():Number
    public function set leadingAki(value:Number):void
leadingModelproperty 
leadingModel:LeadingModel[override]

The point from which leading is measured from line to line.


Implementation
    public function get leadingModel():LeadingModel
    public function set leadingModel(value:LeadingModel):void
leftIndentproperty 
leftIndent:Object[override]

The width of the left indent.


Implementation
    public function get leftIndent():Object
    public function set leftIndent(value:Object):void
lengthproperty 
length:Number  [read-only] [override]

The number of objects in the collection.


Implementation
    public function get length():Number
ligaturesproperty 
ligatures:Boolean[override]

If true, replaces specific character combinations (e.g., fl, fi) with ligature characters.


Implementation
    public function get ligatures():Boolean
    public function set ligatures(value:Boolean):void
linesproperty 
lines:Lines  [read-only] [override]

A collection of lines.


Implementation
    public function get lines():Lines
maximumGlyphScalingproperty 
maximumGlyphScaling:Number[override]

The maximum width (as a percentage) of individual characters. (Range: 50 to 200)


Implementation
    public function get maximumGlyphScaling():Number
    public function set maximumGlyphScaling(value:Number):void
maximumLetterSpacingproperty 
maximumLetterSpacing:Number[override]

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.


Implementation
    public function get maximumLetterSpacing():Number
    public function set maximumLetterSpacing(value:Number):void
maximumWordSpacingproperty 
maximumWordSpacing:Number[override]

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)


Implementation
    public function get maximumWordSpacing():Number
    public function set maximumWordSpacing(value:Number):void
minimumGlyphScalingproperty 
minimumGlyphScaling:Number[override]

The minimum width (as a percentage) of individual characters. (Range: 50 to 200)


Implementation
    public function get minimumGlyphScaling():Number
    public function set minimumGlyphScaling(value:Number):void
minimumLetterSpacingproperty 
minimumLetterSpacing:Number[override]

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.


Implementation
    public function get minimumLetterSpacing():Number
    public function set minimumLetterSpacing(value:Number):void
minimumWordSpacingproperty 
minimumWordSpacing:Number[override]

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)


Implementation
    public function get minimumWordSpacing():Number
    public function set minimumWordSpacing(value:Number):void
miterLimitproperty 
miterLimit:Number[override]

The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.


Implementation
    public function get miterLimit():Number
    public function set miterLimit(value:Number):void
mojikumiproperty 
mojikumi:Object[override]

The mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String or MojikumiTableDefaults enumerator.


Implementation
    public function get mojikumi():Object
    public function set mojikumi(value:Object):void
multiStateObjectsproperty 
multiStateObjects:MultiStateObjects  [read-only] [override]

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
nestedGrepStylesproperty 
nestedGrepStyles:NestedGrepStyles  [read-only] [override]

A collection of nested GREP styles.


Implementation
    public function get nestedGrepStyles():NestedGrepStyles
nestedLineStylesproperty 
nestedLineStyles:NestedLineStyles  [read-only] [override]

A collection of nested line styles.


Implementation
    public function get nestedLineStyles():NestedLineStyles
nestedStylesproperty 
nestedStyles:NestedStyles  [read-only] [override]

A collection of nested styles.


Implementation
    public function get nestedStyles():NestedStyles
noBreakproperty 
noBreak:Boolean[override]

If true, keeps the text on the same line.


Implementation
    public function get noBreak():Boolean
    public function set noBreak(value:Boolean):void
notesproperty 
notes:Notes  [read-only] [override]

A collection of notes.


Implementation
    public function get notes():Notes
numberingAlignmentproperty 
numberingAlignment:ListAlignment[override]

The alignment of the number.


Implementation
    public function get numberingAlignment():ListAlignment
    public function set numberingAlignment(value:ListAlignment):void
numberingApplyRestartPolicyproperty 
numberingApplyRestartPolicy:Boolean[override]

If true, apply the numbering restart policy.


Implementation
    public function get numberingApplyRestartPolicy():Boolean
    public function set numberingApplyRestartPolicy(value:Boolean):void
numberingCharacterStyleproperty 
numberingCharacterStyle:Object[override]

The character style to be used for the number string. Can return: CharacterStyle or String.


Implementation
    public function get numberingCharacterStyle():Object
    public function set numberingCharacterStyle(value:Object):void
numberingContinueproperty 
numberingContinue:Boolean[override]

Continue the numbering at this level.


Implementation
    public function get numberingContinue():Boolean
    public function set numberingContinue(value:Boolean):void
numberingExpressionproperty 
numberingExpression:String[override]

The number string expression for numbering.


Implementation
    public function get numberingExpression():String
    public function set numberingExpression(value:String):void
numberingFormatproperty 
numberingFormat:Object[override]

Numbering format options. Can return: NumberingStyle enumerator or String.


Implementation
    public function get numberingFormat():Object
    public function set numberingFormat(value:Object):void
numberingLevelproperty 
numberingLevel:Number[override]

The level of the paragraph.


Implementation
    public function get numberingLevel():Number
    public function set numberingLevel(value:Number):void
numberingRestartPoliciesproperty 
numberingRestartPolicies:NumberingRestartPolicy  [read-only] [override]

Numbering restart policies.


Implementation
    public function get numberingRestartPolicies():NumberingRestartPolicy
numberingStartAtproperty 
numberingStartAt:Number[override]

Determines starting number in a numbered list.


Implementation
    public function get numberingStartAt():Number
    public function set numberingStartAt(value:Number):void
opentypeFeaturesproperty 
opentypeFeatures:Object[override]

OpenType features. Can return: Array of Array of 2 Strings or Long Integers.


Implementation
    public function get opentypeFeatures():Object
    public function set opentypeFeatures(value:Object):void
otfContextualAlternateproperty 
otfContextualAlternate:Boolean[override]

If true, uses contextual alternate forms in OpenType fonts.


Implementation
    public function get otfContextualAlternate():Boolean
    public function set otfContextualAlternate(value:Boolean):void
otfDiscretionaryLigatureproperty 
otfDiscretionaryLigature:Boolean[override]

If true, uses discretionary ligatures in OpenType fonts.


Implementation
    public function get otfDiscretionaryLigature():Boolean
    public function set otfDiscretionaryLigature(value:Boolean):void
otfFigureStyleproperty 
otfFigureStyle:OTFFigureStyle[override]

The figure style in OpenType fonts.


Implementation
    public function get otfFigureStyle():OTFFigureStyle
    public function set otfFigureStyle(value:OTFFigureStyle):void
otfFractionproperty 
otfFraction:Boolean[override]

If true, uses fractions in OpenType fonts.


Implementation
    public function get otfFraction():Boolean
    public function set otfFraction(value:Boolean):void
otfHistoricalproperty 
otfHistorical:Boolean[override]

If true, use historical forms in OpenType fonts.


Implementation
    public function get otfHistorical():Boolean
    public function set otfHistorical(value:Boolean):void
otfHVKanaproperty 
otfHVKana:Boolean[override]

If true, switches hiragana fonts, which have different glyphs for horizontal and vertical.


Implementation
    public function get otfHVKana():Boolean
    public function set otfHVKana(value:Boolean):void
otfJustificationAlternateproperty 
otfJustificationAlternate:Boolean[override]

If true, use alternate justification forms in OpenType fonts


Implementation
    public function get otfJustificationAlternate():Boolean
    public function set otfJustificationAlternate(value:Boolean):void
otfLocaleproperty 
otfLocale:Boolean[override]

If true, uses localized forms in OpenType fonts.


Implementation
    public function get otfLocale():Boolean
    public function set otfLocale(value:Boolean):void
otfMarkproperty 
otfMark:Boolean[override]

If true, uses mark positioning in OpenType fonts.


Implementation
    public function get otfMark():Boolean
    public function set otfMark(value:Boolean):void
otfOrdinalproperty 
otfOrdinal:Boolean[override]

If true, uses ordinals in OpenType fonts.


Implementation
    public function get otfOrdinal():Boolean
    public function set otfOrdinal(value:Boolean):void
otfOverlapSwashproperty 
otfOverlapSwash:Boolean[override]

If true, use overlapping swash forms in OpenType fonts


Implementation
    public function get otfOverlapSwash():Boolean
    public function set otfOverlapSwash(value:Boolean):void
otfProportionalMetricsproperty 
otfProportionalMetrics:Boolean[override]

If true, kerns according to proportional CJK metrics in OpenType fonts.


Implementation
    public function get otfProportionalMetrics():Boolean
    public function set otfProportionalMetrics(value:Boolean):void
otfRomanItalicsproperty 
otfRomanItalics:Boolean[override]

If true, applies italics to half-width alphanumerics.


Implementation
    public function get otfRomanItalics():Boolean
    public function set otfRomanItalics(value:Boolean):void
otfSlashedZeroproperty 
otfSlashedZero:Boolean[override]

If true, use a slashed zeroes in OpenType fonts.


Implementation
    public function get otfSlashedZero():Boolean
    public function set otfSlashedZero(value:Boolean):void
otfStretchedAlternateproperty 
otfStretchedAlternate:Boolean[override]

If true, use stretched alternate forms in OpenType fonts


Implementation
    public function get otfStretchedAlternate():Boolean
    public function set otfStretchedAlternate(value:Boolean):void
otfStylisticAlternateproperty 
otfStylisticAlternate:Boolean[override]

If true, use stylistic alternate forms in OpenType fonts


Implementation
    public function get otfStylisticAlternate():Boolean
    public function set otfStylisticAlternate(value:Boolean):void
otfStylisticSetsproperty 
otfStylisticSets:Number[override]

The stylistic sets to use in OpenType fonts.


Implementation
    public function get otfStylisticSets():Number
    public function set otfStylisticSets(value:Number):void
otfSwashproperty 
otfSwash:Boolean[override]

If true, uses swash forms in OpenType fonts.


Implementation
    public function get otfSwash():Boolean
    public function set otfSwash(value:Boolean):void
otfTitlingproperty 
otfTitling:Boolean[override]

If true, uses titling forms in OpenType fonts.


Implementation
    public function get otfTitling():Boolean
    public function set otfTitling(value:Boolean):void
ovalsproperty 
ovals:Ovals  [read-only] [override]

A collection of ellipses.


Implementation
    public function get ovals():Ovals
overprintFillproperty 
overprintFill:Boolean[override]

If true, the fill color of the characters will overprint.


Implementation
    public function get overprintFill():Boolean
    public function set overprintFill(value:Boolean):void
overprintStrokeproperty 
overprintStroke:Boolean[override]

If true, the stroke of the characters will overprint.


Implementation
    public function get overprintStroke():Boolean
    public function set overprintStroke(value:Boolean):void
pageItemsproperty 
pageItems:PageItems  [read-only] [override]

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.


Implementation
    public function get pageItems():PageItems
paragraphDirectionproperty 
paragraphDirection:ParagraphDirectionOptions[override]

Paragraph direction.


Implementation
    public function get paragraphDirection():ParagraphDirectionOptions
    public function set paragraphDirection(value:ParagraphDirectionOptions):void
paragraphGyoudoriproperty 
paragraphGyoudori:Boolean[override]

If true, the gyoudori mode applies to the entire paragraph. If false, the gyoudori mode applies to each line in the paragraph.


Implementation
    public function get paragraphGyoudori():Boolean
    public function set paragraphGyoudori(value:Boolean):void
paragraphJustificationproperty 
paragraphJustification:ParagraphJustificationOptions[override]

Paragraph justification.


Implementation
    public function get paragraphJustification():ParagraphJustificationOptions
    public function set paragraphJustification(value:ParagraphJustificationOptions):void
paragraphsproperty 
paragraphs:Paragraphs  [read-only] [override]

A collection of paragraphs.


Implementation
    public function get paragraphs():Paragraphs
parentproperty 
parent:Object  [read-only] [override]

The parent of the TextStyleRange (a XmlStory, TextPath, TextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story, Cell, XMLElement, Footnote, Note, Change or HiddenText).


Implementation
    public function get parent():Object
parentStoryproperty 
parentStory:Story  [read-only] [override]

The story that contains the text.


Implementation
    public function get parentStory():Story
parentTextFramesproperty 
parentTextFrames:Object  [read-only] [override]

An array of the text frames that contain the text. Can return: Array of TextFrames or TextPaths.


Implementation
    public function get parentTextFrames():Object
pointSizeproperty 
pointSize:Object[override]

The text size.


Implementation
    public function get pointSize():Object
    public function set pointSize(value:Object):void
polygonsproperty 
polygons:Polygons  [read-only] [override]

A collection of polygons.


Implementation
    public function get polygons():Polygons
positionproperty 
position:Position[override]

The text position relative to the baseline.


Implementation
    public function get position():Position
    public function set position(value:Position):void
positionalFormproperty 
positionalForm:PositionalForms[override]

The OpenType positional form.


Implementation
    public function get positionalForm():PositionalForms
    public function set positionalForm(value:PositionalForms):void
preferencesproperty 
preferences:Preferences  [read-only] [override]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
propertiesproperty 
properties:Object[override]

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rectanglesproperty 
rectangles:Rectangles  [read-only] [override]

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
rensuujiproperty 
rensuuji:Boolean[override]

If true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers.


Implementation
    public function get rensuuji():Boolean
    public function set rensuuji(value:Boolean):void
rightIndentproperty 
rightIndent:Object[override]

The width of the right indent.


Implementation
    public function get rightIndent():Object
    public function set rightIndent(value:Object):void
rotateSingleByteCharactersproperty 
rotateSingleByteCharacters:Boolean[override]

If true, rotates Roman characters in vertical text.


Implementation
    public function get rotateSingleByteCharacters():Boolean
    public function set rotateSingleByteCharacters(value:Boolean):void
rubyAlignmentproperty 
rubyAlignment:RubyAlignments[override]

The ruby alignment.


Implementation
    public function get rubyAlignment():RubyAlignments
    public function set rubyAlignment(value:RubyAlignments):void
rubyAutoAlignproperty 
rubyAutoAlign:Boolean[override]

If true, auto aligns ruby.


Implementation
    public function get rubyAutoAlign():Boolean
    public function set rubyAutoAlign(value:Boolean):void
rubyAutoScalingproperty 
rubyAutoScaling:Boolean[override]

If true, automatically scales ruby to the specified percent of parent text size. For information on specifying a percent, see ruby parent scaling percent.


Implementation
    public function get rubyAutoScaling():Boolean
    public function set rubyAutoScaling(value:Boolean):void
rubyAutoTcyAutoScaleproperty 
rubyAutoTcyAutoScale:Boolean[override]

If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em.


Implementation
    public function get rubyAutoTcyAutoScale():Boolean
    public function set rubyAutoTcyAutoScale(value:Boolean):void
rubyAutoTcyDigitsproperty 
rubyAutoTcyDigits:Number[override]

The number of digits included in auto tcy (tate-chuu-yoko) in ruby.


Implementation
    public function get rubyAutoTcyDigits():Number
    public function set rubyAutoTcyDigits(value:Number):void
rubyAutoTcyIncludeRomanproperty 
rubyAutoTcyIncludeRoman:Boolean[override]

If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby.


Implementation
    public function get rubyAutoTcyIncludeRoman():Boolean
    public function set rubyAutoTcyIncludeRoman(value:Boolean):void
rubyFillproperty 
rubyFill:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch or String.


Implementation
    public function get rubyFill():Object
    public function set rubyFill(value:Object):void
rubyFlagproperty 
rubyFlag:Boolean[override]

If true, ruby is on.


Implementation
    public function get rubyFlag():Boolean
    public function set rubyFlag(value:Boolean):void
rubyFontproperty 
rubyFont:Object[override]

The font applied to ruby characters. Can return: Font or String.


Implementation
    public function get rubyFont():Object
    public function set rubyFont(value:Object):void
rubyFontSizeproperty 
rubyFontSize:Number[override]

The size (in points) of ruby characters.


Implementation
    public function get rubyFontSize():Number
    public function set rubyFontSize(value:Number):void
rubyFontStyleproperty 
rubyFontStyle:Object[override]

The font style of ruby characters. Can return: String or NothingEnum enumerator.


Implementation
    public function get rubyFontStyle():Object
    public function set rubyFontStyle(value:Object):void
rubyOpenTypeProproperty 
rubyOpenTypePro:Boolean[override]

If true, uses OpenType Pro fonts for ruby.


Implementation
    public function get rubyOpenTypePro():Boolean
    public function set rubyOpenTypePro(value:Boolean):void
rubyOverhangproperty 
rubyOverhang:Boolean[override]

If true, constrains ruby overhang to the specified amount. For information on specifying an amount, see ruby parent overhang amount.


Implementation
    public function get rubyOverhang():Boolean
    public function set rubyOverhang(value:Boolean):void
rubyOverprintFillproperty 
rubyOverprintFill:AdornmentOverprint[override]

The method of overprinting the ruby fill.


Implementation
    public function get rubyOverprintFill():AdornmentOverprint
    public function set rubyOverprintFill(value:AdornmentOverprint):void
rubyOverprintStrokeproperty 
rubyOverprintStroke:AdornmentOverprint[override]

The method of overprinting the ruby stroke.


Implementation
    public function get rubyOverprintStroke():AdornmentOverprint
    public function set rubyOverprintStroke(value:AdornmentOverprint):void
rubyParentOverhangAmountproperty 
rubyParentOverhangAmount:RubyOverhang[override]

The amount by which ruby characters can overhang the parent text.


Implementation
    public function get rubyParentOverhangAmount():RubyOverhang
    public function set rubyParentOverhangAmount(value:RubyOverhang):void
rubyParentScalingPercentproperty 
rubyParentScalingPercent:Number[override]

The amount (as a percentage) to scale the parent text size to determine the ruby text size.


Implementation
    public function get rubyParentScalingPercent():Number
    public function set rubyParentScalingPercent(value:Number):void
rubyParentSpacingproperty 
rubyParentSpacing:RubyParentSpacing[override]

The ruby spacing relative to the parent text.


Implementation
    public function get rubyParentSpacing():RubyParentSpacing
    public function set rubyParentSpacing(value:RubyParentSpacing):void
rubyPositionproperty 
rubyPosition:RubyKentenPosition[override]

The position of ruby characters relative to the parent text.


Implementation
    public function get rubyPosition():RubyKentenPosition
    public function set rubyPosition(value:RubyKentenPosition):void
rubyStringproperty 
rubyString:String[override]

The ruby string contents.


Implementation
    public function get rubyString():String
    public function set rubyString(value:String):void
rubyStrokeproperty 
rubyStroke:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch or String.


Implementation
    public function get rubyStroke():Object
    public function set rubyStroke(value:Object):void
rubyStrokeTintproperty 
rubyStrokeTint:Number[override]

The stroke tint (as a percentage) of ruby characters.


Implementation
    public function get rubyStrokeTint():Number
    public function set rubyStrokeTint(value:Number):void
rubyTintproperty 
rubyTint:Number[override]

The tint (as a percentage) of the ruby fill color. (Range: 0 to 100)


Implementation
    public function get rubyTint():Number
    public function set rubyTint(value:Number):void
rubyTypeproperty 
rubyType:RubyTypes[override]

The ruby type.


Implementation
    public function get rubyType():RubyTypes
    public function set rubyType(value:RubyTypes):void
rubyWeightproperty 
rubyWeight:Number[override]

The stroke weight (in points) of ruby characters.


Implementation
    public function get rubyWeight():Number
    public function set rubyWeight(value:Number):void
rubyXOffsetproperty 
rubyXOffset:Number[override]

The amount of horizontal space between ruby and parent characters.


Implementation
    public function get rubyXOffset():Number
    public function set rubyXOffset(value:Number):void
rubyXScaleproperty 
rubyXScale:Number[override]

The horizontal size of ruby characters, specified as a percent of the original size.


Implementation
    public function get rubyXScale():Number
    public function set rubyXScale(value:Number):void
rubyYOffsetproperty 
rubyYOffset:Number[override]

The amount of vertical space between ruby and parent characters.


Implementation
    public function get rubyYOffset():Number
    public function set rubyYOffset(value:Number):void
rubyYScaleproperty 
rubyYScale:Number[override]

The vertical size of ruby characters, specified as a percent of the original size.


Implementation
    public function get rubyYScale():Number
    public function set rubyYScale(value:Number):void
ruleAboveproperty 
ruleAbove:Boolean[override]

If true, places a rule above the paragraph.


Implementation
    public function get ruleAbove():Boolean
    public function set ruleAbove(value:Boolean):void
ruleAboveColorproperty 
ruleAboveColor:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.


Implementation
    public function get ruleAboveColor():Object
    public function set ruleAboveColor(value:Object):void
ruleAboveGapColorproperty 
ruleAboveGapColor:Object[override]

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.


Implementation
    public function get ruleAboveGapColor():Object
    public function set ruleAboveGapColor(value:Object):void
ruleAboveGapOverprintproperty 
ruleAboveGapOverprint:Boolean[override]

If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid.


Implementation
    public function get ruleAboveGapOverprint():Boolean
    public function set ruleAboveGapOverprint(value:Boolean):void
ruleAboveGapTintproperty 
ruleAboveGapTint:Number[override]

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.


Implementation
    public function get ruleAboveGapTint():Number
    public function set ruleAboveGapTint(value:Number):void
ruleAboveLeftIndentproperty 
ruleAboveLeftIndent:Object[override]

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.


Implementation
    public function get ruleAboveLeftIndent():Object
    public function set ruleAboveLeftIndent(value:Object):void
ruleAboveLineWeightproperty 
ruleAboveLineWeight:Object[override]

The line weight of the rule above.


Implementation
    public function get ruleAboveLineWeight():Object
    public function set ruleAboveLineWeight(value:Object):void
ruleAboveOffsetproperty 
ruleAboveOffset:Object[override]

The amount to offset the paragraph rule above from the baseline of the first line the paragraph.


Implementation
    public function get ruleAboveOffset():Object
    public function set ruleAboveOffset(value:Object):void
ruleAboveOverprintproperty 
ruleAboveOverprint:Boolean[override]

If true, the paragraph rule above will overprint.


Implementation
    public function get ruleAboveOverprint():Boolean
    public function set ruleAboveOverprint(value:Boolean):void
ruleAboveRightIndentproperty 
ruleAboveRightIndent:Object[override]

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.


Implementation
    public function get ruleAboveRightIndent():Object
    public function set ruleAboveRightIndent(value:Object):void
ruleAboveTintproperty 
ruleAboveTint:Number[override]

The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)


Implementation
    public function get ruleAboveTint():Number
    public function set ruleAboveTint(value:Number):void
ruleAboveTypeproperty 
ruleAboveType:Object[override]

The stroke type of the rule above the paragraph. Can return: StrokeStyle or String.


Implementation
    public function get ruleAboveType():Object
    public function set ruleAboveType(value:Object):void
ruleAboveWidthproperty 
ruleAboveWidth:RuleWidth[override]

The basis (text width or column width) used to calculate the width of the paragraph rule above.


Implementation
    public function get ruleAboveWidth():RuleWidth
    public function set ruleAboveWidth(value:RuleWidth):void
ruleBelowproperty 
ruleBelow:Boolean[override]

If true, applies a paragraph rule below.


Implementation
    public function get ruleBelow():Boolean
    public function set ruleBelow(value:Boolean):void
ruleBelowColorproperty 
ruleBelowColor:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.


Implementation
    public function get ruleBelowColor():Object
    public function set ruleBelowColor(value:Object):void
ruleBelowGapColorproperty 
ruleBelowGapColor:Object[override]

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.


Implementation
    public function get ruleBelowGapColor():Object
    public function set ruleBelowGapColor(value:Object):void
ruleBelowGapOverprintproperty 
ruleBelowGapOverprint:Boolean[override]

If true, the gap color of the rule below will overprint.


Implementation
    public function get ruleBelowGapOverprint():Boolean
    public function set ruleBelowGapOverprint(value:Boolean):void
ruleBelowGapTintproperty 
ruleBelowGapTint:Number[override]

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.


Implementation
    public function get ruleBelowGapTint():Number
    public function set ruleBelowGapTint(value:Number):void
ruleBelowLeftIndentproperty 
ruleBelowLeftIndent:Object[override]

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.


Implementation
    public function get ruleBelowLeftIndent():Object
    public function set ruleBelowLeftIndent(value:Object):void
ruleBelowLineWeightproperty 
ruleBelowLineWeight:Object[override]

The line weight of the rule below.


Implementation
    public function get ruleBelowLineWeight():Object
    public function set ruleBelowLineWeight(value:Object):void
ruleBelowOffsetproperty 
ruleBelowOffset:Object[override]

The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.


Implementation
    public function get ruleBelowOffset():Object
    public function set ruleBelowOffset(value:Object):void
ruleBelowOverprintproperty 
ruleBelowOverprint:Boolean[override]

If true, the rule below will overprint.


Implementation
    public function get ruleBelowOverprint():Boolean
    public function set ruleBelowOverprint(value:Boolean):void
ruleBelowRightIndentproperty 
ruleBelowRightIndent:Object[override]

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.


Implementation
    public function get ruleBelowRightIndent():Object
    public function set ruleBelowRightIndent(value:Object):void
ruleBelowTintproperty 
ruleBelowTint:Number[override]

The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)


Implementation
    public function get ruleBelowTint():Number
    public function set ruleBelowTint(value:Number):void
ruleBelowTypeproperty 
ruleBelowType:Object[override]

The stroke type of the rule below the paragraph. Can return: StrokeStyle or String.


Implementation
    public function get ruleBelowType():Object
    public function set ruleBelowType(value:Object):void
ruleBelowWidthproperty 
ruleBelowWidth:RuleWidth[override]

The basis (text width or column width) used to calculate the width of the paragraph rule below.


Implementation
    public function get ruleBelowWidth():RuleWidth
    public function set ruleBelowWidth(value:RuleWidth):void
scaleAffectsLineHeightproperty 
scaleAffectsLineHeight:Boolean[override]

If true, the line changes size when characters are scaled.


Implementation
    public function get scaleAffectsLineHeight():Boolean
    public function set scaleAffectsLineHeight(value:Boolean):void
shataiAdjustRotationproperty 
shataiAdjustRotation:Boolean[override]

If true, applies shatai rotation.


Implementation
    public function get shataiAdjustRotation():Boolean
    public function set shataiAdjustRotation(value:Boolean):void
shataiAdjustTsumeproperty 
shataiAdjustTsume:Boolean[override]

If true, adjusts shatai tsume.


Implementation
    public function get shataiAdjustTsume():Boolean
    public function set shataiAdjustTsume(value:Boolean):void
shataiDegreeAngleproperty 
shataiDegreeAngle:Number[override]

The shatai lens angle (in degrees).


Implementation
    public function get shataiDegreeAngle():Number
    public function set shataiDegreeAngle(value:Number):void
shataiMagnificationproperty 
shataiMagnification:Number[override]

The amount (as a percentage) of shatai obliquing to apply.


Implementation
    public function get shataiMagnification():Number
    public function set shataiMagnification(value:Number):void
singleWordJustificationproperty 
singleWordJustification:SingleWordJustification[override]

The alignment to use for lines that contain a single word.


Implementation
    public function get singleWordJustification():SingleWordJustification
    public function set singleWordJustification(value:SingleWordJustification):void
skewproperty 
skew:Number[override]

The skew angle of the TextStyleRange.


Implementation
    public function get skew():Number
    public function set skew(value:Number):void
spaceAfterproperty 
spaceAfter:Object[override]

The height of the paragraph space below.


Implementation
    public function get spaceAfter():Object
    public function set spaceAfter(value:Object):void
spaceBeforeproperty 
spaceBefore:Object[override]

The height of the paragraph space above.


Implementation
    public function get spaceBefore():Object
    public function set spaceBefore(value:Object):void
spanColumnMinSpaceAfterproperty 
spanColumnMinSpaceAfter:Object[override]

The minimum space after a span or a split column


Implementation
    public function get spanColumnMinSpaceAfter():Object
    public function set spanColumnMinSpaceAfter(value:Object):void
spanColumnMinSpaceBeforeproperty 
spanColumnMinSpaceBefore:Object[override]

The minimum space before a span or a split column


Implementation
    public function get spanColumnMinSpaceBefore():Object
    public function set spanColumnMinSpaceBefore(value:Object):void
spanColumnTypeproperty 
spanColumnType:SpanColumnTypeOptions[override]

Whether a paragraph should be a single column, span columns or split columns


Implementation
    public function get spanColumnType():SpanColumnTypeOptions
    public function set spanColumnType(value:SpanColumnTypeOptions):void
spanSplitColumnCountproperty 
spanSplitColumnCount:Object[override]

The number of columns a paragraph spans or the number of split columns. Can return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator.


Implementation
    public function get spanSplitColumnCount():Object
    public function set spanSplitColumnCount(value:Object):void
splineItemsproperty 
splineItems:SplineItems  [read-only] [override]

The spline items collection.


Implementation
    public function get splineItems():SplineItems
splitColumnInsideGutterproperty 
splitColumnInsideGutter:Object[override]

The inside gutter if the paragraph splits columns


Implementation
    public function get splitColumnInsideGutter():Object
    public function set splitColumnInsideGutter(value:Object):void
splitColumnOutsideGutterproperty 
splitColumnOutsideGutter:Object[override]

The outside gutter if the paragraph splits columns


Implementation
    public function get splitColumnOutsideGutter():Object
    public function set splitColumnOutsideGutter(value:Object):void
startParagraphproperty 
startParagraph:StartParagraph[override]

The location at which to start the paragraph.


Implementation
    public function get startParagraph():StartParagraph
    public function set startParagraph(value:StartParagraph):void
strikeThroughColorproperty 
strikeThroughColor:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.


Implementation
    public function get strikeThroughColor():Object
    public function set strikeThroughColor(value:Object):void
strikeThroughGapColorproperty 
strikeThroughGapColor:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String.


Implementation
    public function get strikeThroughGapColor():Object
    public function set strikeThroughGapColor(value:Object):void
strikeThroughGapOverprintproperty 
strikeThroughGapOverprint:Boolean[override]

If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.


Implementation
    public function get strikeThroughGapOverprint():Boolean
    public function set strikeThroughGapOverprint(value:Boolean):void
strikeThroughGapTintproperty 
strikeThroughGapTint:Number[override]

The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid.


Implementation
    public function get strikeThroughGapTint():Number
    public function set strikeThroughGapTint(value:Number):void
strikeThroughOffsetproperty 
strikeThroughOffset:Object[override]

The amount by which to offset the strikethrough stroke from the text baseline.


Implementation
    public function get strikeThroughOffset():Object
    public function set strikeThroughOffset(value:Object):void
strikeThroughOverprintproperty 
strikeThroughOverprint:Boolean[override]

If true, the strikethrough stroke will overprint.


Implementation
    public function get strikeThroughOverprint():Boolean
    public function set strikeThroughOverprint(value:Boolean):void
strikeThroughTintproperty 
strikeThroughTint:Number[override]

The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)


Implementation
    public function get strikeThroughTint():Number
    public function set strikeThroughTint(value:Number):void
strikeThroughTypeproperty 
strikeThroughType:Object[override]

The stroke type of the strikethrough stroke. Can return: StrokeStyle or String.


Implementation
    public function get strikeThroughType():Object
    public function set strikeThroughType(value:Object):void
strikeThroughWeightproperty 
strikeThroughWeight:Object[override]

The stroke weight of the strikethrough stroke.


Implementation
    public function get strikeThroughWeight():Object
    public function set strikeThroughWeight(value:Object):void
strikeThruproperty 
strikeThru:Boolean[override]

If true, draws a strikethrough line through the text.


Implementation
    public function get strikeThru():Boolean
    public function set strikeThru(value:Boolean):void
strokeAlignmentproperty 
strokeAlignment:TextStrokeAlign[override]

The stroke alignment applied to the text.


Implementation
    public function get strokeAlignment():TextStrokeAlign
    public function set strokeAlignment(value:TextStrokeAlign):void
strokeColorproperty 
strokeColor:Swatch[override]

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the TextStyleRange. Can also accept: String.


Implementation
    public function get strokeColor():Swatch
    public function set strokeColor(value:Swatch):void
strokeTintproperty 
strokeTint:Number[override]

The tint (as a percentage) of the stroke color of the TextStyleRange. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)


Implementation
    public function get strokeTint():Number
    public function set strokeTint(value:Number):void
strokeWeightproperty 
strokeWeight:Object[override]

The stroke weight applied to the characters of the text.


Implementation
    public function get strokeWeight():Object
    public function set strokeWeight(value:Object):void
styleOverriddenproperty 
styleOverridden:Boolean  [read-only] [override]

If true, the applied style has been overridden with additional attributes.


Implementation
    public function get styleOverridden():Boolean
tablesproperty 
tables:Tables  [read-only] [override]

A collection of tables.


Implementation
    public function get tables():Tables
tabListproperty 
tabList:Object[override]

A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs.


Implementation
    public function get tabList():Object
    public function set tabList(value:Object):void
tabStopsproperty 
tabStops:TabStops  [read-only] [override]

A collection of tab stops.


Implementation
    public function get tabStops():TabStops
tatechuyokoproperty 
tatechuyoko:Boolean[override]

If true, makes the character horizontal in vertical text.


Implementation
    public function get tatechuyoko():Boolean
    public function set tatechuyoko(value:Boolean):void
tatechuyokoXOffsetproperty 
tatechuyokoXOffset:Number[override]

The horizontal offset for horizontal characters in vertical text.


Implementation
    public function get tatechuyokoXOffset():Number
    public function set tatechuyokoXOffset(value:Number):void
tatechuyokoYOffsetproperty 
tatechuyokoYOffset:Number[override]

The vertical offset for horizontal characters in vertical text.


Implementation
    public function get tatechuyokoYOffset():Number
    public function set tatechuyokoYOffset(value:Number):void
textColumnsproperty 
textColumns:TextColumns  [read-only] [override]

A collection of text columns.


Implementation
    public function get textColumns():TextColumns
textFramesproperty 
textFrames:TextFrames  [read-only] [override]

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
textsproperty 
texts:Texts  [read-only] [override]

A collection of text objects.


Implementation
    public function get texts():Texts
textStyleRangesproperty 
textStyleRanges:TextStyleRanges  [read-only] [override]

A collection of text style ranges.


Implementation
    public function get textStyleRanges():TextStyleRanges
textVariableInstancesproperty 
textVariableInstances:TextVariableInstances  [read-only] [override]

A collection of text variable instances.


Implementation
    public function get textVariableInstances():TextVariableInstances
trackingproperty 
tracking:Number[override]

The amount by which to loosen or tighten a block of text, specified in thousands of an em.


Implementation
    public function get tracking():Number
    public function set tracking(value:Number):void
trailingAkiproperty 
trailingAki:Number[override]

The amount of space after each character.


Implementation
    public function get trailingAki():Number
    public function set trailingAki(value:Number):void
treatIdeographicSpaceAsSpaceproperty 
treatIdeographicSpaceAsSpace:Boolean[override]

If true, ideographic spaces will not wrap to the next line like text characters.


Implementation
    public function get treatIdeographicSpaceAsSpace():Boolean
    public function set treatIdeographicSpaceAsSpace(value:Boolean):void
tsumeproperty 
tsume:Number[override]

The amount of horizontal character compression.


Implementation
    public function get tsume():Number
    public function set tsume(value:Number):void
underlineproperty 
underline:Boolean[override]

If true, underlines the text.


Implementation
    public function get underline():Boolean
    public function set underline(value:Boolean):void
underlineColorproperty 
underlineColor:Object[override]

The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.


Implementation
    public function get underlineColor():Object
    public function set underlineColor(value:Object):void
underlineGapColorproperty 
underlineGapColor:Object[override]

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.


Implementation
    public function get underlineGapColor():Object
    public function set underlineGapColor(value:Object):void
underlineGapOverprintproperty 
underlineGapOverprint:Boolean[override]

If true, the gap color of the underline stroke will overprint.


Implementation
    public function get underlineGapOverprint():Boolean
    public function set underlineGapOverprint(value:Boolean):void
underlineGapTintproperty 
underlineGapTint:Number[override]

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.


Implementation
    public function get underlineGapTint():Number
    public function set underlineGapTint(value:Number):void
underlineOffsetproperty 
underlineOffset:Object[override]

The amount by which to offset the underline from the text baseline.


Implementation
    public function get underlineOffset():Object
    public function set underlineOffset(value:Object):void
underlineOverprintproperty 
underlineOverprint:Boolean[override]

If true, the underline stroke color will overprint.


Implementation
    public function get underlineOverprint():Boolean
    public function set underlineOverprint(value:Boolean):void
underlineTintproperty 
underlineTint:Number[override]

The underline stroke tint (as a percentage). (Range: 0 to 100)


Implementation
    public function get underlineTint():Number
    public function set underlineTint(value:Number):void
underlineTypeproperty 
underlineType:Object[override]

The stroke type of the underline stroke. Can return: StrokeStyle or String.


Implementation
    public function get underlineType():Object
    public function set underlineType(value:Object):void
underlineWeightproperty 
underlineWeight:Object[override]

The stroke weight of the underline stroke.


Implementation
    public function get underlineWeight():Object
    public function set underlineWeight(value:Object):void
verticalScaleproperty 
verticalScale:Number[override]

The vertical scaling applied to the TextStyleRange.


Implementation
    public function get verticalScale():Number
    public function set verticalScale(value:Number):void
warichuproperty 
warichu:Boolean[override]

If true, turns on warichu.


Implementation
    public function get warichu():Boolean
    public function set warichu(value:Boolean):void
warichuAlignmentproperty 
warichuAlignment:WarichuAlignment[override]

The warichu alignment.


Implementation
    public function get warichuAlignment():WarichuAlignment
    public function set warichuAlignment(value:WarichuAlignment):void
warichuCharsAfterBreakproperty 
warichuCharsAfterBreak:Number[override]

The minimum number of characters allowed after a line break.


Implementation
    public function get warichuCharsAfterBreak():Number
    public function set warichuCharsAfterBreak(value:Number):void
warichuCharsBeforeBreakproperty 
warichuCharsBeforeBreak:Number[override]

The minimum number of characters allowed before a line break.


Implementation
    public function get warichuCharsBeforeBreak():Number
    public function set warichuCharsBeforeBreak(value:Number):void
warichuLinesproperty 
warichuLines:Number[override]

The number of lines of warichu within a single normal line.


Implementation
    public function get warichuLines():Number
    public function set warichuLines(value:Number):void
warichuLineSpacingproperty 
warichuLineSpacing:Number[override]

The gap between lines of warichu characters.


Implementation
    public function get warichuLineSpacing():Number
    public function set warichuLineSpacing(value:Number):void
warichuSizeproperty 
warichuSize:Number[override]

The amount (as a percentage) to scale parent text size to determine warichu size.


Implementation
    public function get warichuSize():Number
    public function set warichuSize(value:Number):void
wordsproperty 
words:Words  [read-only] [override]

A collection of words.


Implementation
    public function get words():Words
xOffsetDiacriticproperty 
xOffsetDiacritic:Number[override]

The x (horizontal) offset for diacritic adjustment.


Implementation
    public function get xOffsetDiacritic():Number
    public function set xOffsetDiacritic(value:Number):void
yOffsetDiacriticproperty 
yOffsetDiacritic:Number[override]

The y (vertical) offset for diacritic adjustment.


Implementation
    public function get yOffsetDiacritic():Number
    public function set yOffsetDiacritic(value:Number):void
Method Detail
addEventListenerTextStyleRange()method
public function addEventListenerTextStyleRange(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

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)

Returns
EventListener
applyCharacterStyle()method 
override public function applyCharacterStyle(usingParam:CharacterStyle = null):void

Apply a character style.

Parameters

usingParam:CharacterStyle (default = null) — (CharacterStyle) The character style to apply.

applyConditions()method 
override public function applyConditions(usingParam:Array = null, removeExistingParam:Boolean = false):void

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 
override public function applyParagraphStyle(usingParam:ParagraphStyle = null, clearingOverridesParam:Boolean = true):void

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)

asynchronousExportFile()method 
override public function asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask

asynchronously 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)
 
usingParam:PDFExportPreset (default = null) — (PDFExportPreset) The export style. (Optional)
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

Returns
BackgroundTask
autoTag()method 
override public function autoTag():void

Tag the object or the parent story using default tags defined in XML preference.

changecase()method 
override public function changecase(usingParam:ChangecaseMode = null):void

Sets the case of the text.

Parameters

usingParam:ChangecaseMode (default = null) — (ChangecaseMode) The text case option.

changeGlyph()method 
override public function changeGlyph(reverseOrderParam:Boolean):Object

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)

Returns
Object
changeGrep()method 
override public function changeGrep(reverseOrderParam:Boolean):Object

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)

Returns
Object
changeText()method 
override public function changeText(reverseOrderParam:Boolean):Object

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)

Returns
Object
changeTransliterate()method 
override public function changeTransliterate(reverseOrderParam:Boolean):Object

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)

Returns
Object
clearOverrides()method 
override public function clearOverrides(overridesToClearParam:OverrideType = null):void

Clears the specified types of override.

Parameters

overridesToClearParam:OverrideType (default = null) — (OverrideType) The types of override to clear. (Optional)

convertBulletsAndNumberingToText()method 
override public function convertBulletsAndNumberingToText():void

Convert bullets and numbering to text.

convertToNote()method 
override public function convertToNote():Note

Converts the text to a note.

Returns
Note
convertToTable()method 
override public function convertToTable(columnSeparatorParam:String = null, rowSeparatorParam:String = null, numberOfColumnsParam:Number = 1):Table

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)

Returns
Table
createOutlines()method 
override public function createOutlines(deleteOriginalParam:Boolean = true):Object

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

Parameters

deleteOriginalParam:Boolean (default = true) — (Boolean) If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)

Returns
Object
duplicate()method 
override public function duplicate(toParam:LocationOptions = null, referenceParam:Object = null):Text

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)

Returns
Text
exportFile()method 
override public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

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)
 
usingParam:PDFExportPreset (default = null) — (PDFExportPreset) The export style. (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 
override public function findGlyph(reverseOrderParam:Boolean):Object

Finds glyphs that match the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findGrep()method 
override public function findGrep(reverseOrderParam:Boolean):Object

Finds text that matches the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findHyperlinks()method 
override public function findHyperlinks(sortOrderParam:RangeSortOrder = null):Object

Finds hyperlink sources that intersecting with specified text range.

Parameters

sortOrderParam:RangeSortOrder (default = null) — (RangeSortOrder) The sort order of found ranges. (Optional)

Returns
Object
findText()method 
override public function findText(reverseOrderParam:Boolean):Object

Finds text that matches the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findTransliterate()method 
override public function findTransliterate(reverseOrderParam:Boolean):Object

Finds text that matches the find character type value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
getElements()method 
override public function getElements():Object

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

Returns
Object
markup()method 
override public function markup(usingParam:XMLElement = null):void

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

Parameters

usingParam:XMLElement (default = null) — (XMLElement) The XML element.

move()method 
override public function move(toParam:LocationOptions = null, referenceParam:Object = null):Text

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)

Returns
Text
place()method 
override public function place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object

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)

Returns
Object
recompose()method 
override public function recompose():void

Recomposes the text in the TextStyleRange.

remove()method 
override public function remove():void

Deletes the TextStyleRange.

removeEventListenerTextStyleRange()method 
public function removeEventListenerTextStyleRange(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

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)

Returns
Boolean
select()method 
override public function select(existingSelectionParam:SelectionOptions = null):void

Selects the object.

Parameters

existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the TextStyleRange in relation to previously selected objects. (Optional)

showText()method 
override public function showText():void

Jump to the text range.

toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String