Assignment
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| assignedStories | AssignedStories | readonly | A collection of assigned stories. |
| assignmentFileStatus | AssignmentStatus: AssignmentStatus.ASSIGNMENT_UP_TO_DATE AssignmentStatus.ASSIGNMENT_OUT_OF_DATE AssignmentStatus.ASSIGNMENT_FILE_MISSING |
readonly | The status of the assignment file. |
| documentPath | File | readonly | The path to the document that the hyperlink destination points to. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| exportOptions | AssignmentExportOptions: AssignmentExportOptions.EMPTY_FRAMES AssignmentExportOptions.ASSIGNED_SPREADS AssignmentExportOptions.EVERYTHING |
r/w | The content to export in the assignment. |
| filePath | File string |
readonly | The file path (colon delimited on the Mac OS). Can also accept: File. |
| frameColor | 3 Reals (0 - 255) NothingEnum UIColors |
r/w | The color of the assignment's frames. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum enumerator. |
| id | number | readonly | The unique ID of the Assignment. |
| includeLinksWhenPackage | bool | r/w | If true, includes linked files when packaging the assignment. |
| index | number | readonly | The index of the Assignment 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 Assignment. |
| packageUpToDate | bool | readonly | If true, the assignment package is up to date. |
| packaged | bool | readonly | If true, the assignment is packaged. |
| parent | Document | readonly | The parent of the Assignment (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| userName | string | r/w | The user name to assign to tracked changes and notes. |
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) |
void cancelPackage ()
Cancels the package for an assignment.
File createPackage (filePath:
File[, submit:
bool=true][, withProperties:
Object])
Creates an assignment package.
| Parameter | Type | Description |
|---|---|---|
| filePath | File | The full path name of the assignment package file. |
| submit | bool | If true, submits assigned stories before packaging the assignment. (Optional) (default: true) |
| withProperties | Object | Initial values for properties of the new Assignment (Optional) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of Assignment 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. |
void remove ()
Deletes the assignment and its file.
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 Assignment.
string toSpecifier ()
Retrieves the object specifier.
void update ([versionComments:
string][, forceSave:
bool=false])
Updates the assignment file.
| Parameter | Type | Description |
|---|---|---|
| versionComments | string | The comment for this version. (Optional) |
| forceSave | bool | If true, forcibly saves a version. (Optional) (default: false) |
Element of
AssignedStory.parent
Used in:
Assignment Assignments.nextItem (obj: Assignment)
Assignment Assignments.previousItem (obj: Assignment)
Return
Array of Assignment Assignment.getElements ()
Assignment Assignments.[] (index: number)
Assignment Assignments.add (filePath: File[, versionComments: string][, forceSave: bool=false][, withProperties: Object])
Assignment Assignments.anyItem ()
Array of Assignment Assignments.everyItem ()
Assignment Assignments.firstItem ()
Assignment Assignments.item (index: varies)
Assignment Assignments.itemByID (id: number)
Assignment Assignments.itemByName (name: string)
Array of Assignment Assignments.itemByRange (from: varies, to: varies)
Assignment Assignments.lastItem ()
Assignment Assignments.middleItem ()
Assignment Assignments.nextItem (obj: Assignment)
Assignment Assignments.previousItem (obj: Assignment)
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |