Class
GuidePreference |
| | Guide preferences. Base Class: Preference |
QuickLinks |
addEventListener, getElements, removeEventListener, toSource, toSpecifier |
Hierarchy
|
|
Properties
| | Property | Type | Access | Description |
|---|
| eventListeners | EventListeners |
readonly | A collection of event listeners. |
| events | Events |
readonly | A collection of events. |
| guidesInBack | bool |
r/w | If true, places guides behind all other objects on the spread. |
| guidesLocked | bool |
r/w | If true, guides cannot be moved, added, or deleted. |
| guidesShown | bool |
r/w | If true, displays the guides. |
| guidesSnapto | bool |
r/w | 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 | bool |
readonly | Returns true if the object specifier resolves to valid objects. |
| parent | ApplicationDocument |
readonly | The parent of the GuidePreference (a Application or Document). |
| properties | Object |
r/w | A property that allows setting of several properties at the same time. |
| rulerGuidesColor | 3 Reals (0 - 255)
UIColors |
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. |
| rulerGuidesViewThreshold | number |
r/w | The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000) |
|
Methods
| InstancesEventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|
| eventType | string | The event type. |
| handler | File
JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of GuidePreference getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|
| eventType | string | The registered event type. |
| handler | File
JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | 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.
|
Element of |
Application.guidePreferences
Document.guidePreferences
|
Return |
Array
of GuidePreference GuidePreference.getElements ()
|