An assignment.
Go to Property Listing | Method Listing
update, remove, createPackage, cancelPackage, insertLabel, extractLabel, toSource, getElements, toSpecifier, addEventListener, removeEventListener
AssignedStories, AssignmentExportOptions, AssignmentStatus, Boolean, Document, EventListeners, Events, File, NothingEnum, Number, Object, String, UIColors,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
assignedStories |
readonly |
A collection of assigned stories. |
|
|
assignmentFileStatus |
AssignmentStatus.ASSIGNMENT_UP_TO_DATE AssignmentStatus.ASSIGNMENT_OUT_OF_DATE AssignmentStatus.ASSIGNMENT_FILE_MISSING |
readonly |
The status of the assignment file. |
|
documentPath |
readonly |
The path to the document that the hyperlink destination points to. |
|
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
exportOptions |
AssignmentExportOptions.EMPTY_FRAMES AssignmentExportOptions.ASSIGNED_SPREADS AssignmentExportOptions.EVERYTHING |
read/write |
The content to export in the assignment. |
|
filePath |
readonly |
The file path (colon delimited on the Mac OS). Can also accept: File. |
|
|
frameColor |
Array of 3 Reals (0 - 255) NothingEnum.NOTHING |
read/write |
The color of the assignment's frames. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum enumerator. |
|
id |
readonly |
The unique ID of the Assignment. |
|
|
includeLinksWhenPackage |
read/write |
If true, includes linked files when packaging the assignment. |
|
|
index |
readonly |
The index of the Assignment within its containing object. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
label |
read/write |
A property that can be set to any string. |
|
|
name |
read/write |
The name of the Assignment. |
|
|
packageUpToDate |
readonly |
If true, the assignment package is up to date. |
|
|
packaged |
readonly |
If true, the assignment is packaged. |
|
|
parent |
readonly |
The parent of the Assignment (a Document). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
userName |
read/write |
The user name to assign to tracked changes and notes. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined cancelPackage ()
Cancels the package for an assignment.
File createPackage (filePath:File, [submit:Boolean=Boolean], withProperties:Object)
Creates an assignment package.
|
Parameter |
Type |
Description |
|---|---|---|
|
filePath |
The full path name of the assignment package file. |
|
|
submit |
If true, submits assigned stories before packaging the assignment. (Optional) (default: true) |
|
|
withProperties |
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 |
The key. |
Assignment 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.
undefined remove ()
Deletes the assignment and its file.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
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.
undefined update (versionComments:String, [forceSave:Boolean=Boolean])
Updates the assignment file.