K4 InDesign Javascript API Documentation

AssignmentAssignments

A collection of assignments.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
filePath ​[, versionComments] ​[, forceSave] ​[, withProperties])
  → Assignment
anyItem(
)
  → Assignment
count(
)
  → number
everyItem(
)
  → Assignment
firstItem(
)
  → Assignment
item(
index)
  → Assignment
itemByID(
id)
  → Assignment
itemByName(
name)
  → Assignment
itemByRange(
from, to)
  → Assignment
lastItem(
)
  → Assignment
middleItem(
)
  → Assignment
nextItem(
obj)
  → Assignment
previousItem(
obj)
  → Assignment
toSource(
)
  → string
add(
filePath ​[, versionComments] ​[, forceSave=false] ​[, withProperties])
  → Assignment
Creates a new assignment.
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)
withProperties Object Initial values for properties of the new Assignment (Optional)
anyItem(
)
  → Assignment
Returns any Assignment in the collection.
count(
)
  → number
Displays the number of elements in the Assignment.
everyItem(
)
  → Assignment
Returns every Assignment in the collection.
firstItem(
)
  → Assignment
Returns the first Assignment in the collection.
item(
index)
  → Assignment
Returns the Assignment with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → Assignment
Returns the Assignment with the specified ID.
id number The ID.
itemByName(
name)
  → Assignment
Returns the Assignment with the specified name.
name string The name.
itemByRange(
from, to)
  → Assignment
Returns the Assignments within the specified range.
from The Assignment, index, or name at the beginning of the range. Can accept: Assignment, Long Integer or String.
to The Assignment, index, or name at the end of the range. Can accept: Assignment, Long Integer or String.
lastItem(
)
  → Assignment
Returns the last Assignment in the collection.
middleItem(
)
  → Assignment
Returns the middle Assignment in the collection.
nextItem(
obj)
  → Assignment
Returns the Assignment whose index follows the specified Assignment in the collection.
obj Assignment The Assignment whose index comes before the desired Assignment.
previousItem(
obj)
  → Assignment
Returns the Assignment with the index previous to the specified index.
obj Assignment The index of the Assignment that follows the desired Assignment.
toSource(
)
  → string
Generates a string which, if executed, will return the Assignment.