Adobe InDesign CS3 (5.0) Object Model JS: OpacityGradientStops

InDesign CS3

Class

OpacityGradientStops

 A collection of opacity gradient stops.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

OpacityGradientStop add ([withProperties: Object])
Creates a new OpacityGradientStop.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new OpacityGradientStop (Optional)

OpacityGradientStop anyItem ()
Returns any OpacityGradientStop in the collection.

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

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

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

OpacityGradientStop item (index: any)
Returns the OpacityGradientStop with the specified index or name.

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

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

ParameterTypeDescription
namestringThe name.

Array of OpacityGradientStop itemByRange (from: any, to: any)
Returns the OpacityGradientStops within the specified range.

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

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

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

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

ParameterTypeDescription
objOpacityGradientStopThe OpacityGradientStop whose index comes before the desired OpacityGradientStop.

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

ParameterTypeDescription
objOpacityGradientStopThe index of the OpacityGradientStop that follows the desired OpacityGradientStop.

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

Element of

GradientFeatherSetting.opacityGradientStops

Jongware, 27-Jun-2010 v3.0.3dContents :: Index