AssignedStory
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| filePath | Filestring | 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 | r/w | 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 | Oval PageItem Polygon Rectangle Story |
readonly | A reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon. |
Methods
Instances
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. |
AssignedStory move ([to:
LocationOptions=LocationOptions.AT_END][, reference:
any])
Moves the assigned story to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location of the assigned story relative to the reference object or within the containing object. (Optional) (default: LocationOptions.AT_END) |
| reference | AssignedStory Assignment | The reference object. Note: Required when the to parameter specifies before or after. Can accept: Assignment or AssignedStory. (Optional) |
string toSource ()
Generates a string which, if executed, will return the AssignedStory.
string toSpecifier ()
Retrieves the object specifier.
Used in:
array of AssignedStory AssignedStories.itemByRange (from: any, to: any)
AssignedStory AssignedStories.nextItem (obj: AssignedStory)
AssignedStory AssignedStories.previousItem (obj: AssignedStory)
AssignedStory AssignedStory.move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Return
AssignedStory AssignedStories.[] (index: number)
AssignedStory AssignedStories.anyItem ()
Array of AssignedStory AssignedStories.everyItem ()
AssignedStory AssignedStories.firstItem ()
AssignedStory AssignedStories.item (index: any)
AssignedStory AssignedStories.itemByID (id: number)
AssignedStory AssignedStories.itemByName (name: string)
Array of AssignedStory AssignedStories.itemByRange (from: any, to: any)
AssignedStory AssignedStories.lastItem ()
AssignedStory AssignedStories.middleItem ()
AssignedStory AssignedStories.nextItem (obj: AssignedStory)
AssignedStory AssignedStories.previousItem (obj: AssignedStory)
Array of AssignedStory AssignedStory.getElements ()
AssignedStory AssignedStory.move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |