SmartGuidePreference

Smart Guide preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Object, UIColors,

Hierarchy:

Superclass: Preference

Class: SmartGuidePreference

Property Listing

Property

Type

Access

Description

alignToObjectCenter

Boolean

read/write

If true, smart alignment to object centers is enabled.

alignToObjectEdges

Boolean

read/write

If true, smart alignment to object edges is enabled.

enabled

Boolean

read/write

If true, smart guides are enabled.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

guideColor

Array of 3 Reals (0 - 255)

UIColors

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.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Application

readonly

The parent of the SmartGuidePreference (a Application).

properties

Object

read/write

A property that allows setting of several properties at the same time.

smartDimensions

Boolean

read/write

If true, smart dimensions guides are enabled.

smartSpacing

Boolean

read/write

If true, smart spacing guides are enabled.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

SmartGuidePreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.smartGuidePreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

SmartGuidePreference.getElements()