Packagecom.adobe.illustrator
Classpublic class Artboard
InheritanceArtboard Inheritance IllustratorHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

An artboard object.



Public Properties
 PropertyDefined By
  artboardRect : Array
Size and position of artboard.
Artboard
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  name : String
The name of the artboard
Artboard
 Inheritedparent : *
[read-only]
IllustratorHostObject
  rulerOrigin : Array
Ruler origin of artboard.It is relative to left-bottom corner of the Artboard.
Artboard
  rulerPAR : Number
Pixel aspect ratio, used in ruler visualization if the units are pixels.
Artboard
  showCenter : Boolean
Show center mark.
Artboard
  showCrossHairs : Boolean
Show cross hairs.
Artboard
  showSafeAreas : Boolean
Show title and action safe areas (for video)
Artboard
Public Methods
 MethodDefined By
 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
 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
  
remove():void
delete the object
Artboard
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 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
artboardRectproperty
artboardRect:Array

Since : CS5

Size and position of artboard.


Implementation
    public function get artboardRect():Array
    public function set artboardRect(value:Array):void
nameproperty 
name:String

Since : CS5.5

The name of the artboard


Implementation
    public function get name():String
    public function set name(value:String):void
rulerOriginproperty 
rulerOrigin:Array

Since : CS5

Ruler origin of artboard.It is relative to left-bottom corner of the Artboard.


Implementation
    public function get rulerOrigin():Array
    public function set rulerOrigin(value:Array):void
rulerPARproperty 
rulerPAR:Number

Since : CS5

Pixel aspect ratio, used in ruler visualization if the units are pixels. ( 0.1 - 10.0 )


Implementation
    public function get rulerPAR():Number
    public function set rulerPAR(value:Number):void
showCenterproperty 
showCenter:Boolean

Since : CS5

Show center mark.


Implementation
    public function get showCenter():Boolean
    public function set showCenter(value:Boolean):void
showCrossHairsproperty 
showCrossHairs:Boolean

Since : CS5

Show cross hairs.


Implementation
    public function get showCrossHairs():Boolean
    public function set showCrossHairs(value:Boolean):void
showSafeAreasproperty 
showSafeAreas:Boolean

Since : CS5

Show title and action safe areas (for video)


Implementation
    public function get showSafeAreas():Boolean
    public function set showSafeAreas(value:Boolean):void
Method Detail
remove()method
public function remove():void

Since : CS5

delete the object