PreflightProfileRules

A collection of preflight profile rules.

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

PreflightProfileRule [] (index:Number)

Returns the PreflightProfileRule 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 PreflightProfileRule (Optional)

PreflightProfileRule anyItem ()

Returns any PreflightProfileRule in the collection.

Number count ()

Displays the number of elements in the PreflightProfileRule.

PreflightProfileRule everyItem ()

Returns every PreflightProfileRule in the collection.

PreflightProfileRule firstItem ()

Returns the first PreflightProfileRule in the collection.

PreflightProfileRule item (index:Varies LongInteger String)

Returns the PreflightProfileRule with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

PreflightProfileRule itemByID (id:Number)

Returns the PreflightProfileRule with the specified ID.

Parameter

Type

Description

id

Number

The ID.

PreflightProfileRule itemByName (name:String)

Returns the PreflightProfileRule with the specified name.

Parameter

Type

Description

name

String

The name.

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

Returns the PreflightProfileRules within the specified range.

Parameter

Type

Description

from

LongInteger

PreflightProfileRule

String

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

to

LongInteger

PreflightProfileRule

String

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

PreflightProfileRule lastItem ()

Returns the last PreflightProfileRule in the collection.

PreflightProfileRule middleItem ()

Returns the middle PreflightProfileRule in the collection.

PreflightProfileRule nextItem (obj:PreflightProfileRule)

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

Parameter

Type

Description

obj

PreflightProfileRule

The PreflightProfileRule whose index comes before the desired PreflightProfileRule.

PreflightProfileRule previousItem (obj:PreflightProfileRule)

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

Parameter

Type

Description

obj

PreflightProfileRule

The index of the PreflightProfileRule that follows the desired PreflightProfileRule.

String toSource ()

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

Object of

PreflightProfile.preflightProfileRules