Adobe InDesign CS6 Server (8.0) Object Model JS: AssignedStories

InDesign Server CS6

Class

AssignedStories

 A collection of assigned stories.

See also AssignedStory.

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

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

ParameterTypeDescription
indexnumberThe index.

AssignedStory anyItem ()
Returns any AssignedStory in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromAssignedStory
Long Integer
String
The AssignedStory, index, or name at the beginning of the range. Can accept: AssignedStory, Long Integer or String.
toAssignedStory
Long Integer
String
The AssignedStory, index, or name at the end of the range. Can accept: AssignedStory, Long Integer or String.

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

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

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

ParameterTypeDescription
objAssignedStoryThe AssignedStory whose index comes before the desired AssignedStory.

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

ParameterTypeDescription
objAssignedStoryThe index of the AssignedStory that follows the desired AssignedStory.

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

Element of

Assignment.assignedStories

Jongware, 28-Apr-2012 v3.0.3iContents :: Index