Packagecom.adobe.indesign
Classpublic class GridPreference
InheritanceGridPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  baselineColor : Object
The color of the baseline grid, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color.
GridPreference
  baselineDivision : Object
The amount of space between baseline grid lines.
GridPreference
  baselineGridRelativeOption : BaselineGridRelativeOption
The zero point for the baseline grid offset.
GridPreference
  baselineGridShown : Boolean
If true, displays the baseline grid.
GridPreference
  baselineStart : Object
The amount to offset the baseline grid from the zero point.
GridPreference
  baselineViewThreshold : Number
The magnification (as a percentage) less than which ruler guides do not appear.
GridPreference
  documentGridShown : Boolean
If true, displays the document grid.
GridPreference
  documentGridSnapto : Boolean
If true, an object snaps to the nearest grid line when the object is created, moved, or resized.
GridPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
GridPreference
  events : Events
[override] [read-only] A collection of events.
GridPreference
  gridColor : Object
The color of the document grid, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color.
GridPreference
  gridsInBack : Boolean
If true, places grids behind all other objects on the spread.
GridPreference
  horizontalGridlineDivision : Object
The amount of space between major horizontal lines in the document grid.
GridPreference
  horizontalGridSubdivision : Number
The number of rows into which to subdivide the space between horizontal document grid lines.
GridPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
GridPreference
  parent : Object
[override] [read-only] The parent of the GridPreference (a Application or Document).
GridPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
GridPreference
  verticalGridlineDivision : Object
The amount of space between major vertical lines in the document grid.
GridPreference
  verticalGridSubdivision : Number
The number of columns into which to subdivide the space between vertical document grid lines.
GridPreference
Public Methods
 MethodDefined By
  
addEventListenerGridPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
GridPreference
 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.
GridPreference
 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
  
removeEventListenerGridPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
GridPreference
 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.
GridPreference
 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
baselineColorproperty
baselineColor:Object

The color of the baseline grid, specified either as an array of three doubles, each in the range 0 to 255, 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 baselineColor():Object
    public function set baselineColor(value:Object):void
baselineDivisionproperty 
baselineDivision:Object

The amount of space between baseline grid lines.


Implementation
    public function get baselineDivision():Object
    public function set baselineDivision(value:Object):void
baselineGridRelativeOptionproperty 
baselineGridRelativeOption:BaselineGridRelativeOption

The zero point for the baseline grid offset.


Implementation
    public function get baselineGridRelativeOption():BaselineGridRelativeOption
    public function set baselineGridRelativeOption(value:BaselineGridRelativeOption):void
baselineGridShownproperty 
baselineGridShown:Boolean

If true, displays the baseline grid.


Implementation
    public function get baselineGridShown():Boolean
    public function set baselineGridShown(value:Boolean):void
baselineStartproperty 
baselineStart:Object

The amount to offset the baseline grid from the zero point.


Implementation
    public function get baselineStart():Object
    public function set baselineStart(value:Object):void
baselineViewThresholdproperty 
baselineViewThreshold:Number

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


Implementation
    public function get baselineViewThreshold():Number
    public function set baselineViewThreshold(value:Number):void
documentGridShownproperty 
documentGridShown:Boolean

If true, displays the document grid.


Implementation
    public function get documentGridShown():Boolean
    public function set documentGridShown(value:Boolean):void
documentGridSnaptoproperty 
documentGridSnapto:Boolean

If true, an object snaps to the nearest grid line when the object is created, moved, or resized.


Implementation
    public function get documentGridSnapto():Boolean
    public function set documentGridSnapto(value:Boolean):void
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
gridColorproperty 
gridColor:Object

The color of the document grid, specified either as an array of three doubles, each in the range 0 to 255, 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 gridColor():Object
    public function set gridColor(value:Object):void
gridsInBackproperty 
gridsInBack:Boolean

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


Implementation
    public function get gridsInBack():Boolean
    public function set gridsInBack(value:Boolean):void
horizontalGridlineDivisionproperty 
horizontalGridlineDivision:Object

The amount of space between major horizontal lines in the document grid.


Implementation
    public function get horizontalGridlineDivision():Object
    public function set horizontalGridlineDivision(value:Object):void
horizontalGridSubdivisionproperty 
horizontalGridSubdivision:Number

The number of rows into which to subdivide the space between horizontal document grid lines.


Implementation
    public function get horizontalGridSubdivision():Number
    public function set horizontalGridSubdivision(value:Number):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 GridPreference (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
verticalGridlineDivisionproperty 
verticalGridlineDivision:Object

The amount of space between major vertical lines in the document grid.


Implementation
    public function get verticalGridlineDivision():Object
    public function set verticalGridlineDivision(value:Object):void
verticalGridSubdivisionproperty 
verticalGridSubdivision:Number

The number of columns into which to subdivide the space between vertical document grid lines.


Implementation
    public function get verticalGridSubdivision():Number
    public function set verticalGridSubdivision(value:Number):void
Method Detail
addEventListenerGridPreference()method
public function addEventListenerGridPreference(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
removeEventListenerGridPreference()method 
public function removeEventListenerGridPreference(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