PreflightRuleInstances
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
PreflightRuleInstance [] (index:
number)
Returns the PreflightRuleInstance with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
any 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.
Array
of PreflightRuleInstance everyItem ()
Returns every PreflightRuleInstance in the collection.
PreflightRuleInstance firstItem ()
Returns the first PreflightRuleInstance in the collection.
PreflightRuleInstance item (index:
varies)
Returns the PreflightRuleInstance with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer 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. |
Array
of PreflightRuleInstance itemByRange (from:
varies, to:
varies)
Returns the PreflightRuleInstances within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer PreflightRuleInstance String | The PreflightRuleInstance, index, or name at the beginning of the range. Can accept: PreflightRuleInstance, Long Integer or String. |
| to | Long Integer 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.
Element of
PreflightProfile.preflightRuleInstances
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |