Guides

A collection of guides.

Methods:

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

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Guide [] (index:Number)

Returns the Guide with the specified index.

Parameter

Type

Description

index

Number

The index.

Guide add (layer:Layer, withProperties:Object)

Creates a new guide.

Parameter

Type

Description

layer

Layer

The layer on which to create the guide. (Optional)

withProperties

Object

Initial values for properties of the new Guide (Optional)

Guide anyItem ()

Returns any Guide in the collection.

Number count ()

Displays the number of elements in the Guide.

Guide everyItem ()

Returns every Guide in the collection.

Guide firstItem ()

Returns the first Guide in the collection.

Guide item (index:Varies LongInteger String)

Returns the Guide with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

Guide itemByID (id:Number)

Returns the Guide with the specified ID.

Parameter

Type

Description

id

Number

The ID.

Guide itemByName (name:String)

Returns the Guide with the specified name.

Parameter

Type

Description

name

String

The name.

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

Returns the Guides within the specified range.

Parameter

Type

Description

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 lastItem ()

Returns the last Guide in the collection.

Guide middleItem ()

Returns the middle Guide in the collection.

Guide nextItem (obj:Guide)

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

Parameter

Type

Description

obj

Guide

The Guide whose index comes before the desired Guide.

Guide previousItem (obj:Guide)

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

Parameter

Type

Description

obj

Guide

The index of the Guide that follows the desired Guide.

String toSource ()

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

Object of

Document.guides

Layer.guides

Spread.guides

Page.guides

MasterSpread.guides

Page.masterPageItems