A story.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| alignToBaseline | bool | r/w | If true, aligns the baseline of the Story 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 | CharacterStyle | r/w | The character style applied to the Story. Can also accept: String. |
| appliedFont | any | 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 | any | r/w | The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String. |
| appliedNestedStyle | CharacterStyle | readonly | The applied character style dictated by nested styles. Can also accept: String. |
| appliedNumberingList | any | r/w | The list to be part of. Can return: NumberingList or String. |
| appliedParagraphStyle | ParagraphStyle | r/w | The paragraph style applied to the Story. 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 | any | r/w | If true or set to an enumeration value, balances ragged lines in the paragraph(s) of the Story. Note: Not valid with a single-line text composer. For information, see composer. Can return: Boolean or BalanceLinesStyle enumerator. |
| baselineShift | number | r/w | The baseline shift applied to the text. |
| bulletChar | Bullet | readonly | Bullet character. |
| bulletsAlignment |
ListAlignment
: LEFT_ALIGN CENTER_ALIGN RIGHT_ALIGN |
r/w | The alignment of the bullet character. |
| bulletsAndNumberingListType |
ListType
: NO_LIST BULLET_LIST NUMBERED_LIST |
r/w | List type for bullets and numbering. |
| bulletsCharacterStyle | any | 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
: NORMAL SMALL_CAPS ALL_CAPS CAP_TO_SMALL_CAP |
r/w | The capitalization scheme. |
| characters | Characters | readonly | A collection of characters. |
| composer | string | r/w | The text composer to use to compose the text. |
| contents | any | r/w | The text contents of the Story. 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) |
| dropCapCharacters | number | r/w | The number of characters to drop cap. |
| dropcapDetail | number | r/w | The detailed size and positioning of the drop cap. |
| dropCapLines | number | r/w | The number of lines to drop cap. |
| dropCapStyle | CharacterStyle | r/w | The character style to apply to the drop cap. Can also accept: String. |
| fillColor | Swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Story. . Can also accept: String. |
| fillTint | number | r/w | The tint (as a percentage) of the fill color of the Story. (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 | number | 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 Story. (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 Story. |
| gradientFillStart | Array of number | r/w | The starting point (in page coordinates) of a gradient applied to the fill of the Story, in the format [x, y]. |
| gradientStrokeAngle | number | r/w | The angle of a linear gradient applied to the stroke of the Story. (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 Story. |
| gradientStrokeStart | Array of number | r/w | The starting point (in page coordinates) of a gradient applied to the stroke of the Story, 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) |
| hyphenateAcrossColumns | bool | r/w | If true, allows the last word in a text column to be hyphenated. |
| hyphenateAfterFirst | number | r/w | The mininum number of letters at the beginning of a word that can be broken by a hyphen. |
| hyphenateBeforeLast | number | 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 | 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 | 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 | number | 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. |
| hyphenWeight | number | r/w | The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100) |
| 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
: LEFT_ALIGN CENTER_ALIGN RIGHT_ALIGN LEFT_JUSTIFIED RIGHT_JUSTIFIED CENTER_JUSTIFIED FULLY_JUSTIFIED TO_BINDING_SIDE AWAY_FROM_BINDING_SIDE |
r/w | The paragraph alignment. |
| 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 | r/w | The minimum number of lines to keep together in a paragraph before allowing a page break. |
| keepLastLines | number | 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 | r/w | The minimum number of lines to keep with the next paragraph. |
| kerningMethod | string | r/w | The type of pair kerning. |
| label | string | r/w | A property that can be set to any string. |
| lastLineIndent | number | r/w | The amount to indent the last line in the Story. |
| leading | any | r/w | The leading applied to the text. Can return: Unit or Leading enumerator. |
| leftIndent | number | r/w | The width of the left indent. |
| length | number | readonly | The number of Stories 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
: NONE UNMANAGED_STORY CHECKED_IN_STORY CHECKED_OUT_STORY LOCKED_STORY EMBEDDED_STORY MISSING_LOCK_STATE 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
: LEFT_ALIGN CENTER_ALIGN RIGHT_ALIGN |
r/w | The alignment of the number. |
| numberingApplyRestartPolicy | bool | r/w | If true, apply the numbering restart policy. |
| numberingCharacterStyle | any | 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 | any | 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 any | 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
: TABULAR_LINING PROPORTIONAL_OLDSTYLE PROPORTIONAL_LINING TABULAR_OLDSTYLE 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. |
| 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. |
| otfSlashedZero | bool | r/w | If true, use a slashed zeroes 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. |
| paragraphs | Paragraphs | readonly | A collection of paragraphs. |
| parent | any | readonly | The parent of the Story (a XMLElement or Document). |
| pointSize | number | r/w | The text size. |
| polygons | Polygons | readonly | A collection of polygons. |
| position |
Position
: NORMAL SUPERSCRIPT SUBSCRIPT OT_SUPERSCRIPT OT_SUBSCRIPT OT_NUMERATOR OT_DENOMINATOR |
r/w | The text position relative to the baseline. |
| positionalForm |
PositionalForms
: NONE CALCULATE INITIAL MEDIAL FINAL 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 | number | r/w | The width of the right indent. |
| ruleAbove | bool | r/w | If true, places a rule above the paragraph. |
| ruleAboveColor | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String. |
| ruleAboveGapColor | any | 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 | number | 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 | number | r/w | The line weight of the rule above |
| ruleAboveOffset | number | 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 | number | 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 | any | r/w | The stroke type of the rule above the Story. Can return: StrokeStyle or String. |
| ruleAboveWidth |
RuleWidth
: TEXT_WIDTH 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 | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String. |
| ruleBelowGapColor | any | 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 | number | 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 | number | r/w | The line weight of the rule below |
| ruleBelowOffset | number | 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 | number | 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 | any | r/w | The stroke type of the rule below the Story. Can return: StrokeStyle or String. |
| ruleBelowWidth |
RuleWidth
: TEXT_WIDTH COLUMN_WIDTH |
r/w | The basis (text width or column width) used to calculate the width of the paragraph rule below. |
| singleWordJustification |
SingleWordJustification
: LEFT_ALIGN CENTER_ALIGN RIGHT_ALIGN 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 | number | r/w | The height of the paragraph space below. |
| spaceBefore | number | r/w | The height of the paragraph space above. |
| startParagraph |
StartParagraph
: ANYWHERE NEXT_COLUMN NEXT_FRAME NEXT_PAGE NEXT_ODD_PAGE 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
: REGULAR_STORY TOC_STORY INDEXING_STORY |
readonly | The type of story. |
| strikeThroughColor | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String. |
| strikeThroughGapColor | any | 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 | number | 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 | any | r/w | The stroke type of the strikethrough stroke. Can return: StrokeStyle or String. |
| strikeThroughWeight | number | r/w | The stroke weight of the strikethrough stroke. |
| strikeThru | bool | r/w | If true, draws a strikethrough line through the text. |
| strokeColor | Swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Story. Can also accept: String. |
| strokeTint | number | r/w | The tint (as a percentage) of the stroke color of the Story. (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 | number | 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. |
| tables | Tables | readonly | A collection of tables. |
| tabList | Array of any | r/w | A list of all of the properties of all of the Story's tab stops. Can return: Array of Arrays of Property Name/Value Pairs. |
| tabStops | TabStops | readonly | A collection of tab stops. |
| textColumns | TextColumns | readonly | A collection of text columns. |
| textContainers | Array of any | readonly | array of text frames or text paths. Can return: Array of TextFrames or TextPaths. |
| textFrames | TextFrames | readonly | A collection of text frames. |
| texts | Texts | readonly | A collection of text objects. |
| textStyleRanges | TextStyleRanges | readonly | A collection of text style ranges. |
| textVariableInstances | TextVariableInstances | readonly | A collection of text variable instances. |
| 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 | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String. |
| underlineGapColor | any | 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 | number | 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 | any | r/w | The stroke type of the underline stroke. Can return: StrokeStyle or String. |
| underlineWeight | number | 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. |
Methods
void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.
void changecase (using:
ChangecaseMode)
Sets the case of the text.
| Parameter | Type | Description |
|---|---|---|
| using | ChangecaseMode
: UPPERCASE LOWERCASE TITLECASE SENTENCECASE |
The text case option. |
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) |
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=ALL])
Clears the specified types of override.
| Parameter | Type | Description |
|---|---|---|
| overridesToClear | OverrideType
: ALL CHARACTER_ONLY PARAGRAPH_ONLY |
The types of override to clear. (Optional) (default: 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
: BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location relative to the reference object or within the containing object. |
| reference |
Text
Story Cell Row Column Table PageItem |
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 Story to 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
: BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location relative to the reference object or within the containing object. |
| reference |
Text
Story Cell Row Column Table PageItem |
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.
string toSource ()
Generates a string which, if executed, will return the Story.
string toSpecifier ()
Retrieves the object specifier.
Element of:
Character.parentStoryDataMergeTextPlaceholder.parentStory
InsertionPoint.parentStory
Line.parentStory
Paragraph.parentStory
Text.parentStory
TextColumn.parentStory
TextFrame.parentStory
TextPath.parentStory
TextStyleRange.parentStory
Word.parentStory
XMLElement.parentStory
Used in:
DataMergeTextPlaceholders.add ( parentStory: Story, storyOffset: any, field: DataMergeField[, withProperties: Object])Stories.previousItem ( obj: Story)
Stories.nextItem ( obj: Story)
Returned by:
Array of Story Document.createTOC ( using: TOCStyle[, replacing: bool=false][, fromBook: Book][, placePoint: Array of number][, includeOverset: bool=false][, destinationLayer: Layer] )Array of Story Index.generate ( [on: any][, placePoint: Array of number][, 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 ( )