Adobe InDesign CS5 (7.0) Object Model JS: SmartGuidePreference

InDesign CS5

Class

SmartGuidePreference

 Smart Guide preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
SmartGuidePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
alignToObjectCenterbool r/wIf true, smart alignment to object centers is enabled.
alignToObjectEdgesbool r/wIf true, smart alignment to object edges is enabled.
enabledbool r/wIf true, smart guides are enabled.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
guideColor3 Reals (0 - 255)
UIColors
r/wThe 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.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication readonlyThe parent of the SmartGuidePreference (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
smartDimensionsbool r/wIf true, smart dimensions guides are enabled.
smartSpacingbool r/wIf true, smart spacing guides are enabled.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of SmartGuidePreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the SmartGuidePreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.smartGuidePreferences

Return

Array of SmartGuidePreference SmartGuidePreference.getElements ()

Jongware, 20-Jun-2010 v3.0.3dContents :: Index