K4 InDesign Javascript API Documentation

BasicsStoryWindows

A collection of story windows.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

anyItem(
)
  → StoryWindow
count(
)
  → number
everyItem(
)
  → StoryWindow
firstItem(
)
  → StoryWindow
item(
index)
  → StoryWindow
itemByName(
name)
  → StoryWindow
itemByRange(
from, to)
  → StoryWindow
lastItem(
)
  → StoryWindow
middleItem(
)
  → StoryWindow
nextItem(
obj)
  → StoryWindow
previousItem(
obj)
  → StoryWindow
toSource(
)
  → string
anyItem(
)
  → StoryWindow
Returns any StoryWindow in the collection.
count(
)
  → number
Displays the number of elements in the StoryWindow.
everyItem(
)
  → StoryWindow
Returns every StoryWindow in the collection.
firstItem(
)
  → StoryWindow
Returns the first StoryWindow in the collection.
item(
index)
  → StoryWindow
Returns the StoryWindow with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByName(
name)
  → StoryWindow
Returns the StoryWindow with the specified name.
name string The name.
itemByRange(
from, to)
  → StoryWindow
Returns the StoryWindows within the specified range.
from The StoryWindow, index, or name at the beginning of the range. Can accept: StoryWindow, Long Integer or String.
to The StoryWindow, index, or name at the end of the range. Can accept: StoryWindow, Long Integer or String.
lastItem(
)
  → StoryWindow
Returns the last StoryWindow in the collection.
middleItem(
)
  → StoryWindow
Returns the middle StoryWindow in the collection.
nextItem(
obj)
  → StoryWindow
Returns the StoryWindow whose index follows the specified StoryWindow in the collection.
obj StoryWindow The StoryWindow whose index comes before the desired StoryWindow.
previousItem(
obj)
  → StoryWindow
Returns the StoryWindow with the index previous to the specified index.
obj StoryWindow The index of the StoryWindow that follows the desired StoryWindow.
toSource(
)
  → string
Generates a string which, if executed, will return the StoryWindow.