InDesign2026
API 21.5.1.73
Collection of BackgroundTask

BackgroundTasks

A collection of background task objects.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

→ BackgroundTask

Returns the BackgroundTask with the specified index.

index Number The index.
→ BackgroundTask

Returns any BackgroundTask in the collection.

→ Number

Displays the number of elements in the BackgroundTask.

→ BackgroundTask[]

Returns every BackgroundTask in the collection.

→ BackgroundTask

Returns the first BackgroundTask in the collection.

→ BackgroundTask

Returns the BackgroundTask with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
→ BackgroundTask

Returns the BackgroundTask with the specified ID.

id Number The ID.
→ BackgroundTask

Returns the BackgroundTask with the specified name.

name String The name.
→ BackgroundTask[]

Returns the BackgroundTasks within the specified range.

from BackgroundTask | LongInteger | String The BackgroundTask, index, or name at the beginning of the range. Can accept: BackgroundTask, Long Integer or String.
to BackgroundTask | LongInteger | String The BackgroundTask, index, or name at the end of the range. Can accept: BackgroundTask, Long Integer or String.
→ BackgroundTask

Returns the last BackgroundTask in the collection.

→ BackgroundTask

Returns the middle BackgroundTask in the collection.

→ BackgroundTask

Returns the BackgroundTask whose index follows the specified BackgroundTask in the collection.

obj BackgroundTask The BackgroundTask whose index comes before the desired BackgroundTask.
→ BackgroundTask

Returns the BackgroundTask with the index previous to the specified index.

obj BackgroundTask The index of the BackgroundTask that follows the desired BackgroundTask.
→ String

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

Object of 1

Properties elsewhere that hold a BackgroundTasks.