Packagecom.adobe.indesign
Classpublic class GuidePreference
InheritanceGuidePreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
GuidePreference
  events : Events
[override] [read-only] A collection of events.
GuidePreference
  guidesInBack : Boolean
If true, places guides behind all other objects on the spread.
GuidePreference
  guidesLocked : Boolean
If true, guides cannot be moved, added, or deleted.
GuidePreference
  guidesShown : Boolean
If true, displays the guides.
GuidePreference
  guidesSnapto : Boolean
If true, an object within the specified range snaps to the nearest guide when the object is created, moved, or resized.
GuidePreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
GuidePreference
  parent : Object
[override] [read-only] The parent of the GuidePreference (a Application or Document).
GuidePreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
GuidePreference
  rulerGuidesColor : Object
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.
GuidePreference
  rulerGuidesViewThreshold : Number
The magnification (as a percentage) less than which ruler guides do not appear.
GuidePreference
Public Methods
 MethodDefined By
  
addEventListenerGuidePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
GuidePreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
GuidePreference
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerGuidePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
GuidePreference
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
GuidePreference
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
eventListenersproperty
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
guidesInBackproperty 
guidesInBack:Boolean

If true, places guides behind all other objects on the spread.


Implementation
    public function get guidesInBack():Boolean
    public function set guidesInBack(value:Boolean):void
guidesLockedproperty 
guidesLocked:Boolean

If true, guides cannot be moved, added, or deleted.


Implementation
    public function get guidesLocked():Boolean
    public function set guidesLocked(value:Boolean):void
guidesShownproperty 
guidesShown:Boolean

If true, displays the guides.


Implementation
    public function get guidesShown():Boolean
    public function set guidesShown(value:Boolean):void
guidesSnaptoproperty 
guidesSnapto:Boolean

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.


Implementation
    public function get guidesSnapto():Boolean
    public function set guidesSnapto(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Object  [read-only] [override]

The parent of the GuidePreference (a Application or Document).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rulerGuidesColorproperty 
rulerGuidesColor:Object

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.


Implementation
    public function get rulerGuidesColor():Object
    public function set rulerGuidesColor(value:Object):void
rulerGuidesViewThresholdproperty 
rulerGuidesViewThreshold:Number

The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)


Implementation
    public function get rulerGuidesViewThreshold():Number
    public function set rulerGuidesViewThreshold(value:Number):void
Method Detail
addEventListenerGuidePreference()method
public function addEventListenerGuidePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerGuidePreference()method 
public function removeEventListenerGuidePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String