GuidePreference
Guide preferences.
Go to Property Listing | Method Listing
Methods:
addEventListener, getElements, removeEventListener, toSource, toSpecifier
Objects:
Hierarchy:
Superclass: Preference
Class: GuidePreference
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
read/write |
If true, places guides behind all other objects on the spread. |
||
|
read/write |
If true, guides cannot be moved, added, or deleted. |
||
|
read/write |
If true, displays the guides. |
||
|
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. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
readonly |
The parent of the GuidePreference (a Application or Document). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
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. |
|
|
Number (range 5 - 4000) |
read/write |
The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000) |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
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 |
The registered event type. |
|
|
handler |
JavaScriptFunction |
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.
Object of
Application.guidePreferences
Document.guidePreferences
Event.parent
EventListener.parent
MutationEvent.parent