AssignedStory
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| filePath | string | readonly | The file path (colon delimited on the Mac OS). Can also accept: File. |
| id | number | readonly | The unique ID of the AssignedStory. |
| index | number | readonly | The index of the AssignedStory within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | readonly | The name of the AssignedStory. |
| parent | Assignment | readonly | The parent of the AssignedStory (a Assignment). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| storyReference | OvalPageItem Polygon Rectangle Story |
readonly | A reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array
of AssignedStory getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the AssignedStory.
Used in:
AssignedStory AssignedStories.nextItem (obj: AssignedStory)
AssignedStory AssignedStories.previousItem (obj: AssignedStory)
Return
AssignedStory AssignedStories.[] (index: number)
AssignedStory AssignedStories.anyItem ()
Array of AssignedStory AssignedStories.everyItem ()
AssignedStory AssignedStories.firstItem ()
AssignedStory AssignedStories.item (index: varies)
AssignedStory AssignedStories.itemByID (id: number)
AssignedStory AssignedStories.itemByName (name: string)
Array of AssignedStory AssignedStories.itemByRange (from: varies, to: varies)
AssignedStory AssignedStories.lastItem ()
AssignedStory AssignedStories.middleItem ()
AssignedStory AssignedStories.nextItem (obj: AssignedStory)
AssignedStory AssignedStories.previousItem (obj: AssignedStory)
Array of AssignedStory AssignedStory.getElements ()
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |