InDesign2026
API 21.5.1.73
Object

SmartGuidePreference

Smart Guide preferences.

Preference SmartGuidePreference
Hierarchy

Application

SmartGuidePreference

Properties

NameType AccessDescription
Boolean read/write If true, smart alignment to object centers is enabled.
Boolean read/write If true, smart alignment to object edges is enabled.
Boolean read/write If true, smart guides are enabled.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
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.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Application readonly The parent of the SmartGuidePreference (a Application).
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write If true, smart dimensions guides are enabled.
Boolean read/write If true, smart spacing guides are enabled.

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.
SmartGuidePreference[]

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a SmartGuidePreference.

Return 1

Methods that return a SmartGuidePreference.