Inks

A collection of inks.

Methods:

[], 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

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.

Ink everyItem ()

Returns every Ink in the collection.

Ink firstItem ()

Returns the first Ink in the collection.

Ink item (index:Varies LongInteger String)

Returns the Ink with the specified index or name.

Parameter

Type

Description

index

LongInteger

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.

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

Returns the Inks within the specified range.

Parameter

Type

Description

from

Ink

LongInteger

String

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

to

Ink

LongInteger

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.

Object of

Application.inks

Document.inks