Adobe InDesign CS5 (7.0) Object Model JS: Paths

InDesign CS5

Class

Paths

 A collection of paths.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

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

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

Path anyItem ()
Returns any Path in the collection.

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

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

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

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

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

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

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

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

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

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

ParameterTypeDescription
objPathThe Path whose index comes before the desired Path.

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

ParameterTypeDescription
objPathThe index of the Path that follows the desired Path.

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

Element of

Button.paths

ClippingPathSettings.paths

GraphicLine.paths

MediaItem.paths

Movie.paths

MultiStateObject.paths

Oval.paths

Polygon.paths

Rectangle.paths

Sound.paths

SplineItem.paths

TextFrame.paths

TextWrapPreference.paths

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