InDesign Server2025
API 20.5.0.49
Collection of TextPath

TextPaths

A collection of text paths.

Properties

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

Methods

TextPath

Returns the TextPath with the specified index.

index Number The index.
TextPath

Creates a new TextPath.

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

Returns any TextPath in the collection.

Number

Displays the number of elements in the TextPath.

TextPath[]

Returns every TextPath in the collection.

TextPath

Returns the first TextPath in the collection.

TextPath

Returns the TextPath with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
TextPath

Returns the TextPath with the specified ID.

id Number The ID.
TextPath

Returns the TextPath with the specified name.

name String The name.
TextPath[]

Returns the TextPaths within the specified range.

from LongInteger | TextPath | String The TextPath, index, or name at the beginning of the range. Can accept: TextPath, Long Integer or String.
to LongInteger | TextPath | String The TextPath, index, or name at the end of the range. Can accept: TextPath, Long Integer or String.
TextPath

Returns the last TextPath in the collection.

TextPath

Returns the middle TextPath in the collection.

TextPath

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

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

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

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

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

Object of 18

Properties elsewhere that hold a TextPaths.