PreflightRuleInstances

A collection of preflight rule instances.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

PreflightRuleInstance [] (index:Number)

Returns the PreflightRuleInstance with the specified index.

Parameter	Type	Description
index	Number	The index.

Varies add (id:String, withProperties:Object)

Adds a new preflight rule to the profile.

Parameter	Type	Description
id	String	The ID of the rule to be added
withProperties	Object	Initial values for properties of the new PreflightRuleInstance (Optional)

PreflightRuleInstance anyItem ()

Returns any PreflightRuleInstance in the collection.

Number count ()

Displays the number of elements in the PreflightRuleInstance.

PreflightRuleInstance everyItem ()

Returns every PreflightRuleInstance in the collection.

PreflightRuleInstance firstItem ()

Returns the first PreflightRuleInstance in the collection.

PreflightRuleInstance item (index:Varies LongInteger String)

Returns the PreflightRuleInstance with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

PreflightRuleInstance itemByID (id:Number)

Returns the PreflightRuleInstance with the specified ID.

Parameter	Type	Description
id	Number	The ID.

PreflightRuleInstance itemByName (name:String)

Returns the PreflightRuleInstance with the specified name.

Parameter	Type	Description
name	String	The name.

PreflightRuleInstance itemByRange (from:Varies LongInteger PreflightRuleInstance String, to:Varies LongInteger PreflightRuleInstance String)

Returns the PreflightRuleInstances within the specified range.

Parameter	Type	Description
from	LongInteger PreflightRuleInstance String	The PreflightRuleInstance, index, or name at the beginning of the range. Can accept: PreflightRuleInstance, Long Integer or String.
to	LongInteger PreflightRuleInstance String	The PreflightRuleInstance, index, or name at the end of the range. Can accept: PreflightRuleInstance, Long Integer or String.

Parameter

Type

Description

from

LongInteger

PreflightRuleInstance

String

The PreflightRuleInstance, index, or name at the beginning of the range. Can accept: PreflightRuleInstance, Long Integer or String.

LongInteger

PreflightRuleInstance

String

The PreflightRuleInstance, index, or name at the end of the range. Can accept: PreflightRuleInstance, Long Integer or String.

PreflightRuleInstance lastItem ()

Returns the last PreflightRuleInstance in the collection.

PreflightRuleInstance middleItem ()

Returns the middle PreflightRuleInstance in the collection.

PreflightRuleInstance nextItem (obj:PreflightRuleInstance)

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

Parameter	Type	Description
obj	PreflightRuleInstance	The PreflightRuleInstance whose index comes before the desired PreflightRuleInstance.

PreflightRuleInstance previousItem (obj:PreflightRuleInstance)

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

Parameter	Type	Description
obj	PreflightRuleInstance	The index of the PreflightRuleInstance that follows the desired PreflightRuleInstance.

String toSource ()

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

Object of

PreflightProfile.preflightRuleInstances