K4 InDesign Javascript API Documentation

PreflightPreflightProcesses

A collection of preflight processes.

Instance Properties

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

Methods

add(
targetObject, appliedProfile ​[, preflightOptions] ​[, withProperties])
  → PreflightProcess
anyItem(
)
  → PreflightProcess
count(
)
  → number
everyItem(
)
  → PreflightProcess
firstItem(
)
  → PreflightProcess
item(
index)
  → PreflightProcess
itemByRange(
from, to)
  → PreflightProcess
lastItem(
)
  → PreflightProcess
middleItem(
)
  → PreflightProcess
nextItem(
obj)
  → PreflightProcess
previousItem(
obj)
  → PreflightProcess
toSource(
)
  → string
add(
targetObject, appliedProfile ​[, preflightOptions] ​[, withProperties])
  → PreflightProcess
Adds a new preflight process.
targetObject Document The document the process should inspect.
appliedProfile PreflightProfile The preflight profile that should be used.
preflightOptions PreflightOption The preflight options that should be used. (Optional)
withProperties Object Initial values for properties of the new PreflightProcess (Optional)
anyItem(
)
  → PreflightProcess
Returns any PreflightProcess in the collection.
count(
)
  → number
Displays the number of elements in the PreflightProcess.
everyItem(
)
  → PreflightProcess
Returns every PreflightProcess in the collection.
firstItem(
)
  → PreflightProcess
Returns the first PreflightProcess in the collection.
item(
index)
  → PreflightProcess
Returns the PreflightProcess with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → PreflightProcess
Returns the PreflightProcesses within the specified range.
from The PreflightProcess, index, or name at the beginning of the range. Can accept: PreflightProcess, Long Integer or String.
to The PreflightProcess, index, or name at the end of the range. Can accept: PreflightProcess, Long Integer or String.
lastItem(
)
  → PreflightProcess
Returns the last PreflightProcess in the collection.
middleItem(
)
  → PreflightProcess
Returns the middle PreflightProcess in the collection.
nextItem(
obj)
  → PreflightProcess
Returns the PreflightProcess whose index follows the specified PreflightProcess in the collection.
obj PreflightProcess The PreflightProcess whose index comes before the desired PreflightProcess.
previousItem(
obj)
  → PreflightProcess
Returns the PreflightProcess with the index previous to the specified index.
obj PreflightProcess The index of the PreflightProcess that follows the desired PreflightProcess.
toSource(
)
  → string
Generates a string which, if executed, will return the PreflightProcess.