Packagecom.adobe.illustrator
Classpublic class Documents
InheritanceDocuments Inheritance IllustratorHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

A collection of documents



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] number of elements in the collection
Documents
 Inheritedparent : *
[read-only]
IllustratorHostObject
Public Methods
 MethodDefined By
  
add(documentColorSpace:DocumentColorSpace = null, width:Number = 612.0, height:Number = 792.0, numArtboards:Number = 1, artboardLayout:DocumentArtboardLayout = null, artboardSpacing:Number = 20.0, artboardRowsOrCols:Number = 1):Document
a document
Documents
  
addDocument(startupPreset:String, presetSettings:DocumentPreset):Document
create a document from the preset
Documents
 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
  
getByName(nameParam:String):Document
Get the first element in the collection with the provided name.
Documents
 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
  
index(idx:Number):Document
Get the element in the collection at the provided index.
Documents
 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
 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
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
Documents
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
Documents
Property Detail
lengthproperty
length:Number  [read-only]

Since : CS5

number of elements in the collection


Implementation
    public function get length():Number
Method Detail
add()method
public function add(documentColorSpace:DocumentColorSpace = null, width:Number = 612.0, height:Number = 792.0, numArtboards:Number = 1, artboardLayout:DocumentArtboardLayout = null, artboardSpacing:Number = 20.0, artboardRowsOrCols:Number = 1):Document

Since : CS5

a document

Parameters

documentColorSpace:DocumentColorSpace (default = null) — (com.adobe.illustrator.DocumentColorSpace) the color model used for the document ( default: DocumentColorSpace.CMYK )
 
width:Number (default = 612.0) — (Number) width of the artboard ( default: 612.0 )
 
height:Number (default = 792.0) — (Number) height of the artboard ( default: 792.0 )
 
numArtboards:Number (default = 1) — (Number) number of artboards for new document.Range (1:100). ( default: 1 )
 
artboardLayout:DocumentArtboardLayout (default = null) — (com.adobe.illustrator.DocumentArtboardLayout) layout of artboards for new document ( default: DocumentArtboardLayout.GridByRow )
 
artboardSpacing:Number (default = 20.0) — (Number) spacing between artboards for new document ( default: 20.0 )
 
artboardRowsOrCols:Number (default = 1) — (Number) Number of rows (for rows layout) OR column(for column layouts)of artboards.Range is 1 to (docNumArtboards - 1) or 1 for single row or column layouts ( default: 1 )

Returns
Document
addDocument()method 
public function addDocument(startupPreset:String, presetSettings:DocumentPreset):Document

Since : CS5

create a document from the preset

Parameters

startupPreset:String — (String) the name of startup document preset
 
presetSettings:DocumentPreset — (com.adobe.illustrator.DocumentPreset) the custom document preset settings

Returns
Document
getByName()method 
public function getByName(nameParam:String):Document

Since : CS5

Get the first element in the collection with the provided name.

Parameters

nameParam:String

Returns
Document
index()method 
public function index(idx:Number):Document

Since : CS5

Get the element in the collection at the provided index.

Parameters

idx:Number

Returns
Document
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Since : CS5

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Since : CS5

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*