A collection of guides.
Methods
Guideadd ([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) |
GuideanyItem ()
Returns any Guide in the collection.
number count ()
Displays the number of elements in the Guide.
Array of GuideeveryItem ()
Returns every Guide in the collection.
GuidefirstItem ()
Returns the first Guide in the collection.
Guideitem (index:
any)
Returns the Guide with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
GuideitemByID (id:
number)
Returns the Guide with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
GuideitemByName (name:
string)
Returns the Guide with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of GuideitemByRange (from:
any, to:
any)
Returns the Guides within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Guide Long Integer String |
The Guide, index, or name at the beginning of the range. Can accept: Guide, Long Integer or String. |
| to | Guide Long Integer String |
The Guide, index, or name at the end of the range. Can accept: Guide, Long Integer or String. |
GuidelastItem ()
Returns the last Guide in the collection.
GuidemiddleItem ()
Returns the middle Guide in the collection.
GuidenextItem (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. |
GuidepreviousItem (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.
Element of:
Document.guides
Layer.guides
MasterSpread.guides
Page.guides
Spread.guides