Assignments

A collection of assignments.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Assignment [] (index:Number)

Returns the Assignment with the specified index.

Parameter

Type

Description

index

Number

The index.

Assignment add (filePath:File, versionComments:String, [forceSave:Boolean=Boolean], 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

Boolean

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.

Assignment everyItem ()

Returns every Assignment in the collection.

Assignment firstItem ()

Returns the first Assignment in the collection.

Assignment item (index:Varies LongInteger String)

Returns the Assignment with the specified index or name.

Parameter

Type

Description

index

LongInteger

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.

Assignment itemByRange (from:Varies Assignment LongInteger String, to:Varies Assignment LongInteger String)

Returns the Assignments within the specified range.

Parameter

Type

Description

from

Assignment

LongInteger

String

The Assignment, index, or name at the beginning of the range. Can accept: Assignment, Long Integer or String.

to

Assignment

LongInteger

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.

Object of

Document.assignments