GuidePreference

Methods:

Class: GuidePreference

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
guidesInBack	Boolean	read/write	If true, places guides behind all other objects on the spread.
guidesLocked	Boolean	read/write	If true, guides cannot be moved, added, or deleted.
guidesShown	Boolean	read/write	If true, displays the guides.
guidesSnapto	Boolean	read/write	If true, an object within the specified range snaps to the nearest guide when the object is created, moved, or resized. For range information, see guide snapto zone.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
parent	Application Document	readonly	The parent of the GuidePreference (a Application or Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
rulerGuidesColor	Array of 3 Reals (0 - 255) UIColors	read/write	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.
rulerGuidesViewThreshold	Number (range 5 - 4000)	read/write	The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

The event type.

handler

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

This parameter is obsolete. (Optional)

(default: false)

GuidePreference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)