InDesign2026
API 21.5.1.73
Collection of Path

Paths

A collection of paths.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

Path

Returns the Path with the specified index.

index Number The index.
Path

Creates a new Path.

withProperties? Object Initial values for properties of the new Path
Path

Returns any Path in the collection.

Number

Displays the number of elements in the Path.

Path[]

Returns every Path in the collection.

Path

Returns the first Path in the collection.

Path

Returns the Path with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
Path[]

Returns the Paths within the specified range.

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.
Path

Returns the last Path in the collection.

Path

Returns the middle Path in the collection.

Path

Returns the Path whose index follows the specified Path in the collection.

obj Path The Path whose index comes before the desired Path.
Path

Returns the Path with the index previous to the specified index.

obj Path The index of the Path that follows the desired Path.
String

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

Object of 15

Properties elsewhere that hold a Paths.