A character in a story.
|
Property
|
Type
|
Access
|
Description
|
|
AlignToBaseline
|
Boolean
|
r/w
|
If true, align the baseline to the baseline grid.
|
|
AllGraphics
|
Array of Graphics
|
read
|
All graphics contained by the object.
|
|
AllPageItems
|
Array of PageItems
|
read
|
All page items contained by the object.
|
|
AppliedCharacterStyle
|
CharacterStyle, String
|
r/w
|
The character style applied to the object.
|
|
AppliedFont
|
Font, String
|
r/w
|
The applied font. Either a font object or the name of font family.
|
|
AppliedLanguage
|
LanguageWithVendors, Language, String
|
r/w
|
The language dictionary appled to the object.
|
|
AppliedParagraphStyle
|
ParagraphStyle, String
|
r/w
|
The applied paragraph style.
|
|
Ascent
|
Unit (Double or String)
|
read
|
The maximum ascent of any character in the object.
|
|
AssociatedXMLElements
|
Array of XMLItems
|
read
|
The XML elements associated with the object.
|
|
AutoLeading
|
Double
|
r/w
|
Percentage used for calculating auto leading.
|
|
BalanceRaggedLines
|
Boolean, idBalanceLinesStyle enumeration
|
r/w
|
If true, or set to one of the enumerations, apply ragged line balancing to the paragraph containing the object.
|
|
Baseline
|
Unit (Double or String)
|
read
|
The vertical position of the baseline on the page, relative to the ruler zero point.
|
|
BaselineShift
|
Unit (Double or String)
|
r/w
|
The amount of baseline shift applied to the object.
|
|
BulletChar
|
Bullet
|
read
|
The bullet character used when a bullet is applied to the paragraph containing the object.
|
|
BulletsAndNumberingColor
|
idAutoEnum enumeration, Swatch, String
|
r/w
|
The color of the bullet or numbering.
|
|
BulletsAndNumberingListType
|
idListType enumeration
|
r/w
|
The list type to use for bullets and numbering.
|
|
BulletsAndNumberingSize
|
idAutoEnum enumeration, Double
|
r/w
|
The point size of the bullet or numbering.
|
|
Buttons
|
Buttons
|
read
|
The buttons contained by the object.
|
|
Capitalization
|
idCapitalization enumeration
|
r/w
|
The capitalization applied to the object.
|
|
Characters
|
Characters
|
read
|
The characters of the object.
|
|
Composer
|
String
|
r/w
|
The applied text composer.
|
|
Contents
|
String, idSpecialCharacters enumeration (see table at end of chapter)
|
r/w
|
The text contents.
|
|
Descent
|
Unit (Double or String)
|
read
|
The maximum descent of any character in the object.
|
|
DesiredGlyphScaling
|
Double
|
r/w
|
The desired percentage of glyph scaling.
|
|
DesiredLetterSpacing
|
Double
|
r/w
|
The desired percentage of letter spacing.
|
|
DesiredWordSpacing
|
Double
|
r/w
|
The desired percentage of word spacing.
|
|
DropCapCharacters
|
Integer
|
r/w
|
The number of characters for a drop cap.
|
|
DropCapLines
|
Integer
|
r/w
|
The number of lines for drop cap.
|
|
DropCapStyle
|
CharacterStyle, String
|
r/w
|
The character style for a drop cap.
|
|
FillColor
|
Swatch, String
|
r/w
|
The fill of the object.
|
|
FillTint
|
Double
|
r/w
|
The tint percentage applied to the fill of the object (-1 indicates 100%).
|
|
FirstLineIndent
|
Unit (Double or String)
|
r/w
|
The first line indent.
|
|
FontStyle
|
String
|
r/w
|
The name of the applied font style.
|
|
Footnotes
|
Footnotes
|
read
|
The footnotes contained by the object.
|
|
FormFields
|
FormFields
|
read
|
The form fields contained by the object.
|
|
GradientFillAngle
|
Double
|
r/w
|
The angle of the gradient applied to the fill of the object.
|
|
GradientFillLength
|
Double
|
r/w
|
Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the fill of the object.
|
|
GradientFillStart
|
Array of 2 Units (Doubles or Strings)
|
r/w
|
Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the fill of the object.
|
|
GradientStrokeAngle
|
Double
|
r/w
|
The angle of the gradient applied to the stroke of the object.
|
|
GradientStrokeLength
|
Double
|
r/w
|
Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the stroke of the object.
|
|
GradientStrokeStart
|
Array of 2 Units (Doubles or Strings)
|
r/w
|
Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the stroke of the object.
|
|
GraphicLines
|
GraphicLines
|
read
|
The graphic lines contained by the object.
|
|
GridAlignFirstLineOnly
|
Boolean
|
r/w
|
If true, only the first line of the object will be aligned to the frame grid or baseline grid.
|
|
Groups
|
Groups
|
read
|
The groups contained by the object.
|
|
HorizontalOffset
|
Unit (Double or String)
|
read
|
The horizontal position of the baseline on the page, relative to the ruler zero point.
|
|
HorizontalScale
|
Double
|
r/w
|
The horizontal scaling percentage applied to the object, including the scaling applied to its containing object(s).
|
|
HyphenateAfterFirst
|
Integer
|
r/w
|
Hyphenate after this many letters.
|
|
HyphenateBeforeLast
|
Integer
|
r/w
|
Hyphenate before this many letters.
|
|
HyphenateCapitalizedWords
|
Boolean
|
r/w
|
If true, hyphenate capitalized words.
|
|
HyphenateLadderLimit
|
Integer
|
r/w
|
The number of consecutive hyphens allowed.
|
|
HyphenateLastWord
|
Boolean
|
r/w
|
If true, allow hyphenation for the last word of the paragraph.
|
|
HyphenateWordsLongerThan
|
Integer
|
r/w
|
Disallow hyphenation for words shorter than this length (in characters).
|
|
Hyphenation
|
Boolean
|
r/w
|
If true, hyphenation is on.
|
|
HyphenationZone
|
Unit (Double or String)
|
r/w
|
The width of the hyphenation zone.
|
|
HyphenWeight
|
Integer
|
r/w
|
An value (from 1 to 11) that denotes the relative desirability of hyphenation in composing the text. Lower values result in greater use of hyphenation; higher values result in greater variation of spacing between lines of text.
|
|
Index
|
Long
|
read
|
Index of the object within its parent object.
|
|
InsertionPoints
|
InsertionPoints
|
read
|
The insertion points in the object.
|
|
Justification
|
idJustification enumeration
|
r/w
|
The alignment applied to the paragraph.
|
|
KeepAllLinesTogether
|
Boolean
|
r/w
|
If true, to keep all lines of the paragraph together.
|
|
KeepFirstLines
|
Integer
|
r/w
|
If the paragraph has to break across text columns or text frames, do not leave fewer than this number of lines at the beginning of the paragraph.
|
|
KeepLastLines
|
Integer
|
r/w
|
If the paragraph has to break across text columns or text frames, do not leave fewer than this number of lines at the end of the paragraph.
|
|
KeepLinesTogether
|
Boolean
|
r/w
|
If true, use the settings for KeepAllLinesTogether, KeepFirstLines, and KeepLastLines.
|
|
KeepWithNext
|
Integer
|
r/w
|
If this value is set to zero, allow a page break, column break, or frame break between this paragraph and the following paragraph. If the paragraph following this paragraph has to break across text columns or text frames, keep this paragraph with at least this number of lines of the following paragraph.
|
|
KerningMethod
|
String
|
r/w
|
The type of kerning (Optical, Metrics or None).
|
|
KerningValue
|
Double
|
r/w
|
The amount of kerning.
|
|
LastLineIndent
|
Unit (Double or String)
|
r/w
|
The last line indent.
|
|
Leading
|
Unit (Double or String), idLeading enumeration
|
r/w
|
The applied leading.
|
|
LeftIndent
|
Unit (Double or String)
|
r/w
|
The left indent.
|
|
Length
|
Long
|
read
|
The number of characters in the object.
|
|
Ligatures
|
Boolean
|
r/w
|
If true, use automatic ligature replacement characters.
|
|
Lines
|
Lines
|
read
|
The lines of text in the object.
|
|
MaximumGlyphScaling
|
Double
|
r/w
|
The maximum percentage of glyph scaling.
|
|
MaximumLetterSpacing
|
Double
|
r/w
|
The maximum percentage of letter spacing.
|
|
MaximumWordSpacing
|
Double
|
r/w
|
The maximum percentage of word spacing.
|
|
MinimumGlyphScaling
|
Double
|
r/w
|
The minimum percentage of glyph scaling.
|
|
MinimumLetterSpacing
|
Double
|
r/w
|
The minimum percentage of letter spacing.
|
|
MinimumWordSpacing
|
Double
|
r/w
|
The minimum percentage of word spacing.
|
|
NestedStyles
|
NestedStyles
|
read
|
The nested styles applied to the object.
|
|
NoBreak
|
Boolean
|
r/w
|
If true, do not break the text across lines.
|
|
Notes
|
Notes
|
read
|
Every note.
|
|
NumberingFont
|
Font, String, idAutoEnum enumeration
|
r/w
|
The font applied to numbering.
|
|
NumberingFontStyle
|
String, idNothingEnum enumeration, idAutoEnum enumeration
|
r/w
|
The font style applied to numbering.
|
|
NumberingStyle
|
idNumberingStyle enumeration, String
|
r/w
|
The numbering style.
|
|
NumberSeparator
|
Integer
|
r/w
|
The numbering separator character.
|
|
NumberStartAt
|
Long
|
r/w
|
The starting number for a numbered list.
|
|
OpenTypeFeatures
|
Array of 2 Strings or Longs
|
r/w
|
OpenType features available in the applied font.
|
|
OTFContextualAlternate
|
Boolean
|
r/w
|
If true, use contextual alternate forms in OpenType fonts.
|
|
OTFDiscretionaryLigature
|
Boolean
|
r/w
|
If true, use discretionary ligatures in OpenType fonts.
|
|
OTFFigureStyle
|
idOTFFigureStyle enumeration
|
r/w
|
The figure style to use in OpenType fonts.
|
|
OTFFraction
|
Boolean
|
r/w
|
If true, use fractions in OpenType fonts.
|
|
OTFHistorical
|
Boolean
|
r/w
|
If true, use historical forms in OpenType fonts.
|
|
OTFOrdinal
|
Boolean
|
r/w
|
If true, use ordinals in OpenType fonts.
|
|
OTFSlashedZero
|
Boolean
|
r/w
|
If true, use a zero with slash in OpenType fonts.
|
|
OTFStylisticSets
|
Long
|
r/w
|
Stylistic sets to use in OpenType fonts.
|
|
OTFSwash
|
Boolean
|
r/w
|
If true, use swash forms in OpenType fonts.
|
|
OTFTitling
|
Boolean
|
r/w
|
If true, use titling forms in OpenType fonts.
|
|
Ovals
|
Ovals
|
read
|
All ovals contained by the object.
|
|
OverprintFill
|
Boolean
|
r/w
|
If true, the fill of the object will overprint.
|
|
OverprintStroke
|
Boolean
|
r/w
|
If true, the storke of the object will overprint.
|
|
PageItems
|
PageItems
|
read
|
The page items contained by the object.
|
|
Paragraphs
|
Paragraphs
|
read
|
The paragraphs contained by the object.
|
|
Parent
|
Object
|
read
|
The parent of the object.
|
|
ParentStory
|
Story
|
read
|
The story containing the object.
|
|
ParentTextFrames
|
Variant
|
read
|
The text frame(s) containing the object.
|
|
PointSize
|
Unit (Double or String)
|
r/w
|
The point size of the text.
|
|
Polygons
|
Polygons
|
read
|
The polygons contained by the object.
|
|
Position
|
idPosition enumeration
|
r/w
|
The position (e.g., superscript or subscript) of the object.
|
|
Rectangles
|
Rectangles
|
read
|
The rectangles contained by the object.
|
|
RightIndent
|
Unit (Double or String)
|
r/w
|
The right indent.
|
|
RuleAbove
|
Boolean
|
r/w
|
If true, apply a paragraph rule above.
|
|
RuleAboveColor
|
Swatch, String
|
r/w
|
The color of the paragraph rule above.
|
|
RuleAboveGapColor
|
Swatch, String
|
r/w
|
The color applied to the gap of the rule above.
|
|
RuleAboveGapOverprint
|
Boolean
|
r/w
|
If true, overprint the rule above gap color.
|
|
RuleAboveGapTint
|
Double
|
r/w
|
The tint applied to the rule above gap color (-1 represents 100%).
|
|
RuleAboveLeftIndent
|
Unit (Double or String)
|
r/w
|
The left indent of the rule above.
|
|
RuleAboveLineWeight
|
Double
|
r/w
|
The stroke weight of the rule above.
|
|
RuleAboveOffset
|
Unit (Double or String)
|
r/w
|
The offset of the rule above from the baseline of the first line in the paragraph.
|
|
RuleAboveOverprint
|
Boolean
|
r/w
|
If true, overprint the rule above.
|
|
RuleAboveRightIndent
|
Unit (Double or String)
|
r/w
|
The right indent of the rule above.
|
|
RuleAboveTint
|
Double
|
r/w
|
The tint applied to the the rule above (-1 represents 100%).
|
|
RuleAboveType
|
StrokeStyle, String
|
r/w
|
The stroke style applied to the rule above.
|
|
RuleAboveWidth
|
idRuleWidth enumeration
|
r/w
|
When this value is set to column width, the width of the rule above is based on the width of the column; when this value is set to text width, the width of the rule above is based on the width of the first line of text in the paragraph.
|
|
RuleBelow
|
Boolean
|
r/w
|
If true, apply a paragraph rule below.
|
|
RuleBelowColor
|
Swatch, String
|
r/w
|
The color of the paragraph below above.
|
|
RuleBelowGapColor
|
Swatch, String
|
r/w
|
The color applied to the gap of the rule below.
|
|
RuleBelowGapOverPrint
|
Boolean
|
r/w
|
If true, overprint the rule below gap color.
|
|
RuleBelowGapTint
|
Double
|
r/w
|
The tint applied to the rule below gap color (-1 represents 100%).
|
|
RuleBelowLeftIndent
|
Unit (Double or String)
|
r/w
|
The left indent of the rule below.
|
|
RuleBelowLineWeight
|
Double
|
r/w
|
The stroke weight of the rule below.
|
|
RuleBelowOffset
|
Unit (Double or String)
|
r/w
|
The offset of the rule below from the baseline of the last line in the paragraph.
|
|
RuleBelowOverPrint
|
Boolean
|
r/w
|
If true, overprint the rule below.
|
|
RuleBelowRightIndent
|
Unit (Double or String)
|
r/w
|
The right indent of the rule below.
|
|
RuleBelowTint
|
Double
|
r/w
|
The tint applied to the the rule below (-1 represents 100%).
|
|
RuleBelowType
|
StrokeStyle, String
|
r/w
|
The stroke style applied to the rule below.
|
|
RuleBelowWidth
|
idRuleWidth enumeration
|
r/w
|
When this value is set to column width, the width of the rule above is based on the width of the column; when this value is set to text width, the width of the rule above is based on the width of the first line of text in the paragraph.
|
|
SingleWordJustification
|
idSingleWordJustification enumeration
|
r/w
|
Alignment applied to lines containing a single word.
|
|
Skew
|
Double
|
r/w
|
The angle of the skew for the text.
|
|
SpaceAfter
|
Unit (Double or String)
|
r/w
|
Paragraph space after.
|
|
SpaceBefore
|
Unit (Double or String)
|
r/w
|
Paragraph space before.
|
|
StartParagraph
|
idStartParagraph enumeration
|
r/w
|
When this property is set to anything other than start anywhere, apply a column or page break before the paragraph.
|
|
StrikeThroughColor
|
Swatch, String
|
r/w
|
The color of the strikethrough.
|
|
StrikeThroughGapColor
|
Swatch, String
|
r/w
|
The gap color of the strikethrough.
|
|
StrikeThroughGapOverprint
|
Boolean
|
r/w
|
If true, overprint the gap of the strikethrough.
|
|
StrikeThroughGapTint
|
Double
|
r/w
|
The tint percentage applied to the gap of the strikethrough (-1 represents 100%).
|
|
StrikeThroughOffset
|
Unit (Double or String)
|
r/w
|
The offset of the strikethrough from the baseline.
|
|
StrikeThroughOverprint
|
Boolean
|
r/w
|
If true, overprint the strikethrough.
|