An assigned story.
Go to Property Listing | Method Listing
extractLabel, getElements, insertLabel, move, toSource, toSpecifier
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The file path (colon delimited on the Mac OS). Can also accept: File. |
||
|
readonly |
The unique ID of the AssignedStory. |
||
|
readonly |
The index of the AssignedStory within its containing object. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The name of the AssignedStory. |
||
|
readonly |
The parent of the AssignedStory (a Assignment). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
A reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon. |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
AssignedStory getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
AssignedStory move ([to:LocationOptions=LocationOptions], reference:Varies Assignment AssignedStory)
Moves the assigned story to the specified location.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The location of the assigned story relative to the reference object or within the containing object. (Optional) (default: LocationOptions.AT_END) |
|
|
reference |
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.