Adobe InDesign CS5 Server (7.0) Object Model JS: Assignments

InDesign Server CS5

Class

Assignments

 A collection of assignments.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Assignment [] (index: number)
Returns the Assignment with the specified index.

ParameterTypeDescription
indexnumberThe index.

Assignment add (filePath: File[, versionComments: string][, forceSave: bool=false][, withProperties: Object])
Creates a new assignment.

ParameterTypeDescription
filePathFileThe full path name of the new assignment.
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)
withPropertiesObjectInitial 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.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Assignment itemByID (id: number)
Returns the Assignment with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Assignment itemByName (name: string)
Returns the Assignment with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Assignment itemByRange (from: varies, to: varies)
Returns the Assignments within the specified range.

ParameterTypeDescription
fromAssignment
Long Integer
String
The Assignment, index, or name at the beginning of the range. Can accept: Assignment, Long Integer or String.
toAssignment
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.

ParameterTypeDescription
objAssignmentThe Assignment whose index comes before the desired Assignment.

Assignment previousItem (obj: Assignment)
Returns the Assignment with the index previous to the specified index.

ParameterTypeDescription
objAssignmentThe 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, 23-Mar-2011 v3.0.3dContents :: Index