Guides
A collection of guides.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
Guide [] (index:Number)
Returns the Guide with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Guide add (layer:Layer, withProperties:Object)
Creates a new guide.
|
Parameter |
Type |
Description |
|---|---|---|
|
layer |
The layer on which to create the guide. (Optional) |
|
|
withProperties |
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 |
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 |
The ID. |
Guide itemByName (name:String)
Returns the Guide with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
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 |
LongInteger |
The Guide, index, or name at the beginning of the range. Can accept: Guide, Long Integer or String. |
|
to |
LongInteger |
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 |
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 |
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