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