Adobe InCopy CS5.5 (7.5) Object Model JS: GuidePreference

InCopy CS5.5

Class

GuidePreference

 Guide preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
GuidePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
guidesInBackbool r/wIf true, places guides behind all other objects on the spread.
guidesLockedbool r/wIf true, guides cannot be moved, added, or deleted.
guidesShownbool r/wIf true, displays the guides.
guidesSnaptobool r/wIf 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.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplicationDocument readonlyThe parent of the GuidePreference (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
rulerGuidesColor3 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.
rulerGuidesViewThresholdnumber r/wThe magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.guidePreferences

Document.guidePreferences

Return

Array of GuidePreference GuidePreference.getElements ()

Jongware, 29-Apr-2012 v3.0.3iContents :: Index