Adobe InCopy CS5 (7.0) Object Model JS: IdleTasks

InCopy CS5

Class

IdleTasks

 All attachable idle tasks.

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

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

ParameterTypeDescription
indexnumberThe index.

IdleTask add ([withProperties: Object])
Creates a new IdleTask.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new IdleTask (Optional)

IdleTask anyItem ()
Returns any IdleTask in the collection.

number count ()
Displays the number of elements in the IdleTask.

Array of IdleTask everyItem ()
Returns every IdleTask in the collection.

IdleTask firstItem ()
Returns the first IdleTask in the collection.

IdleTask item (index: varies)
Returns the IdleTask with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromIdleTask
Long Integer
String
The IdleTask, index, or name at the beginning of the range. Can accept: IdleTask, Long Integer or String.
toIdleTask
Long Integer
String
The IdleTask, index, or name at the end of the range. Can accept: IdleTask, Long Integer or String.

IdleTask lastItem ()
Returns the last IdleTask in the collection.

IdleTask middleItem ()
Returns the middle IdleTask in the collection.

IdleTask nextItem (obj: IdleTask)
Returns the IdleTask whose index follows the specified IdleTask in the collection.

ParameterTypeDescription
objIdleTaskThe IdleTask whose index comes before the desired IdleTask.

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

ParameterTypeDescription
objIdleTaskThe index of the IdleTask that follows the desired IdleTask.

string toSource ()
Generates a string which, if executed, will return the IdleTask.

Element of

Application.idleTasks

Jongware, 23-Mar-2011 v3.0.3dContents :: Index