Adobe InDesign CS3 (5.0) Object Model JS: Story

InDesign CS3

previous page next page

Class

Story

A story.

Superclass of XmlStory

QuickLinks

applyTextShapingPreset, autoTag, changeGlyph, changeGrep, changeText, changecase, checkIn, checkOut, clearOverrides, convertBulletsAndNumberingToText, createOutlines, duplicate, exportFile, extractLabel, findGlyph, findGrep, findText, getElements, insertLabel, markup, move, placeXML, recompose, remove, revert, storyEdit, tasmeemGetACEAttributes, tasmeemSetVariations, toSource, toSpecifier

Hierarchy

Document | XMLElement

Story

XmlStory

Properties

Property	Type	Access	Description
alignToBaseline	bool	r/w	If true, aligns the baseline of the text to the baseline grid.
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Story.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Story.
appliedCharacterStyle	CharacterStyleString	r/w	The character style applied to the text. Can also accept: String.
appliedFont	Font String	r/w	The font applied to the text, specified as either a font object or the name of font family. Can return: Font or String.
appliedLanguage	Language LanguageWithVendors String	r/w	The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String.
appliedNestedStyle	CharacterStyle String	readonly	The applied character style dictated by nested styles. Can also accept: String.
appliedNumberingList	NumberingList String	r/w	The list to be part of. Can return: NumberingList or String.
appliedParagraphStyle	ParagraphStyle String	r/w	The paragraph style applied to the text. Can also accept: String.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Story.
autoLeading	number	r/w	The percent of the type size to use for auto leading. (Range: 0 to 500).
balanceRaggedLines	BalanceLinesStyle Boolean	r/w	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.
baselineShift	Measurement Unit (Number or String)	r/w	The baseline shift applied to the text.
bulletChar	Bullet	readonly	Bullet character.
bulletsAlignment	ListAlignment: ListAlignment.LEFT_ALIGN ListAlignment.CENTER_ALIGN ListAlignment.RIGHT_ALIGN	r/w	The alignment of the bullet character.
bulletsAndNumberingListType	ListType: ListType.NO_LIST ListType.BULLET_LIST ListType.NUMBERED_LIST	r/w	List type for bullets and numbering.
bulletsCharacterStyle	CharacterStyle String	r/w	The character style to be used for the text after string. Can return: CharacterStyle or String.
bulletsTextAfter	string	r/w	The text after string expression for bullets.
buttons	Buttons	readonly	A collection of buttons.
capitalization	Capitalization: Capitalization.NORMAL Capitalization.SMALL_CAPS Capitalization.ALL_CAPS Capitalization.CAP_TO_SMALL_CAP	r/w	The capitalization scheme.
changes	Changes	readonly	A collection of changes.
characterDirection	CharacterDirectionOptions: CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION	r/w	The direction of the character.
characters	Characters	readonly	A collection of characters.
composer	string	r/w	The text composer to use to compose the text.
contents	SpecialCharacters String	r/w	The contents of the text. Can return: String or SpecialCharacters enumerator.
desiredGlyphScaling	number	r/w	The desired width (as a percentage) of individual characters. (Range: 50 to 200)
desiredLetterSpacing	number	r/w	The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500)
desiredWordSpacing	number	r/w	The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)
diacriticPosition	DiacriticPositionOptions: DiacriticPositionOptions.DEFAULT_POSITION DiacriticPositionOptions.LOOSE_POSITION DiacriticPositionOptions.MEDIUM_POSITION DiacriticPositionOptions.TIGHT_POSITION DiacriticPositionOptions.OPENTYPE_POSITION	r/w	Position of diacriticical characters.
digitsType	DigitsTypeOptions: DigitsTypeOptions.DEFAULT_DIGITS DigitsTypeOptions.ARABIC_DIGITS DigitsTypeOptions.HINDI_DIGITS DigitsTypeOptions.FARSI_DIGITS DigitsTypeOptions.NATIVE_DIGITS DigitsTypeOptions.FULL_FARSI_DIGITS DigitsTypeOptions.THAI_DIGITS DigitsTypeOptions.LAO_DIGITS DigitsTypeOptions.DEVANAGARI_DIGITS DigitsTypeOptions.BENGALI_DIGITS DigitsTypeOptions.GURMUKHI_DIGITS DigitsTypeOptions.GUJARATI_DIGITS DigitsTypeOptions.ORIYA_DIGITS DigitsTypeOptions.TAMIL_DIGITS DigitsTypeOptions.TELUGU_DIGITS DigitsTypeOptions.KANNADA_DIGITS DigitsTypeOptions.MALAYALAM_DIGITS DigitsTypeOptions.TIBETAN_DIGITS DigitsTypeOptions.KHMER_DIGITS DigitsTypeOptions.BURMESE_DIGITS	r/w	The digits type.
dropCapCharacters	number (range: 0 - 150)	r/w	The number of characters to drop cap.
dropCapLines	number (range: 0 - 25)	r/w	The number of lines to drop cap.
dropCapStyle	CharacterStyle String	r/w	The character style to apply to the drop cap. Can also accept: String.
dropcapDetail	number	r/w	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.
fillColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can also accept: String.
fillTint	number	r/w	The tint (as a percentage) of the fill color of the text. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
firstLineIndent	Measurement Unit (Number or String)	r/w	The amount to indent the first line.
fontStyle	string	r/w	The name of the font style.
footnotes	Footnotes	readonly	A collection of footnotes.
formFields	FormFields	readonly	A collection of form fields.
gradientFillAngle	number	r/w	The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)
gradientFillLength	number	r/w	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.
gradientFillStart	Array of Measurement Unit (Number or String)	r/w	The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y].
gradientStrokeAngle	number	r/w	The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180)
gradientStrokeLength	number	r/w	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text.
gradientStrokeStart	Array of Measurement Unit (Number or String)	r/w	The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y].
graphicLines	GraphicLines	readonly	A collection of graphic lines.
gridAlignFirstLineOnly	bool	r/w	If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid.
groups	Groups	readonly	A collection of groups.
horizontalScale	number	r/w	The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
hyphenWeight	number (range: 0 - 10)	r/w	The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100)
hyphenateAcrossColumns	bool	r/w	If true, allows the last word in a text column to be hyphenated.
hyphenateAfterFirst	number (range: 1 - 15)	r/w	The mininum number of letters at the beginning of a word that can be broken by a hyphen.
hyphenateBeforeLast	number (range: 1 - 15)	r/w	The minimum number of letters at the end of a word that can be broken by a hyphen.
hyphenateCapitalizedWords	bool	r/w	If true, allows hyphenation of capitalized words.
hyphenateLadderLimit	number (range: 0 - 25)	r/w	The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero.
hyphenateLastWord	bool	r/w	If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.
hyphenateWordsLongerThan	number (range: 3 - 25)	r/w	The minimum number of letters a word must have in order to qualify for hyphenation.
hyphenation	bool	r/w	If true, allows hyphenation.
hyphenationZone	Measurement Unit (Number or String)	r/w	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.
id	number	readonly	The unique ID of the Story.
ignoreEdgeAlignment	bool	r/w	If true, ignores optical edge alignment for the paragraph.
incopyExportOptions	InCopyExportOption	readonly	Export options for InCopy INCX document format.
index	number	readonly	The index of the Story within its containing object.
insertionPoints	InsertionPoints	readonly	A collection of insertion points.
itemLink	Link	readonly	The source file of the link.
justification	Justification: Justification.LEFT_ALIGN Justification.CENTER_ALIGN Justification.RIGHT_ALIGN Justification.LEFT_JUSTIFIED Justification.RIGHT_JUSTIFIED Justification.CENTER_JUSTIFIED Justification.FULLY_JUSTIFIED Justification.TO_BINDING_SIDE Justification.AWAY_FROM_BINDING_SIDE	r/w	The paragraph alignment.
kashidas	KashidasOptions: KashidasOptions.DEFAULT_KASHIDAS KashidasOptions.KASHIDAS_OFF	r/w	Use of Kashidas for justification
keepAllLinesTogether	bool	r/w	If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.
keepFirstLines	number (range: 1 - 50)	r/w	The minimum number of lines to keep together in a paragraph before allowing a page break.
keepLastLines	number (range: 1 - 50)	r/w	The minimum number of lines to keep together in a paragraph after a page break.
keepLinesTogether	bool	r/w	If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.
keepRuleAboveInFrame	bool	r/w	If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true.
keepWithNext	number (range: 0 - 5)	r/w	The minimum number of lines to keep with the next paragraph.
kerningMethod	string	r/w	The type of pair kerning.
keyboardDirection	CharacterDirectionOptions: CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION	r/w	The keyboard direction of the character.
label	string	r/w	A property that can be set to any string.
lastLineIndent	Measurement Unit (Number or String)	r/w	The amount to indent the last line in the paragraph.
leading	Leading Unit	r/w	The leading applied to the text. Can return: Unit or Leading enumerator.
leftIndent	Measurement Unit (Number or String)	r/w	The width of the left indent.
length	number	readonly	The number of objects in the collection.
ligatures	bool	r/w	If true, replaces specific character combinations (e.g., fl, fi) with ligature characters.
lines	Lines	readonly	A collection of lines.
lockState	LockStateValues: LockStateValues.NONE LockStateValues.UNMANAGED_STORY LockStateValues.CHECKED_IN_STORY LockStateValues.CHECKED_OUT_STORY LockStateValues.LOCKED_STORY LockStateValues.EMBEDDED_STORY LockStateValues.MISSING_LOCK_STATE LockStateValues.MIXED_LOCK_STATE	readonly	The lock state.
maximumGlyphScaling	number	r/w	The maximum width (as a percentage) of individual characters. (Range: 50 to 200)
maximumLetterSpacing	number	r/w	The maximum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified.
maximumWordSpacing	number	r/w	The maximum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)
minimumGlyphScaling	number	r/w	The minimum width (as a percentage) of individual characters. (Range: 50 to 200)
minimumLetterSpacing	number	r/w	The minimum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified.
minimumWordSpacing	number	r/w	The minimum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)
nestedStyles	NestedStyles	readonly	A collection of nested styles.
noBreak	bool	r/w	If true, keeps the text on the same line.
notes	Notes	readonly	A collection of notes.
numberingAlignment	ListAlignment: ListAlignment.LEFT_ALIGN ListAlignment.CENTER_ALIGN ListAlignment.RIGHT_ALIGN	r/w	The alignment of the number.
numberingApplyRestartPolicy	bool	r/w	If true, apply the numbering restart policy.
numberingCharacterStyle	CharacterStyle String	r/w	The character style to be used for the number string. Can return: CharacterStyle or String.
numberingContinue	bool	r/w	Continue the numbering at this level.
numberingExpression	string	r/w	The number string expression for numbering.
numberingFormat	NumberingStyle String	r/w	Numbering format options. Can return: NumberingStyle enumerator or String.
numberingLevel	number	r/w	The level of the paragraph.
numberingRestartPolicies	NumberingRestartPolicy	readonly	Numbering restart policies.
numberingStartAt	number	r/w	Determines starting number in a numbered list.
opentypeFeatures	Array of Array of 2 Strings Long Integers	r/w	OpenType features. Can return: Array of Array of 2 Strings or Long Integers.
otfContextualAlternate	bool	r/w	If true, uses contextual alternate forms in OpenType fonts.
otfDiscretionaryLigature	bool	r/w	If true, uses discretionary ligatures in OpenType fonts.
otfFigureStyle	OTFFigureStyle: OTFFigureStyle.TABULAR_LINING OTFFigureStyle.PROPORTIONAL_OLDSTYLE OTFFigureStyle.PROPORTIONAL_LINING OTFFigureStyle.TABULAR_OLDSTYLE OTFFigureStyle.DEFAULT_VALUE	r/w	The figure style in OpenType fonts.
otfFraction	bool	r/w	If true, uses fractions in OpenType fonts.
otfHistorical	bool	r/w	If true, use historical forms in OpenType fonts.
otfJustificationAlternate	bool	r/w	If true, use alternate justification forms in OpenType fonts
otfLocale	bool	r/w	If true, uses localized forms in OpenType fonts.
otfMark	bool	r/w	If true, uses mark positioning in OpenType fonts.
otfOrdinal	bool	r/w	If true, uses ordinals in OpenType fonts.
otfOverlapSwash	bool	r/w	If true, use overlapping swash forms in OpenType fonts
otfSlashedZero	bool	r/w	If true, use a slashed zeroes in OpenType fonts.
otfStretchedAlternate	bool	r/w	If true, use stretched alternate forms in OpenType fonts
otfStylisticAlternate	bool	r/w	If true, use stylistic alternate forms in OpenType fonts
otfStylisticSets	number	r/w	The stylistic sets to use in OpenType fonts.
otfSwash	bool	r/w	If true, uses swash forms in OpenType fonts.
otfTitling	bool	r/w	If true, uses titling forms in OpenType fonts.
ovals	Ovals	readonly	A collection of ellipses.
overflows	bool	readonly	If true, the story has overset text.
overprintFill	bool	r/w	If true, the fill color of the characters will overprint.
overprintStroke	bool	r/w	If true, the stroke of the characters will overprint.
pageItems	PageItems	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
paragraphDirection	ParagraphDirectionOptions: ParagraphDirectionOptions.LEFT_TO_RIGHT_DIRECTION ParagraphDirectionOptions.RIGHT_TO_LEFT_DIRECTION	r/w	Paragraph direction.
paragraphJustification	ParagraphJustificationOptions: ParagraphJustificationOptions.DEFAULT_JUSTIFICATION ParagraphJustificationOptions.ARABIC_JUSTIFICATION ParagraphJustificationOptions.NASKH_JUSTIFICATION	r/w	Paragraph justification.
paragraphs	Paragraphs	readonly	A collection of paragraphs.
parent	Document XMLElement	readonly	The parent of the Story (a XMLElement or Document).
pointSize	Measurement Unit (Number or String)	r/w	The text size.
polygons	Polygons	readonly	A collection of polygons.
position	Position: Position.NORMAL Position.SUPERSCRIPT Position.SUBSCRIPT Position.OT_SUPERSCRIPT Position.OT_SUBSCRIPT Position.OT_NUMERATOR Position.OT_DENOMINATOR	r/w	The text position relative to the baseline.
positionalForm	PositionalForms: PositionalForms.NONE PositionalForms.CALCULATE PositionalForms.INITIAL PositionalForms.MEDIAL PositionalForms.FINAL PositionalForms.ISOLATED	r/w	The OpenType positional form.
properties	Object	r/w	A property that allows setting of several properties at the same time.
rectangles	Rectangles	readonly	A collection of rectangles.
rightIndent	Measurement Unit (Number or String)	r/w	The width of the right indent.
ruleAbove	bool	r/w	If true, places a rule above the paragraph.
ruleAboveColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.
ruleAboveGapColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule above. Note: Valid only when the paragraph rule above type is not solid. Can return: Swatch or String.
ruleAboveGapOverprint	bool	r/w	If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid.
ruleAboveGapTint	number	r/w	The tint (as a percentage) of the stroke gap color of the paragraph rule. (Range: 0 to 100) Note: Valid only when the rule above type is not solid.
ruleAboveLeftIndent	Measurement Unit (Number or String)	r/w	The distance to indent the left edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph.
ruleAboveLineWeight	Measurement Unit (Number or String)	r/w	The line weight of the rule above.
ruleAboveOffset	Measurement Unit (Number or String)	r/w	The amount to offset the paragraph rule above from the baseline of the first line the paragraph.
ruleAboveOverprint	bool	r/w	If true, the paragraph rule above will overprint.
ruleAboveRightIndent	Measurement Unit (Number or String)	r/w	The distance to indent the right edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph.
ruleAboveTint	number	r/w	The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)
ruleAboveType	String StrokeStyle	r/w	The stroke type of the rule above the paragraph. Can return: StrokeStyle or String.
ruleAboveWidth	RuleWidth: RuleWidth.TEXT_WIDTH RuleWidth.COLUMN_WIDTH	r/w	The basis (text width or column width) used to calculate the width of the paragraph rule above.
ruleBelow	bool	r/w	If true, applies a paragraph rule below.
ruleBelowColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.
ruleBelowGapColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule below. Note: Valid only when the paragraph rule below type is not solid. Can return: Swatch or String.
ruleBelowGapOverprint	bool	r/w	If true, the gap color of the rule below will overprint.
ruleBelowGapTint	number	r/w	The tint (as a percentage) of the stroke gap color of the paragraph rule below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type is not solid.
ruleBelowLeftIndent	Measurement Unit (Number or String)	r/w	The distance to indent the left edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph.
ruleBelowLineWeight	Measurement Unit (Number or String)	r/w	The line weight of the rule below.
ruleBelowOffset	Measurement Unit (Number or String)	r/w	The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.
ruleBelowOverprint	bool	r/w	If true, the rule below will overprint.
ruleBelowRightIndent	Measurement Unit (Number or String)	r/w	The distance to indent the right edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph.
ruleBelowTint	number	r/w	The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)
ruleBelowType	String StrokeStyle	r/w	The stroke type of the rule below the paragraph. Can return: StrokeStyle or String.
ruleBelowWidth	RuleWidth: RuleWidth.TEXT_WIDTH RuleWidth.COLUMN_WIDTH	r/w	The basis (text width or column width) used to calculate the width of the paragraph rule below.
singleWordJustification	SingleWordJustification: SingleWordJustification.LEFT_ALIGN SingleWordJustification.CENTER_ALIGN SingleWordJustification.RIGHT_ALIGN SingleWordJustification.FULLY_JUSTIFIED	r/w	The alignment to use for lines that contain a single word.
skew	number	r/w	The skew angle of the text. (Range: -85 to 85)
spaceAfter	Measurement Unit (Number or String)	r/w	The height of the paragraph space below.
spaceBefore	Measurement Unit (Number or String)	r/w	The height of the paragraph space above.
startParagraph	StartParagraph: StartParagraph.ANYWHERE StartParagraph.NEXT_COLUMN StartParagraph.NEXT_FRAME StartParagraph.NEXT_PAGE StartParagraph.NEXT_ODD_PAGE StartParagraph.NEXT_EVEN_PAGE	r/w	The location at which to start the paragraph.
storyPreferences	StoryPreference	readonly	Story preference settings.
storyTitle	string	r/w	Title for this InCopy story.
storyType	StoryTypes: StoryTypes.REGULAR_STORY StoryTypes.TOC_STORY StoryTypes.INDEXING_STORY	readonly	The type of story.
strikeThroughColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapOverprint	bool	r/w	If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.
strikeThroughGapTint	number	r/w	The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid.
strikeThroughOffset	Measurement Unit (Number or String)	r/w	The amount by which to offset the strikethrough stroke from the text baseline.
strikeThroughOverprint	bool	r/w	If true, the strikethrough stroke will overprint.
strikeThroughTint	number	r/w	The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)
strikeThroughType	String StrokeStyle	r/w	The stroke type of the strikethrough stroke. Can return: StrokeStyle or String.
strikeThroughWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the strikethrough stroke.
strikeThru	bool	r/w	If true, draws a strikethrough line through the text.
strokeColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can also accept: String.
strokeTint	number	r/w	The tint (as a percentage) of the stroke color of the text. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
strokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight applied to the characters of the text.
styleOverridden	bool	readonly	If true, the applied style has been overridden with additional attributes.
tabList	Array of Arrays of Property Name/Value Pairs	r/w	A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs.
tabStops	TabStops	readonly	A collection of tab stops.
tables	Tables	readonly	A collection of tables.
textColumns	TextColumns	readonly	A collection of text columns.
textContainers	Array of TextFrames TextPaths	readonly	Array of text frames or text paths. Can return: Array of TextFrames or TextPaths.
textFrames	TextFrames	readonly	A collection of text frames.
textStyleRanges	TextStyleRanges	readonly	A collection of text style ranges.
textVariableInstances	TextVariableInstances	readonly	A collection of text variable instances.
texts	Texts	readonly	A collection of text objects.
trackChanges	bool	r/w	If true, track changes is turned on.
tracking	number	r/w	The amount by which to loosen or tighten a block of text, specified in thousands of an em.
underline	bool	r/w	If true, underlines the text.
underlineColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.
underlineGapColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the underline stroke. Note: Valid when underline type is not solid. Can return: Swatch or String.
underlineGapOverprint	bool	r/w	If true, the gap color of the underline stroke will overprint.
underlineGapTint	number	r/w	The tint (as a percentage) of the gap color of the underline stroke. (Range: 0 to 100) Note: Valid when underline type is not solid.
underlineOffset	Measurement Unit (Number or String)	r/w	The amount by which to offset the underline from the text baseline.
underlineOverprint	bool	r/w	If true, the underline stroke color will overprint.
underlineTint	number	r/w	The underline stroke tint (as a percentage). (Range: 0 to 100)
underlineType	String StrokeStyle	r/w	The stroke type of the underline stroke. Can return: StrokeStyle or String.
underlineWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the underline stroke.
verticalScale	number	r/w	The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
words	Words	readonly	A collection of words.
xOffsetDiacritic	number	r/w	The x (horizontal) offset for diacritic adjustment.
yOffsetDiacritic	number	r/w	The y (vertical) offset for diacritic adjustment.

Methods

Instances

void applyTextShapingPreset (presetName: string)
Apply the text shaping preset

Parameter	Type	Description
presetName	string	Preset Name

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void changecase (using: ChangecaseMode)
Sets the case of the text.

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

bool checkIn ([versionComments: string][, forceSave: bool=false])
Checks in the story or stories.

Parameter	Type	Description
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

bool checkOut ()
Checks out the story.

void clearOverrides ([overridesToClear: OverrideType=OverrideType.ALL])
Clears the specified types of override.

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

void convertBulletsAndNumberingToText ()
Convert bullets and numbering to text.

Array of PageItem createOutlines ([deleteOriginal: bool=true])
Converts text to outlines. Each line of text becomes a polygon object. When the converted text is a single letter that has no internal spaces or detached parts, the polygon contains only a single path. Note: To determine whether a font allows the creation of outlines, see allow outlines.

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

Text duplicate (to: LocationOptions[, reference: any])
Duplicates the text in the specified location.

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

void exportFile (format: any, to: File[, showingOptions: bool=false][, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat String	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.
to	File	The path to the export file.
showingOptions	bool	If true, displays the export options dialog. (Optional) (default: false)
using	PDFExportPreset	The export style. (Optional)
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of Text findGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findGrep ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findText ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Story getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void markup (using: XMLElement)
Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

Text move (to: LocationOptions[, reference: any])
Moves the text to the specified location.

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

void placeXML (using: XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.

Parameter	Type	Description
using	XMLElement	The XML element whose content you want to place.

void recompose ()
Recomposes the text in the Story.

void remove ()
Deletes the Story.

bool revert ()
Reverts the document to its state at the last save operation.

StoryWindow storyEdit ()
Opens the story in a story editor window.

Array of number tasmeemGetACEAttributes (startIndex: number, span: number)
Get the ACE attributes of the text

Parameter	Type	Description
startIndex	number	start Index
span	number	span

number tasmeemSetVariations (variationsArray: Array of number, startIndex: number)
Set the variants of the text

Parameter	Type	Description
variationsArray	Array of number	Variations to apply
startIndex	number	start Index

string toSource ()
Generates a string which, if executed, will return the Story.

string toSpecifier ()
Retrieves the object specifier.

Element of

AssignedStory.storyReference

Change.parent

Character.parentStory

DataMergeTextPlaceholder.parentStory

InsertionPoint.parentStory

Line.parentStory

Link.parent

NestedStyle.parent

Paragraph.parentStory

StoryPreference.parent

TabStop.parent

Text.parentStory

TextColumn.parentStory

TextFrame.parentStory

TextPath.parentStory

TextStyleRange.parentStory

Word.parentStory

XMLElement.parentStory

XMLElement.xmlContent

Used in:

Text Character.duplicate (to: LocationOptions[, reference: any])

Text Character.move (to: LocationOptions[, reference: any])

DataMergeTextPlaceholder DataMergeTextPlaceholders.add (parentStory: Story, storyOffset: any, field: DataMergeField[, withProperties: Object])

Text InsertionPoint.duplicate (to: LocationOptions[, reference: any])

Text InsertionPoint.move (to: LocationOptions[, reference: any])

Text Line.duplicate (to: LocationOptions[, reference: any])

Text Line.move (to: LocationOptions[, reference: any])

Note Note.move (to: LocationOptions[, reference: any])

Text Paragraph.duplicate (to: LocationOptions[, reference: any])

Text Paragraph.move (to: LocationOptions[, reference: any])

array of Story Stories.itemByRange (from: any, to: any)

Story Stories.nextItem (obj: Story)

Story Stories.previousItem (obj: Story)

Text Story.duplicate (to: LocationOptions[, reference: any])

Text Story.move (to: LocationOptions[, reference: any])

Table Tables.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

Text Text.duplicate (to: LocationOptions[, reference: any])

Text Text.move (to: LocationOptions[, reference: any])

Text TextColumn.duplicate (to: LocationOptions[, reference: any])

Text TextColumn.move (to: LocationOptions[, reference: any])

Text TextStyleRange.duplicate (to: LocationOptions[, reference: any])

Text TextStyleRange.move (to: LocationOptions[, reference: any])

TextVariableInstance TextVariableInstances.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

Text Word.duplicate (to: LocationOptions[, reference: any])

Text Word.move (to: LocationOptions[, reference: any])

void XMLElement.markup (using: any)

void XMLElement.placeXML (using: any)

XMLElement XMLElements.add (markupTag: any[, xmlContent: any][, withProperties: Object])

Text XmlStory.duplicate (to: LocationOptions[, reference: any])

Return

Array of Story Document.createTOC (using: TOCStyle[, replacing: bool=false][, fromBook: Book][, placePoint: Array of Measurement Unit (Number or String)][, includeOverset: bool=false][, destinationLayer: Layer])

Array of Story Index.generate ([on: any][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, autoflowing: bool=false][, includeOverset: bool=false])

Story Stories.anyItem ()

Array of Story Stories.everyItem ()

Story Stories.firstItem ()

Story Stories.item (index: any)

Story Stories.itemByID (id: number)

Story Stories.itemByName (name: string)

Array of Story Stories.itemByRange (from: any, to: any)

Story Stories.lastItem ()

Story Stories.middleItem ()

Story Stories.nextItem (obj: Story)

Story Stories.previousItem (obj: Story)

Array of Story Story.getElements ()

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index

previous page start next page