Guide

A guide.

Properties

Property	Type	Access	Description
allowOverrides	bool	r/w	If true, the master page Guide allows overrides.
fitToPage	bool	r/w	If true, horizontal orientation guides stop at the edges of the specified page. If false, the guides extends across the width of the spread and into the pasteboard area.
guideColor	any	r/w	The color of the guide, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 – 255) or UIColors enumerator.
id	number	readonly	The unique ID of the Guide.
index	number	readonly	The index of the Guide within its containing object.
itemLayer	Layer	r/w	The layer that the Guide is on.
label	string	r/w	A property that can be set to any string.
location	number	r/w	The location at which to place the guide relative to the current ruler zero point.
locked	bool	r/w	If true, the Guide is locked.
orientation	HorizontalOrVertical : HORIZONTAL VERTICAL	r/w	The orientation of the guide.
overridden	bool	readonly	If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem	any	readonly	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parent	any	readonly	The parent of the Guide (a Page, Document, Layer, Spread or MasterSpread).
properties	Object	r/w	A property that allows setting of several properties at the same time.
viewThreshold	number	r/w	The view magnification as a percentage below which guides are no longer displayed. (Range: 5.0 to 4000.0)

Methods

void detach ()
Detaches an overridden master page item from the master page.

Guideduplicate ()
Duplicates the Guide.

string extractLabel (key:
string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of GuidegetElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void move ([to:
Array of number][, by:
Array of number])
Moves the guide to a new location. Note: Either the to or the by parameter is required; if both parameters are defined, only the to value is used.

Parameter	Type	Description
to	Array of number	The new location of the guide, in the format [x, y]. (Optional)
by	Array of number	The amount to move the guide relative to its current position, in the format [x, y]. (Optional)

any override (destinationPage:
Page)
Overrides a master page item and places the item on the document page as a new object.

Parameter	Type	Description
destinationPage	Page	The document page that contains the master page item to override.

void remove ()
Deletes the Guide.

void removeOverride ()
Removes the override from a previously overridden master page item.

void select ([existingSelection:
SelectionOptions=REPLACE_WITH ])
Selects the Guide.

Parameter	Type	Description
existingSelection	SelectionOptions : ADD_TO REMOVE_FROM REPLACE_WITH	The selection status of the Guide in relation to previously selected objects. (Optional) (default: REPLACE_WITH )

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

Guides.previousItem (

obj:
Guide )

Guides.nextItem (

obj:
Guide )

Returned by:

Guide Guide .duplicate (

)

Array of Guide Guide .getElements (

)

Guide Guides.add (
[layer:
Layer][, withProperties:
Object]
)

Guide Guides.anyItem (

)

Array of Guide Guides.everyItem (

)

Guide Guides.firstItem (

)

Guide Guides.item (
index:
any
)

Guide Guides.itemByID (
id:
number
)

Guide Guides.itemByName (
name:
string
)

Array of Guide Guides.itemByRange (
from:
any, to:
any
)

Guide Guides.lastItem (

)

Guide Guides.middleItem (

)

Guide Guides.nextItem (
obj:
Guide
)

Guide Guides.previousItem (
obj:
Guide
)