Adobe InDesign CS2 (4.0) Object Model JS: StoryWindows

InDesign CS2

Class

StoryWindows

 A collection of story windows.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

StoryWindow anyItem ()
Returns any StoryWindow in the collection.

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

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

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

StoryWindow item (index: any)
Returns the StoryWindow with the specified index or name.

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

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

ParameterTypeDescription
namestringThe name.

Array of StoryWindow itemByRange (from: any, to: any)
Returns the StoryWindows within the specified range.

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

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

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

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

ParameterTypeDescription
objStoryWindowThe StoryWindow whose index comes before the desired StoryWindow.

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

ParameterTypeDescription
objStoryWindowThe index of the StoryWindow that follows the desired StoryWindow.

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

Element of

Application.storyWindows

Document.storyWindows

Jongware, 27-Jun-2010 v3.0.3dContents :: Index