K4 InDesign Javascript API Documentation

PreferencesGuidePreference

Guide preferences.

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
guidesInBack bool If true, places guides behind all other objects on the spread. read-write
guidesLocked bool If true, guides cannot be moved, added, or deleted. read-write
guidesShown bool If true, displays the guides. read-write
guidesSnapto bool 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. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the GuidePreference (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
rulerGuidesColor 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
rulerGuidesViewThreshold number The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000) read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → GuidePreference
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(
)
  → GuidePreference
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 GuidePreference.
toSpecifier(
)
  → string
Retrieves the object specifier.