Assignments
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Assignment [] (index:
number)
Returns the Assignment with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Assignment add (filePath:
File[, versionComments:
string][, forceSave:
bool=false][, withProperties:
Object])
Creates a new assignment.
| Parameter | Type | Description |
|---|---|---|
| filePath | File | The full path name of the new assignment. |
| versionComments | string | The comment for this version. (Optional) |
| forceSave | bool | If true, forcibly saves a version. (Optional) (default: false) |
| withProperties | Object | Initial values for properties of the new Assignment (Optional) |
Assignment anyItem ()
Returns any Assignment in the collection.
number count ()
Displays the number of elements in the Assignment.
Array of Assignment everyItem ()
Returns every Assignment in the collection.
Assignment firstItem ()
Returns the first Assignment in the collection.
Assignment item (index:
varies)
Returns the Assignment with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
Assignment itemByID (id:
number)
Returns the Assignment with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
Assignment itemByName (name:
string)
Returns the Assignment with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of Assignment itemByRange (from:
varies, to:
varies)
Returns the Assignments within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Assignment Long Integer String | The Assignment, index, or name at the beginning of the range. Can accept: Assignment, Long Integer or String. |
| to | Assignment Long Integer String | The Assignment, index, or name at the end of the range. Can accept: Assignment, Long Integer or String. |
Assignment lastItem ()
Returns the last Assignment in the collection.
Assignment middleItem ()
Returns the middle Assignment in the collection.
Assignment nextItem (obj:
Assignment)
Returns the Assignment whose index follows the specified Assignment in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Assignment | The Assignment whose index comes before the desired Assignment. |
Assignment previousItem (obj:
Assignment)
Returns the Assignment with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Assignment | The index of the Assignment that follows the desired Assignment. |
string toSource ()
Generates a string which, if executed, will return the Assignment.
Element of
Document.assignments
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |