Adobe InCopy CS5.5 (7.5) Object Model JS: StrokeStyles

InCopy CS5.5

Class

StrokeStyles

 A collection of stroke styles.

See also StrokeStyle.

QuickLinks

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

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

ParameterTypeDescription
indexnumberThe index.

StrokeStyle anyItem ()
Returns any StrokeStyle in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objStrokeStyleThe StrokeStyle whose index comes before the desired StrokeStyle.

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

ParameterTypeDescription
objStrokeStyleThe index of the StrokeStyle that follows the desired StrokeStyle.

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

Element of

Application.strokeStyles

Document.strokeStyles

Jongware, 29-Apr-2012 v3.0.3iContents :: Index