K4 InDesign Javascript API Documentation

PreflightRuleDataObjects

A collection of prefight rule data objects.

Instance Properties

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

Methods

add(
name, dataType, dataValue ​[, withProperties])
  → RuleDataObject
anyItem(
)
  → RuleDataObject
count(
)
  → number
everyItem(
)
  → RuleDataObject
firstItem(
)
  → RuleDataObject
item(
index)
  → RuleDataObject
itemByID(
id)
  → RuleDataObject
itemByName(
name)
  → RuleDataObject
itemByRange(
from, to)
  → RuleDataObject
lastItem(
)
  → RuleDataObject
middleItem(
)
  → RuleDataObject
nextItem(
obj)
  → RuleDataObject
previousItem(
obj)
  → RuleDataObject
toSource(
)
  → string
add(
name, dataType, dataValue ​[, withProperties])
  → RuleDataObject
Add a new preflight rule data to a preflight profile rule.
name string The name of the rule data to add
dataType RuleDataType The type of data
dataValue The value of data. Can accept: String, Real, Long Integer, Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of Strings, Reals, Long Integers, Short Integers, Booleans or Objects.
withProperties Object Initial values for properties of the new RuleDataObject (Optional)
anyItem(
)
  → RuleDataObject
Returns any RuleDataObject in the collection.
count(
)
  → number
Displays the number of elements in the RuleDataObject.
everyItem(
)
  → RuleDataObject
Returns every RuleDataObject in the collection.
firstItem(
)
  → RuleDataObject
Returns the first RuleDataObject in the collection.
item(
index)
  → RuleDataObject
Returns the RuleDataObject with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → RuleDataObject
Returns the RuleDataObject with the specified ID.
id number The ID.
itemByName(
name)
  → RuleDataObject
Returns the RuleDataObject with the specified name.
name string The name.
itemByRange(
from, to)
  → RuleDataObject
Returns the RuleDataObjects within the specified range.
from The RuleDataObject, index, or name at the beginning of the range. Can accept: RuleDataObject, Long Integer or String.
to The RuleDataObject, index, or name at the end of the range. Can accept: RuleDataObject, Long Integer or String.
lastItem(
)
  → RuleDataObject
Returns the last RuleDataObject in the collection.
middleItem(
)
  → RuleDataObject
Returns the middle RuleDataObject in the collection.
nextItem(
obj)
  → RuleDataObject
Returns the RuleDataObject whose index follows the specified RuleDataObject in the collection.
obj RuleDataObject The RuleDataObject whose index comes before the desired RuleDataObject.
previousItem(
obj)
  → RuleDataObject
Returns the RuleDataObject with the index previous to the specified index.
obj RuleDataObject The index of the RuleDataObject that follows the desired RuleDataObject.
toSource(
)
  → string
Generates a string which, if executed, will return the RuleDataObject.