StoryWindow
QuickLinks
Hierarchy
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. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| name | string | readonly | The name of the StoryWindow. |
| parent | Document | readonly | The parent of the StoryWindow (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| selection | Array of NothingEnum Object Object |
r/w | The selected object(s). Can also accept: Object or NothingEnum enumerator. |
Methods
Instances
void bringToFront ()
Brings the object to the front.
void close ()
Closes the StoryWindow.
Array of StoryWindow 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).
| Parameter | Type | Description |
|---|---|---|
| selectableItems | Array of Objects NothingEnum Object SelectAll | The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. |
| existingSelection | SelectionOptions: 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 ()
Array of StoryWindow StoryWindow.getElements ()
StoryWindow StoryWindows.[] (index: number)
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, 20-Jun-2010 v3.0.3d | Contents :: Index |