A story window.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| bounds | Array of number | r/w | The bounds of the window (specified in pixels) in the form [top, left, bottom, right]. |
| index | number | readonly | The index of the StoryWindow within its containing object. |
| name | string | readonly | The name of the StoryWindow. |
| parent | any | readonly | The parent of the StoryWindow (a Document or Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| selection | Array of Object | r/w | The selected object(s). Can also accept: Object or NothingEnum enumerator. |
Methods
void bringToFront ()
Brings the StoryWindow to the front of its layer.
void close ()
Closes the StoryWindow.
Array of StoryWindowgetElements ()
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=REPLACE_WITH ])
Selects the specified object(s).
| Parameter | Type | Description |
|---|---|---|
| selectableItems | Object Array of Objects NothingEnum SelectAll |
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. |
| existingSelection | SelectionOptions : ADD_TO REMOVE_FROM REPLACE_WITH |
The selection status of the StoryWindow in relation to previously selected objects. (Optional) (default: REPLACE_WITH ) |
string toSource ()
Generates a string which, if executed, will return the StoryWindow.
string toSpecifier ()
Retrieves the object specifier.
Used in:
StoryWindows.previousItem (
obj:
StoryWindow )
StoryWindows.nextItem (
obj:
StoryWindow )
Returned by:
StoryWindow Story.storyEdit (
)
Array of StoryWindow StoryWindow .getElements (
)
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
)