InDesign Server2025
API 20.5.0.49
Collection of Guide

Guides

A collection of guides.

Properties

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

Methods

→ Guide

Returns the Guide with the specified index.

index Number The index.
→ Guide

Creates a new guide.

layer? Layer The layer on which to create the guide.
withProperties? Object Initial values for properties of the new Guide
→ Guide

Returns any Guide in the collection.

→ Number

Displays the number of elements in the Guide.

→ Guide[]

Returns every Guide in the collection.

→ Guide

Returns the first Guide in the collection.

→ Guide

Returns the Guide with the specified index or name.

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

Returns the Guide with the specified ID.

id Number The ID.
→ Guide

Returns the Guide with the specified name.

name String The name.
→ Guide[]

Returns the Guides within the specified range.

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

Returns the last Guide in the collection.

→ Guide

Returns the middle Guide in the collection.

→ Guide

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

obj Guide The Guide whose index comes before the desired Guide.
→ Guide

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

obj Guide The index of the Guide that follows the desired Guide.
→ String

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

Object of 6

Properties elsewhere that hold a Guides.