PreflightPreflightProfileRules

A collection of preflight profile rules.

Instance Properties

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

Methods

add(
id ​[, withProperties])
count(
)
 → number
item(
index)
 → PreflightProfileRule
itemByRange(
from, to)
 → PreflightProfileRule
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 PreflightProfileRule (Optional)
anyItem(
)
 → PreflightProfileRule
Returns any PreflightProfileRule in the collection.
count(
)
 → number
Displays the number of elements in the PreflightProfileRule.
everyItem(
)
 → PreflightProfileRule
Returns every PreflightProfileRule in the collection.
firstItem(
)
 → PreflightProfileRule
Returns the first PreflightProfileRule in the collection.
item(
index)
 → PreflightProfileRule
Returns the PreflightProfileRule with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
 → PreflightProfileRule
Returns the PreflightProfileRule with the specified ID.
id number The ID.
itemByName(
name)
 → PreflightProfileRule
Returns the PreflightProfileRule with the specified name.
name string The name.
itemByRange(
from, to)
 → PreflightProfileRule
Returns the PreflightProfileRules within the specified range.
from The PreflightProfileRule, index, or name at the beginning of the range. Can accept: PreflightProfileRule, Long Integer or String.
to The PreflightProfileRule, index, or name at the end of the range. Can accept: PreflightProfileRule, Long Integer or String.
lastItem(
)
 → PreflightProfileRule
Returns the last PreflightProfileRule in the collection.
middleItem(
)
 → PreflightProfileRule
Returns the middle PreflightProfileRule in the collection.
nextItem(
obj)
 → PreflightProfileRule
Returns the PreflightProfileRule whose index follows the specified PreflightProfileRule in the collection.
obj PreflightProfileRule The PreflightProfileRule whose index comes before the desired PreflightProfileRule.
previousItem(
obj)
 → PreflightProfileRule
Returns the PreflightProfileRule with the index previous to the specified index.
obj PreflightProfileRule The index of the PreflightProfileRule that follows the desired PreflightProfileRule.
toSource(
)
 → string
Generates a string which, if executed, will return the PreflightProfileRule.