K4 InDesign Javascript API Documentation

PreferencesSmartGuidePreference

Smart Guide preferences.

Extends

Instance Properties

Name Description Access
alignToObjectCenter bool If true, smart alignment to object centers is enabled. read-write
alignToObjectEdges bool If true, smart alignment to object edges is enabled. read-write
enabled bool If true, smart guides are enabled. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
guideColor 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. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent Application The parent of the SmartGuidePreference (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
smartDimensions bool If true, smart dimensions guides are enabled. read-write
smartSpacing bool If true, smart spacing guides are enabled. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → SmartGuidePreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → SmartGuidePreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the SmartGuidePreference.
toSpecifier(
)
  → string
Retrieves the object specifier.