Adobe InDesign CS2 (4.0) Object Model JS: StoryWindow

InDesign CS2

Class

StoryWindow

 A story window. Base Class: Window

QuickLinks

bringToFront, close, getElements, maximize, minimize, restore, select, toSource, toSpecifier

Hierarchy

Application | Document
Window
StoryWindow

Properties

PropertyTypeAccessDescription
bounds Array of number r/wThe bounds of the window (specified in pixels) in the form [top, left, bottom, right].
indexnumber readonlyThe index of the StoryWindow within its containing object.
namestring readonlyThe name of the StoryWindow.
parentApplicationDocument readonlyThe parent of the StoryWindow (a Document or Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
selection Array of Objects
NothingEnum
Object
r/wThe selection. Can return: Object, Array of Objects or NothingEnum enumerator.

Methods

Instances

void bringToFront ()
Brings the StoryWindow to the front.

void close ()
Closes the StoryWindow.

Array of Object getElements ()
Resolves the object specifier, creating an array of object references.

void maximize ()
Maximizes the window.

void minimize ()
Minimizes the window.

void restore ()
Restores the window.

void select (selectableItems: any[, existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the specified object(s).

ParameterTypeDescription
selectableItems Array of Objects
NothingEnum
Object
SelectAll
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
The selection status of the StoryWindow in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.activeWindow

Used in:

array of StoryWindow StoryWindows.itemByRange (from: any, to: any)

StoryWindow StoryWindows.nextItem (obj: StoryWindow)

StoryWindow StoryWindows.previousItem (obj: StoryWindow)

Return

StoryWindow Story.storyEdit ()

StoryWindow StoryWindows.anyItem ()

Array of StoryWindow StoryWindows.everyItem ()

StoryWindow StoryWindows.firstItem ()

StoryWindow StoryWindows.item (index: any)

StoryWindow StoryWindows.itemByName (name: string)

Array of StoryWindow StoryWindows.itemByRange (from: any, to: any)

StoryWindow StoryWindows.lastItem ()

StoryWindow StoryWindows.middleItem ()

StoryWindow StoryWindows.nextItem (obj: StoryWindow)

StoryWindow StoryWindows.previousItem (obj: StoryWindow)

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