Adobe InDesign CS5 Server (7.0) Object Model JS: Stories

InDesign Server CS5

Class

Stories

 A collection of stories.

QuickLinks

[], anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Story [] (index: number)
Returns the Story with the specified index.

ParameterTypeDescription
indexnumberThe index.

Story anyItem ()
Returns any Story in the collection.

number count ()
Displays the number of elements in the Story.

Array of Story everyItem ()
Returns every Story in the collection.

Story firstItem ()
Returns the first Story in the collection.

Story item (index: varies)
Returns the Story with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Story itemByID (id: number)
Returns the Story with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Story itemByName (name: string)
Returns the Story with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Story itemByRange (from: varies, to: varies)
Returns the Stories within the specified range.

ParameterTypeDescription
fromLong Integer
Story
String
The Story, index, or name at the beginning of the range. Can accept: Story, Long Integer or String.
toLong Integer
Story
String
The Story, index, or name at the end of the range. Can accept: Story, Long Integer or String.

Story lastItem ()
Returns the last Story in the collection.

Story middleItem ()
Returns the middle Story in the collection.

Story nextItem (obj: Story)
Returns the Story whose index follows the specified Story in the collection.

ParameterTypeDescription
objStoryThe Story whose index comes before the desired Story.

Story previousItem (obj: Story)
Returns the Story with the index previous to the specified index.

ParameterTypeDescription
objStoryThe index of the Story that follows the desired Story.

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

Element of

Document.stories

XMLElement.stories

Jongware, 23-Mar-2011 v3.0.3dContents :: Index