Adobe InDesign CS5 Server (7.0) Object Model JS: Tints

InDesign Server CS5

Class

Tints

 A collection of tints.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Tint [] (index: number)
Returns the Tint with the specified index.

ParameterTypeDescription
indexnumberThe index.

Tint add (baseColor: Color[, withProperties: Object])
Creates a new tint swatch.

ParameterTypeDescription
baseColorColorThe color that the tint is based upon.
withPropertiesObjectInitial values for properties of the new Tint (Optional)

Tint anyItem ()
Returns any Tint in the collection.

number count ()
Displays the number of elements in the Tint.

Array of Tint everyItem ()
Returns every Tint in the collection.

Tint firstItem ()
Returns the first Tint in the collection.

Tint item (index: varies)
Returns the Tint with the specified index or name.

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

Tint itemByID (id: number)
Returns the Tint with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Tint itemByName (name: string)
Returns the Tint with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Tint itemByRange (from: varies, to: varies)
Returns the Tints within the specified range.

ParameterTypeDescription
fromLong Integer
String
Tint
The Tint, index, or name at the beginning of the range. Can accept: Tint, Long Integer or String.
toLong Integer
String
Tint
The Tint, index, or name at the end of the range. Can accept: Tint, Long Integer or String.

Tint lastItem ()
Returns the last Tint in the collection.

Tint middleItem ()
Returns the middle Tint in the collection.

Tint nextItem (obj: Tint)
Returns the Tint whose index follows the specified Tint in the collection.

ParameterTypeDescription
objTintThe Tint whose index comes before the desired Tint.

Tint previousItem (obj: Tint)
Returns the Tint with the index previous to the specified index.

ParameterTypeDescription
objTintThe index of the Tint that follows the desired Tint.

string toSource ()
Generates a string which, if executed, will return the Tint.

Element of

Application.tints

Document.tints

Jongware, 23-Mar-2011 v3.0.3dContents :: Index