Story¶
story
Description
A contiguous block of text as specified by a text range. A story can contain one or more text frames; if there is more than one, the multiple text frames are linked together to form a single story.
Properties¶
Story.characters¶
story.characters
Description
All the characters in this story.
Type
Characters; read-only.
Story.insertionPoints¶
story.insertionPoints
Description
All the insertion points in this story.
Type
InsertionPoints; read-only.
Story.length¶
story.length
Description
The number of characters in the story.
Type
Number (long); read-only.
Story.lines¶
story.lines
Description
All the lines in this story.
Type
Lines; read-only.
Story.paragraphs¶
story.paragraphs
Description
All the paragraphs in this story.
Type
Paragraphs; read-only.
Story.parent¶
story.parent
Description
The object’s container.
Type
Object; read-only.
Story.textFrames¶
story.textFrames
Description
The text frame items in this story.
Type
TextFrameItems; read-only.
Story.textRange¶
story.textRange
Description
The text range of the story.
Type
TextRange; read-only.
Story.textRanges¶
story.textRanges
Description
All the text ranges in the story.
Type
TextRanges; read-only.
Story.textSelection¶
story.textSelection
Description
The selected text ranges in the story.
Type
Array of TextRange; read-only.
Story.typename¶
story.typename
Description
The class name of the object.
Type
String; read-only.
Story.words¶
story.words
Description
All the words in the story.
Type
Words; read-only.
Example¶
Threading text frames into stories¶
// Creates 1 story that flows through 2 text frames and another story that
// is displayed in a 3rd text frame
// Create a new document and add 2 area TextFrames
var docRef = documents.add();
var itemRef1 = docRef.pathItems.rectangle(600, 200, 50, 30);
var textRef1 = docRef.textFrames.areaText(itemRef1);
textRef1.selected = true;
// create 2nd text frame and link it the first
var itemRef2 = docRef.pathItems.rectangle(550, 300, 50, 200);
var textRef2 = docRef.textFrames.areaText(itemRef2, TextOrientation.HORIZONTAL, textRef1);
textRef2.selected = true;
// Add enough text to the 1st TextFrame to
// cause it to flow to the 2nd TextFrame.
textRef1.contents = "This is two text frames linked together as one story";
redraw();
// Create a 3rd text frame and count the stories
var textRef3 = docRef.textFrames.add();
textRef3.contents = "Each unlinked textFrame adds a new story."
textRef3.top = 650;
textRef3.left = 200;
redraw();