K4 InDesign Javascript API Documentation

PreflightPreflightRuleInstances

A collection of preflight rule instances.

Instance Properties

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

Methods

add(
id ​[, withProperties])
anyItem(
)
  → PreflightRuleInstance
count(
)
  → number
everyItem(
)
  → PreflightRuleInstance
firstItem(
)
  → PreflightRuleInstance
item(
index)
  → PreflightRuleInstance
itemByID(
id)
  → PreflightRuleInstance
itemByName(
name)
  → PreflightRuleInstance
itemByRange(
from, to)
  → PreflightRuleInstance
lastItem(
)
  → PreflightRuleInstance
middleItem(
)
  → PreflightRuleInstance
nextItem(
obj)
  → PreflightRuleInstance
previousItem(
obj)
  → PreflightRuleInstance
toSource(
)
  → string
add(
id ​[, withProperties])
Adds a new preflight rule to the profile.
id string The ID of the rule to be added
withProperties Object Initial values for properties of the new PreflightRuleInstance (Optional)
anyItem(
)
  → PreflightRuleInstance
Returns any PreflightRuleInstance in the collection.
count(
)
  → number
Displays the number of elements in the PreflightRuleInstance.
everyItem(
)
  → PreflightRuleInstance
Returns every PreflightRuleInstance in the collection.
firstItem(
)
  → PreflightRuleInstance
Returns the first PreflightRuleInstance in the collection.
item(
index)
  → PreflightRuleInstance
Returns the PreflightRuleInstance with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → PreflightRuleInstance
Returns the PreflightRuleInstance with the specified ID.
id number The ID.
itemByName(
name)
  → PreflightRuleInstance
Returns the PreflightRuleInstance with the specified name.
name string The name.
itemByRange(
from, to)
  → PreflightRuleInstance
Returns the PreflightRuleInstances within the specified range.
from The PreflightRuleInstance, index, or name at the beginning of the range. Can accept: PreflightRuleInstance, Long Integer or String.
to The PreflightRuleInstance, index, or name at the end of the range. Can accept: PreflightRuleInstance, Long Integer or String.
lastItem(
)
  → PreflightRuleInstance
Returns the last PreflightRuleInstance in the collection.
middleItem(
)
  → PreflightRuleInstance
Returns the middle PreflightRuleInstance in the collection.
nextItem(
obj)
  → PreflightRuleInstance
Returns the PreflightRuleInstance whose index follows the specified PreflightRuleInstance in the collection.
obj PreflightRuleInstance The PreflightRuleInstance whose index comes before the desired PreflightRuleInstance.
previousItem(
obj)
  → PreflightRuleInstance
Returns the PreflightRuleInstance with the index previous to the specified index.
obj PreflightRuleInstance The index of the PreflightRuleInstance that follows the desired PreflightRuleInstance.
toSource(
)
  → string
Generates a string which, if executed, will return the PreflightRuleInstance.