Packagecom.adobe.indesign
Classpublic class Guide
InheritanceGuide Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  AFTER_PLACE : String
[static] [read-only] Dispatched after a Guide is placed.
Guide
  allowOverrides : Boolean
If true, the master page item can be overridden.
Guide
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Guide
  events : Events
[read-only] A collection of events.
Guide
  fitToPage : Boolean
If true, horizontal orientation guides stop at the edges of the specified page.
Guide
  guideColor : 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.
Guide
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the Guide.
Guide
  index : Number
[read-only] The index of the Guide within its containing object.
Guide
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Guide
  itemLayer : Layer
The layer that the Guide is on.
Guide
  label : String
A property that can be set to any string.
Guide
  location : Object
The location at which to place the guide relative to the current ruler zero point.
Guide
  locked : Boolean
If true, the Guide is locked.
Guide
  name : String
The name of the Guide; this is an alias to the Guide's label property.
Guide
  orientation : HorizontalOrVertical
The orientation of the guide.
Guide
  overridden : Boolean
[read-only] If true, the object originated on a master spread and was overridden.
Guide
  overriddenMasterPageItem : Object
[read-only] An object that originated on a master page and has been overridden.
Guide
  parent : Object
[read-only] The parent of the Guide (a Spread or MasterSpread).
Guide
  parentPage : Page
[read-only] The page on which this page item appears.
Guide
  properties : Object
A property that allows setting of several properties at the same time.
Guide
  viewThreshold : Number
The view magnification as a percentage below which guides are no longer displayed.
Guide
Public Methods
 MethodDefined By
  
addEventListenerGuide(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Guide
  
detach():void
Detaches an overridden master page item from the master page.
Guide
  
Duplicates the Guide.
Guide
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Guide
 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
Resolves the object specifier, creating an array of object references.
Guide
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Guide
 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
  
move(toParam:Array = null, byParam:Array = null):void
Moves the guide to a new location.
Guide
  
override(destinationPageParam:Page = null):Object
Overrides a master page item and places the item on the document page as a new object.
Guide
  
remove():void
Deletes the Guide.
Guide
  
removeEventListenerGuide(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Guide
  
Removes the override from a previously overridden master page item.
Guide
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
select(existingSelectionParam:SelectionOptions = null):void
Selects the object.
Guide
  
toSpecifier():String
Retrieves the object specifier.
Guide
 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
AFTER_PLACEproperty
AFTER_PLACE:String  [read-only]

Dispatched after a Guide is placed. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_PLACE():String
allowOverridesproperty 
allowOverrides:Boolean

If true, the master page item can be overridden.


Implementation
    public function get allowOverrides():Boolean
    public function set allowOverrides(value:Boolean):void
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
fitToPageproperty 
fitToPage:Boolean

If true, horizontal orientation guides stop at the edges of the specified page. If false, the guides extends across the width of the spread and into the pasteboard area.


Implementation
    public function get fitToPage():Boolean
    public function set fitToPage(value:Boolean):void
guideColorproperty 
guideColor: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 guideColor():Object
    public function set guideColor(value:Object):void
idproperty 
id:Number  [read-only]

The unique ID of the Guide.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the Guide within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
itemLayerproperty 
itemLayer:Layer

The layer that the Guide is on.


Implementation
    public function get itemLayer():Layer
    public function set itemLayer(value:Layer):void
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
locationproperty 
location:Object

The location at which to place the guide relative to the current ruler zero point.


Implementation
    public function get location():Object
    public function set location(value:Object):void
lockedproperty 
locked:Boolean

If true, the Guide is locked.


Implementation
    public function get locked():Boolean
    public function set locked(value:Boolean):void
nameproperty 
name:String

The name of the Guide; this is an alias to the Guide's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
orientationproperty 
orientation:HorizontalOrVertical

The orientation of the guide.


Implementation
    public function get orientation():HorizontalOrVertical
    public function set orientation(value:HorizontalOrVertical):void
overriddenproperty 
overridden:Boolean  [read-only]

If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.


Implementation
    public function get overridden():Boolean
overriddenMasterPageItemproperty 
overriddenMasterPageItem:Object  [read-only]

An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.


Implementation
    public function get overriddenMasterPageItem():Object
parentproperty 
parent:Object  [read-only]

The parent of the Guide (a Spread or MasterSpread).


Implementation
    public function get parent():Object
parentPageproperty 
parentPage:Page  [read-only]

The page on which this page item appears.


Implementation
    public function get parentPage():Page
propertiesproperty 
properties:Object

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
viewThresholdproperty 
viewThreshold:Number

The view magnification as a percentage below which guides are no longer displayed. (Range: 5.0 to 4000.0)


Implementation
    public function get viewThreshold():Number
    public function set viewThreshold(value:Number):void
Method Detail
addEventListenerGuide()method
public function addEventListenerGuide(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
detach()method 
public function detach():void

Detaches an overridden master page item from the master page.

duplicate()method 
public function duplicate():Guide

Duplicates the Guide.

Returns
Guide
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

move()method 
public function move(toParam:Array = null, byParam:Array = null):void

Moves the guide to a new location. Note: Either the to or the by parameter is required; if both parameters are defined, only the to value is used.

Parameters

toParam:Array (default = null) — (Array) The new location of the guide, in the format [x, y]. (Optional)
 
byParam:Array (default = null) — (Array) The amount to move the guide relative to its current position, in the format [x, y]. (Optional)

override()method 
public function override(destinationPageParam:Page = null):Object

Overrides a master page item and places the item on the document page as a new object.

Parameters

destinationPageParam:Page (default = null) — (Page) The document page that contains the master page item to override.

Returns
Object
remove()method 
public function remove():void

Deletes the Guide.

removeEventListenerGuide()method 
public function removeEventListenerGuide(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
removeOverride()method 
public function removeOverride():void

Removes the override from a previously overridden master page item.

select()method 
public function select(existingSelectionParam:SelectionOptions = null):void

Selects the object.

Parameters

existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the Guide in relation to previously selected objects. (Optional)

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String