Guide preferences.
Go to Property Listing | Method Listing
toSource, getElements, toSpecifier, addEventListener, removeEventListener
Application, Boolean, Document, EventListeners, Events, Number, Object, UIColors,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
guidesInBack |
read/write |
If true, places guides behind all other objects on the spread. |
|
|
guidesLocked |
read/write |
If true, guides cannot be moved, added, or deleted. |
|
|
guidesShown |
read/write |
If true, displays the guides. |
|
|
guidesSnapto |
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 |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
parent |
readonly |
The parent of the GuidePreference (a Application or Document). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
rulerGuidesColor |
Array of 3 Reals (0 - 255) |
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, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
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, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the GuidePreference.
String toSpecifier ()
Retrieves the object specifier.
Application.guidePreferences
Document.guidePreferences
Event.parent
EventListener.parent
MutationEvent.parent