InDesign Server2025
API 20.5.0.49
Object

GuidePreference

Guide preferences.

Preference GuidePreference
Hierarchy

Application | Document

GuidePreference

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, places guides behind all other objects on the spread.
Boolean read/write If true, guides cannot be moved, added, or deleted.
Boolean read/write If true, displays the guides.
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.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Application | Document readonly The parent of the GuidePreference (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.
3 Reals (0 - 255)[] | UIColors[]
+25 more
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 5–4000 read/write The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
GuidePreference[]

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

Boolean

Removes the event listener.

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.
String

Generates a string which, if executed, will return the GuidePreference.

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a GuidePreference.

Return 1

Methods that return a GuidePreference.