Adobe InDesign CS3 (5.0) Object Model JS: RingStyles

InDesign CS3

Class

RingStyles

 Ring styles

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

RingStyle add (name: string[, withProperties: Object])
Create a new RingStyle

ParameterTypeDescription
namestringThe name property of the new RingStyle
withPropertiesObjectInitial values for properties of the new RingStyle (Optional)

RingStyle anyItem ()
Returns any RingStyle in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objRingStyleThe RingStyle whose index comes before the desired RingStyle.

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

ParameterTypeDescription
objRingStyleThe index of the RingStyle that follows the desired RingStyle.

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

Element of

Application.ringStyles

Document.ringStyles

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