Inks
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Ink [] (index:
number)
Returns the Ink with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Ink anyItem ()
Returns any Ink in the collection.
number count ()
Displays the number of elements in the Ink.
Array of Ink everyItem ()
Returns every Ink in the collection.
Ink firstItem ()
Returns the first Ink in the collection.
Ink item (index:
any)
Returns the Ink with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
Ink itemByID (id:
number)
Returns the Ink with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
Ink itemByName (name:
string)
Returns the Ink with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of Ink itemByRange (from:
any, to:
any)
Returns the Inks within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Ink Long Integer String | The Ink, index, or name at the beginning of the range. Can accept: Ink, Long Integer or String. |
| to | Ink Long Integer String | The Ink, index, or name at the end of the range. Can accept: Ink, Long Integer or String. |
Ink lastItem ()
Returns the last Ink in the collection.
Ink middleItem ()
Returns the middle Ink in the collection.
Ink nextItem (obj:
Ink)
Returns the Ink whose index follows the specified Ink in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Ink | The Ink whose index comes before the desired Ink. |
Ink previousItem (obj:
Ink)
Returns the Ink with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Ink | The index of the Ink that follows the desired Ink. |
string toSource ()
Generates a string which, if executed, will return the Ink.
Element of
Application.inks
Document.inks
Used in:
MixedInk MixedInks.add (inkList: any, inkPercentages: Array of number[, withProperties: Object])
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |