Adobe InCopy CS5 (7.0) Object Model JS: BackgroundTasks

InCopy CS5

Class

BackgroundTasks

 A collection of background task objects.

QuickLinks

[], 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

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

ParameterTypeDescription
indexnumberThe index.

BackgroundTask anyItem ()
Returns any BackgroundTask in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromBackgroundTask
Long Integer
String
The BackgroundTask, index, or name at the beginning of the range. Can accept: BackgroundTask, Long Integer or String.
toBackgroundTask
Long Integer
String
The BackgroundTask, index, or name at the end of the range. Can accept: BackgroundTask, Long Integer or String.

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

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

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

ParameterTypeDescription
objBackgroundTaskThe BackgroundTask whose index comes before the desired BackgroundTask.

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

ParameterTypeDescription
objBackgroundTaskThe index of the BackgroundTask that follows the desired BackgroundTask.

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

Element of

Application.backgroundTasks

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