Paths

A collection of paths.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

Path [] (index:Number)

Returns the Path with the specified index.

Parameter	Type	Description
index	Number	The index.

Path add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)

Creates a new Path

Parameter	Type	Description
layer	Layer	The layer on which to create the Path. (Optional)
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location at which to insert the Path relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
reference	Document Layer MasterSpread Page Spread PageItem	The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withProperties	Object	Initial 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.

Path everyItem ()

Returns every Path in the collection.

Path firstItem ()

Returns the first Path in the collection.

Path item (index:Varies LongInteger String)

Returns the Path with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

Path itemByRange (from:Varies LongInteger Path String, to:Varies LongInteger Path String)

Returns the Paths within the specified range.

Parameter	Type	Description
from	LongInteger Path String	The Path, index, or name at the beginning of the range. Can accept: Path, Long Integer or String.
to	LongInteger Path String	The Path, index, or name at the end of the range. Can accept: Path, Long Integer or String.

Parameter

Type

Description

from

LongInteger

Path

String

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

LongInteger

Path

String

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