Package | com.adobe.illustrator |
Class | public class Document |
Inheritance | Document ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
activeDataSet : DataSet
The active data set. | Document | ||
activeLayer : Layer
The active layer. | Document | ||
activeView : View [read-only]
The document's current view. | Document | ||
artboards : Artboards [read-only]
All artboards in the document. | Document | ||
brushes : Brushes [read-only]
The brushes defined in this document. | Document | ||
characterStyles : CharacterStyles [read-only]
The list of character styles in this document. | Document | ||
compoundPathItems : CompoundPathItems [read-only]
The compound path artwork in this collection. | Document | ||
cropBox : Array | Document | ||
cropStyle : CropOptions | Document | ||
dataSets : DataSets [read-only]
The data sets defined in this document. | Document | ||
defaultFillColor : Color
Default fill color. | Document | ||
defaultFilled : Boolean
Should a new path be filled?
| Document | ||
defaultFillOverprint : Boolean
Will art beneath a filled object be overprinted by default?
| Document | ||
defaultStrokeCap : StrokeCap
Default type of line capping. | Document | ||
defaultStrokeColor : Color
Default stroke color. | Document | ||
defaultStroked : Boolean
Should a new path be stroked?
| Document | ||
defaultStrokeDashes : Array
Default dash lengths (set to {} for a solid line)
| Document | ||
defaultStrokeDashOffset : Number
The default distance into the dash pattern at which the pattern should be started. | Document | ||
defaultStrokeJoin : StrokeJoin
Default type of joints. | Document | ||
defaultStrokeMiterLimit : Number
Specifies whether a join is mitered (pointed) or beveled (squared-off) by default. | Document | ||
defaultStrokeOverprint : Boolean
Will art beneath a stroked object be overprinted by default?
| Document | ||
defaultStrokeWidth : Number
Default width of stroke. | Document | ||
documentColorSpace : DocumentColorSpace [read-only]
The color space used for the document. | Document | ||
fullName : File [read-only]
The file associated with the document. | Document | ||
geometricBounds : Array [read-only]
The bounds of the illustration excluding stroke width. | Document | ||
gradients : Gradients [read-only]
The gradients available in this document. | Document | ||
graphicStyles : GraphicStyles [read-only]
The graphic styles defined in this document. | Document | ||
graphItems : GraphItems [read-only]
The graph art items in this document. | Document | ||
groupItems : GroupItems [read-only]
The group items in this document. | Document | ||
height : Number [read-only]
| Document | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
inkList : Object [read-only]
The list of inks in this document. | Document | ||
kinsokuSet : Object [read-only]
The Kinsoku set. | Document | ||
layers : Layers [read-only]
The layers in this document. | Document | ||
legacyTextItems : LegacyTextItems [read-only]
The text frame items in this story. | Document | ||
meshItems : MeshItems [read-only]
The mesh art items in this document. | Document | ||
mojikumiSet : Object [read-only]
The Mojikumi set. | Document | ||
name : String [read-only]
The document's name. | Document | ||
nonNativeItems : NonNativeItems [read-only]
The non-native art items in this document. | Document | ||
outputResolution : Number [read-only]
| Document | ||
pageItems : PageItems [read-only]
All the artwork in this document. | Document | ||
pageOrigin : Array | Document | ||
paragraphStyles : ParagraphStyles [read-only]
The list of paragraph styles in this document. | Document | ||
![]() | parent : * [read-only] | IllustratorHostObject | |
path : File [read-only]
Path specification for the document. | Document | ||
pathItems : PathItems [read-only]
The path artwork in this document. | Document | ||
patterns : Patterns [read-only]
The patterns available in this document. | Document | ||
placedItems : PlacedItems [read-only]
The placed art items in this document. | Document | ||
pluginItems : PluginItems [read-only]
The plugin art items in this document. | Document | ||
printTiles : Boolean [read-only]
| Document | ||
rasterEffectSettings : RasterEffectOptions
The document raster effects settings. | Document | ||
rasterItems : RasterItems [read-only]
The raster art items in this document. | Document | ||
rulerOrigin : Array | Document | ||
rulerUnits : RulerUnits [read-only]
| Document | ||
saved : Boolean
Has the document been saved?
| Document | ||
selection : Object
The selection within the document. | Document | ||
showPlacedImages : Boolean [read-only]
| Document | ||
splitLongPaths : Boolean [read-only]
| Document | ||
spots : Spots [read-only]
The custom spot colors available in this document. | Document | ||
stationery : Boolean [read-only]
Is the file a stationery file?
| Document | ||
stories : Stories [read-only]
The story items in this document. | Document | ||
swatches : Swatches [read-only]
The swatches in this document. | Document | ||
swatchGroups : SwatchGroups [read-only]
The Swatch Groups in this document. | Document | ||
symbolItems : SymbolItems [read-only]
The symbol items in this document. | Document | ||
symbols : Symbols [read-only]
The symbols defined in this document. | Document | ||
tags : Tags [read-only]
The tags in this document. | Document | ||
textFrames : TextFrames [read-only]
The text frame items in this document. | Document | ||
tileFullPages : Boolean [read-only]
| Document | ||
useDefaultScreen : Boolean [read-only]
| Document | ||
variables : Variables [read-only]
The variables defined in this document. | Document | ||
variablesLocked : Boolean
The locked variables. | Document | ||
views : Views [read-only]
The views in this document. | Document | ||
visibleBounds : Array [read-only]
The visible bounds of the illustration including stroke width. | Document | ||
width : Number [read-only]
| Document | ||
XMPString : String
The XMP packet string associated with the document. | Document |
Method | Defined By | ||
---|---|---|---|
activate():void
Activate the first window associated with the document. | Document | ||
close(saving:SaveOptions = null):void
Close the specified document(s)
| Document | ||
Converts the coordinate system of a single point from one coordinate system to another. | Document | ||
exportFile(exportFile:File, exportFormat:ExportType, options:Object = null):void
Export the specified document(s)
| Document | ||
exportPDFPreset(file:File):void
Save all PDF presets to a file. | Document | ||
exportPerspectiveGridPreset(file:File):void
saves all perspective grid presets to a file
| Document | ||
exportPrintPreset(file:File):void
Export the current print setting to the preset file. | Document | ||
exportVariables(file:File):void
Save datasets into an XML library. | Document | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
fitArtboardToSelectedArt(index:Number):Boolean
Change the artboard to selected art bounds. | Document | ||
![]() | 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 | |
Gets the active plane of the active perspective grid of the document
| Document | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
hidePerspectiveGrid():Boolean
Hides the current active perspective grid for the document, if there is visible perspective grid. | Document | ||
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
imageCapture(imageFile:File, clipBounds:Array = null, options:ImageCaptureOptions = null):void
Capture the artwork content inside the clip bound as raster image, and write out the captured image data into the target image file. | Document | ||
importCharacterStyles(fileSpec:File):void
Load the character styles from the Illustrator file. | Document | ||
importParagraphStyles(fileSpec:File):void
Load the paragraph styles from the Illustrator file. | Document | ||
importPDFPreset(fileSpec:File, replacingPreset:Boolean = false):void
Load all PDF presets from a file. | Document | ||
importPerspectiveGridPreset(fileSpec:File, perspectivePreset:String):void
loads mentioned perspective grid preset, if preset name is specified, else loads all(if no preset name is specified) presets, from the specified file
| Document | ||
importPrintPreset(printPreset:String, fileSpec:File):void
Apply the named print preset from the file to the current print setting. | Document | ||
importVariables(fileSpec:File):void
Import a library containing datasets, variables and their associated dynamic data. | Document | ||
![]() | 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 | |
print(options:PrintOptions = null):void
Print the document. | Document | ||
Rasterize the source art(s) within the specified clip bounds. | Document | ||
rearrangeArtboards(artboardLayout:DocumentArtboardLayout = null, artboardRowsOrCols:Number = 1, artboardSpacing:Number = 20.0, artboardMoveArtwork:Boolean = true):Boolean
Rearrange Artboards in the document
| Document | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
save():void
Save the document. | Document | ||
saveAs(saveIn:File, options:Object = null):void
Save the document with specific save options. | Document | ||
selectObjectsOnActiveArtboard():Boolean
Select art objects in active artboard. | Document | ||
selectPerspectivePreset(perspectivePreset:String):Boolean
Selects a predefined preset to define grid for the current document. | Document | ||
setPerspectiveActivePlane(perspectiveGridPlane:PerspectiveGridPlaneType):Boolean
Sets the active perspective plane for the active grid of the document. | Document | ||
showPerspectiveGrid():Boolean
Shows the current active perspective grid for the document, if no active perspective grid then shows the default perspective grid for the document
| Document | ||
windowCapture(imageFile:File, windowSize:Array):void
Capture the current document window to the target TIFF image file. | Document | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
activeDataSet | property |
activeDataSet:DataSet
Since : | CS5 |
The active data set.
public function get activeDataSet():DataSet
public function set activeDataSet(value:DataSet):void
activeLayer | property |
activeLayer:Layer
Since : | CS5 |
The active layer.
public function get activeLayer():Layer
public function set activeLayer(value:Layer):void
activeView | property |
activeView:View
[read-only] Since : | CS5 |
The document's current view.
public function get activeView():View
artboards | property |
artboards:Artboards
[read-only] Since : | CS5 |
All artboards in the document.
public function get artboards():Artboards
brushes | property |
brushes:Brushes
[read-only] Since : | CS5 |
The brushes defined in this document.
public function get brushes():Brushes
characterStyles | property |
characterStyles:CharacterStyles
[read-only] Since : | CS5 |
The list of character styles in this document.
public function get characterStyles():CharacterStyles
compoundPathItems | property |
compoundPathItems:CompoundPathItems
[read-only] Since : | CS5 |
The compound path artwork in this collection.
public function get compoundPathItems():CompoundPathItems
cropBox | property |
cropBox:Array
Since : | CS5 |
public function get cropBox():Array
public function set cropBox(value:Array):void
cropStyle | property |
cropStyle:CropOptions
Since : | CS5 |
public function get cropStyle():CropOptions
public function set cropStyle(value:CropOptions):void
dataSets | property |
dataSets:DataSets
[read-only] Since : | CS5 |
The data sets defined in this document.
public function get dataSets():DataSets
defaultFillColor | property |
defaultFillColor:Color
Since : | CS5 |
Default fill color.
public function get defaultFillColor():Color
public function set defaultFillColor(value:Color):void
defaultFilled | property |
defaultFilled:Boolean
Since : | CS5 |
Should a new path be filled?
public function get defaultFilled():Boolean
public function set defaultFilled(value:Boolean):void
defaultFillOverprint | property |
defaultFillOverprint:Boolean
Since : | CS5 |
Will art beneath a filled object be overprinted by default?
public function get defaultFillOverprint():Boolean
public function set defaultFillOverprint(value:Boolean):void
defaultStrokeCap | property |
defaultStrokeCap:StrokeCap
Since : | CS5 |
Default type of line capping.
public function get defaultStrokeCap():StrokeCap
public function set defaultStrokeCap(value:StrokeCap):void
defaultStrokeColor | property |
defaultStrokeColor:Color
Since : | CS5 |
Default stroke color.
public function get defaultStrokeColor():Color
public function set defaultStrokeColor(value:Color):void
defaultStroked | property |
defaultStroked:Boolean
Since : | CS5 |
Should a new path be stroked?
public function get defaultStroked():Boolean
public function set defaultStroked(value:Boolean):void
defaultStrokeDashes | property |
defaultStrokeDashes:Array
Since : | CS5 |
Default dash lengths (set to {} for a solid line)
public function get defaultStrokeDashes():Array
public function set defaultStrokeDashes(value:Array):void
defaultStrokeDashOffset | property |
defaultStrokeDashOffset:Number
Since : | CS5 |
The default distance into the dash pattern at which the pattern should be started.
public function get defaultStrokeDashOffset():Number
public function set defaultStrokeDashOffset(value:Number):void
defaultStrokeJoin | property |
defaultStrokeJoin:StrokeJoin
Since : | CS5 |
Default type of joints.
public function get defaultStrokeJoin():StrokeJoin
public function set defaultStrokeJoin(value:StrokeJoin):void
defaultStrokeMiterLimit | property |
defaultStrokeMiterLimit:Number
Since : | CS5 |
Specifies whether a join is mitered (pointed) or beveled (squared-off) by default.
public function get defaultStrokeMiterLimit():Number
public function set defaultStrokeMiterLimit(value:Number):void
defaultStrokeOverprint | property |
defaultStrokeOverprint:Boolean
Since : | CS5 |
Will art beneath a stroked object be overprinted by default?
public function get defaultStrokeOverprint():Boolean
public function set defaultStrokeOverprint(value:Boolean):void
defaultStrokeWidth | property |
defaultStrokeWidth:Number
Since : | CS5 |
Default width of stroke.
public function get defaultStrokeWidth():Number
public function set defaultStrokeWidth(value:Number):void
documentColorSpace | property |
documentColorSpace:DocumentColorSpace
[read-only] Since : | CS5 |
The color space used for the document.
public function get documentColorSpace():DocumentColorSpace
fullName | property |
fullName:File
[read-only] Since : | CS5 |
The file associated with the document.
public function get fullName():File
geometricBounds | property |
geometricBounds:Array
[read-only] Since : | CS5 |
The bounds of the illustration excluding stroke width.
public function get geometricBounds():Array
gradients | property |
gradients:Gradients
[read-only] Since : | CS5 |
The gradients available in this document.
public function get gradients():Gradients
graphicStyles | property |
graphicStyles:GraphicStyles
[read-only] Since : | CS5 |
The graphic styles defined in this document.
public function get graphicStyles():GraphicStyles
graphItems | property |
graphItems:GraphItems
[read-only] Since : | CS5 |
The graph art items in this document.
public function get graphItems():GraphItems
groupItems | property |
groupItems:GroupItems
[read-only] Since : | CS5 |
The group items in this document.
public function get groupItems():GroupItems
height | property |
height:Number
[read-only] Since : | CS5 |
public function get height():Number
inkList | property |
inkList:Object
[read-only] Since : | CS5 |
The list of inks in this document.
public function get inkList():Object
kinsokuSet | property |
kinsokuSet:Object
[read-only] Since : | CS5 |
The Kinsoku set.
public function get kinsokuSet():Object
layers | property |
layers:Layers
[read-only] Since : | CS5 |
The layers in this document.
public function get layers():Layers
legacyTextItems | property |
legacyTextItems:LegacyTextItems
[read-only] Since : | CS5 |
The text frame items in this story.
public function get legacyTextItems():LegacyTextItems
meshItems | property |
meshItems:MeshItems
[read-only] Since : | CS5 |
The mesh art items in this document.
public function get meshItems():MeshItems
mojikumiSet | property |
mojikumiSet:Object
[read-only] Since : | CS5 |
The Mojikumi set.
public function get mojikumiSet():Object
name | property |
name:String
[read-only] Since : | CS5 |
The document's name.
public function get name():String
nonNativeItems | property |
nonNativeItems:NonNativeItems
[read-only] Since : | CS5 |
The non-native art items in this document.
public function get nonNativeItems():NonNativeItems
outputResolution | property |
outputResolution:Number
[read-only] Since : | CS5 |
public function get outputResolution():Number
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
All the artwork in this document.
public function get pageItems():PageItems
pageOrigin | property |
pageOrigin:Array
Since : | CS5 |
public function get pageOrigin():Array
public function set pageOrigin(value:Array):void
paragraphStyles | property |
paragraphStyles:ParagraphStyles
[read-only] Since : | CS5 |
The list of paragraph styles in this document.
public function get paragraphStyles():ParagraphStyles
path | property |
path:File
[read-only] Since : | CS5 |
Path specification for the document.
public function get path():File
pathItems | property |
pathItems:PathItems
[read-only] Since : | CS5 |
The path artwork in this document.
public function get pathItems():PathItems
patterns | property |
patterns:Patterns
[read-only] Since : | CS5 |
The patterns available in this document.
public function get patterns():Patterns
placedItems | property |
placedItems:PlacedItems
[read-only] Since : | CS5 |
The placed art items in this document.
public function get placedItems():PlacedItems
pluginItems | property |
pluginItems:PluginItems
[read-only] Since : | CS5 |
The plugin art items in this document.
public function get pluginItems():PluginItems
printTiles | property |
printTiles:Boolean
[read-only] Since : | CS5 |
public function get printTiles():Boolean
rasterEffectSettings | property |
rasterEffectSettings:RasterEffectOptions
Since : | CS5 |
The document raster effects settings.
public function get rasterEffectSettings():RasterEffectOptions
public function set rasterEffectSettings(value:RasterEffectOptions):void
rasterItems | property |
rasterItems:RasterItems
[read-only] Since : | CS5 |
The raster art items in this document.
public function get rasterItems():RasterItems
rulerOrigin | property |
rulerOrigin:Array
Since : | CS5 |
public function get rulerOrigin():Array
public function set rulerOrigin(value:Array):void
rulerUnits | property |
rulerUnits:RulerUnits
[read-only] Since : | CS5 |
public function get rulerUnits():RulerUnits
saved | property |
saved:Boolean
Since : | CS5 |
Has the document been saved?
public function get saved():Boolean
public function set saved(value:Boolean):void
selection | property |
selection:Object
Since : | CS5 |
The selection within the document.
public function get selection():Object
public function set selection(value:Object):void
showPlacedImages | property |
showPlacedImages:Boolean
[read-only] Since : | CS5 |
public function get showPlacedImages():Boolean
splitLongPaths | property |
splitLongPaths:Boolean
[read-only] Since : | CS5 |
public function get splitLongPaths():Boolean
spots | property |
spots:Spots
[read-only] Since : | CS5 |
The custom spot colors available in this document.
public function get spots():Spots
stationery | property |
stationery:Boolean
[read-only] Since : | CS5 |
Is the file a stationery file?
public function get stationery():Boolean
stories | property |
stories:Stories
[read-only] Since : | CS5 |
The story items in this document.
public function get stories():Stories
swatches | property |
swatches:Swatches
[read-only] Since : | CS5 |
The swatches in this document.
public function get swatches():Swatches
swatchGroups | property |
swatchGroups:SwatchGroups
[read-only] Since : | CS5 |
The Swatch Groups in this document.
public function get swatchGroups():SwatchGroups
symbolItems | property |
symbolItems:SymbolItems
[read-only] Since : | CS5 |
The symbol items in this document.
public function get symbolItems():SymbolItems
symbols | property |
symbols:Symbols
[read-only] Since : | CS5 |
The symbols defined in this document.
public function get symbols():Symbols
tags | property |
tags:Tags
[read-only] Since : | CS5 |
The tags in this document.
public function get tags():Tags
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
The text frame items in this document.
public function get textFrames():TextFrames
tileFullPages | property |
tileFullPages:Boolean
[read-only] Since : | CS5 |
public function get tileFullPages():Boolean
useDefaultScreen | property |
useDefaultScreen:Boolean
[read-only] Since : | CS5 |
public function get useDefaultScreen():Boolean
variables | property |
variables:Variables
[read-only] Since : | CS5 |
The variables defined in this document.
public function get variables():Variables
variablesLocked | property |
variablesLocked:Boolean
Since : | CS5 |
The locked variables.
public function get variablesLocked():Boolean
public function set variablesLocked(value:Boolean):void
views | property |
views:Views
[read-only] Since : | CS5 |
The views in this document.
public function get views():Views
visibleBounds | property |
visibleBounds:Array
[read-only] Since : | CS5 |
The visible bounds of the illustration including stroke width.
public function get visibleBounds():Array
width | property |
width:Number
[read-only] Since : | CS5 |
public function get width():Number
XMPString | property |
XMPString:String
Since : | CS5 |
The XMP packet string associated with the document.
public function get XMPString():String
public function set XMPString(value:String):void
activate | () | method |
public function activate():void
Since : | CS5 |
Activate the first window associated with the document.
close | () | method |
public function close(saving:SaveOptions = null):void
Since : | CS5 |
Close the specified document(s)
Parameters
saving:SaveOptions (default = null ) — (com.adobe.illustrator.SaveOptions) Specifies whether changes should be saved before closing.
|
convertCoordinate | () | method |
public function convertCoordinate(coordinate:Array, source:CoordinateSystem, destination:CoordinateSystem):Array
Since : | CS5 |
Converts the coordinate system of a single point from one coordinate system to another.
Parameters
coordinate:Array — (Array) The Coordinate to convert.
| |
source:CoordinateSystem — (com.adobe.illustrator.CoordinateSystem) The source coordinate system.
| |
destination:CoordinateSystem — (com.adobe.illustrator.CoordinateSystem) The destination coordinate system.
|
Array |
exportFile | () | method |
public function exportFile(exportFile:File, exportFormat:ExportType, options:Object = null):void
Since : | CS5 |
Export the specified document(s)
Parameters
exportFile:File — (flash.filesystem.File) The file to export the document to.
| |
exportFormat:ExportType — (com.adobe.illustrator.ExportType) The file type to export the document as.
| |
options:Object (default = null ) — (Object) Options for the file type specified.
|
exportPDFPreset | () | method |
public function exportPDFPreset(file:File):void
Since : | CS5 |
Save all PDF presets to a file.
Parameters
file:File — (flash.filesystem.File) File to export to.
|
exportPerspectiveGridPreset | () | method |
public function exportPerspectiveGridPreset(file:File):void
Since : | CS5 |
saves all perspective grid presets to a file
Parameters
file:File — (flash.filesystem.File) file to export to
|
exportPrintPreset | () | method |
public function exportPrintPreset(file:File):void
Since : | CS5 |
Export the current print setting to the preset file.
Parameters
file:File — (flash.filesystem.File) File to export to.
|
exportVariables | () | method |
public function exportVariables(file:File):void
Since : | CS5 |
Save datasets into an XML library. The datasets contain variables and their associated dynamic data.
Parameters
file:File — (flash.filesystem.File) File spec to export to.
|
fitArtboardToSelectedArt | () | method |
public function fitArtboardToSelectedArt(index:Number):Boolean
Since : | CS5 |
Change the artboard to selected art bounds.
Parameters
index:Number (default = NaN ) — (Number) The index of the artboard to update.
|
Boolean |
getPerspectiveActivePlane | () | method |
public function getPerspectiveActivePlane():PerspectiveGridPlaneType
Since : | CS5 |
Gets the active plane of the active perspective grid of the document
ReturnsPerspectiveGridPlaneType |
hidePerspectiveGrid | () | method |
public function hidePerspectiveGrid():Boolean
Since : | CS5 |
Hides the current active perspective grid for the document, if there is visible perspective grid.
ReturnsBoolean |
imageCapture | () | method |
public function imageCapture(imageFile:File, clipBounds:Array = null, options:ImageCaptureOptions = null):void
Since : | CS5 |
Capture the artwork content inside the clip bound as raster image, and write out the captured image data into the target image file.
Parameters
imageFile:File — (flash.filesystem.File) The file to which the captured image should be written.
| |
clipBounds:Array (default = null ) — (Array) The rectangular region of the artwork for image capture. If the parameter is omitted, the entire artwork bound is captured.
| |
options:ImageCaptureOptions (default = null ) — (com.adobe.illustrator.ImageCaptureOptions) Describes the image capture options.
|
importCharacterStyles | () | method |
public function importCharacterStyles(fileSpec:File):void
Since : | CS5 |
Load the character styles from the Illustrator file.
Parameters
fileSpec:File — (flash.filesystem.File) File spec to import from.
|
importParagraphStyles | () | method |
public function importParagraphStyles(fileSpec:File):void
Since : | CS5 |
Load the paragraph styles from the Illustrator file.
Parameters
fileSpec:File — (flash.filesystem.File) File spec to import from.
|
importPDFPreset | () | method |
public function importPDFPreset(fileSpec:File, replacingPreset:Boolean = false):void
Since : | CS5 |
Load all PDF presets from a file.
Parameters
fileSpec:File — (flash.filesystem.File) File to import from.
| |
replacingPreset:Boolean (default = false ) — (Boolean) Should existing editable presets be replaced? ( default: false )
|
importPerspectiveGridPreset | () | method |
public function importPerspectiveGridPreset(fileSpec:File, perspectivePreset:String):void
Since : | CS5 |
loads mentioned perspective grid preset, if preset name is specified, else loads all(if no preset name is specified) presets, from the specified file
Parameters
fileSpec:File — (flash.filesystem.File) file to import from
| |
perspectivePreset:String — (String) name of perspective grid preset. ( default: )
|
importPrintPreset | () | method |
public function importPrintPreset(printPreset:String, fileSpec:File):void
Since : | CS5 |
Apply the named print preset from the file to the current print setting.
Parameters
printPreset:String — (String) The name of a print preset to import.
| |
fileSpec:File — (flash.filesystem.File) File to import from.
|
importVariables | () | method |
public function importVariables(fileSpec:File):void
Since : | CS5 |
Import a library containing datasets, variables and their associated dynamic data. Importing variables will overwrite existing variables and datasets.
Parameters
fileSpec:File — (flash.filesystem.File) File spec to import from.
|
() | method |
public function print(options:PrintOptions = null):void
Since : | CS5 |
Print the document.
Parameters
options:PrintOptions (default = null ) — (com.adobe.illustrator.PrintOptions) Print options.
|
rasterize | () | method |
public function rasterize(sourceArt:Object, clipBounds:Array = null, options:RasterizeOptions = null):PageItem
Since : | CS5 |
Rasterize the source art(s) within the specified clip bounds. The source art(s) are disposed as a result of the rasterization.
Parameters
sourceArt:Object — (Object) The page item(s) to be rasterized.
| |
clipBounds:Array (default = null ) — (Array) The rectangular region of the artwork for the rasterization. If the parameter is omitted, the bounds of the source art(s) is used instead.
| |
options:RasterizeOptions (default = null ) — (com.adobe.illustrator.RasterizeOptions) Describes the rasterization options.
|
PageItem |
rearrangeArtboards | () | method |
public function rearrangeArtboards(artboardLayout:DocumentArtboardLayout = null, artboardRowsOrCols:Number = 1, artboardSpacing:Number = 20.0, artboardMoveArtwork:Boolean = true):Boolean
Since : | CS5.5 |
Rearrange Artboards in the document
Parameters
artboardLayout:DocumentArtboardLayout (default = null ) — (com.adobe.illustrator.DocumentArtboardLayout) layout of artboards for rearrangement ( default: DocumentArtboardLayout.GridByRow )
| |
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 )
| |
artboardSpacing:Number (default = 20.0 ) — (Number) spacing between artboards ( default: 20.0 )
| |
artboardMoveArtwork:Boolean (default = true ) — (Boolean) Whether to move artwork with artboards ( default: true )
|
Boolean |
save | () | method |
public function save():void
Since : | CS5 |
Save the document.
saveAs | () | method |
public function saveAs(saveIn:File, options:Object = null):void
Since : | CS5 |
Save the document with specific save options.
Parameters
saveIn:File — (flash.filesystem.File) The file to save the document in.
| |
options:Object (default = null ) — (Object) Options for the file type specified.
|
selectObjectsOnActiveArtboard | () | method |
public function selectObjectsOnActiveArtboard():Boolean
Since : | CS5 |
Select art objects in active artboard.
ReturnsBoolean |
selectPerspectivePreset | () | method |
public function selectPerspectivePreset(perspectivePreset:String):Boolean
Since : | CS5 |
Selects a predefined preset to define grid for the current document.
Parameters
perspectivePreset:String — (String) name of perspective grid preset.
|
Boolean |
setPerspectiveActivePlane | () | method |
public function setPerspectiveActivePlane(perspectiveGridPlane:PerspectiveGridPlaneType):Boolean
Since : | CS5 |
Sets the active perspective plane for the active grid of the document.
Parameters
perspectiveGridPlane:PerspectiveGridPlaneType — (com.adobe.illustrator.PerspectiveGridPlaneType) Type of perspective grid plane.
|
Boolean |
showPerspectiveGrid | () | method |
public function showPerspectiveGrid():Boolean
Since : | CS5 |
Shows the current active perspective grid for the document, if no active perspective grid then shows the default perspective grid for the document
ReturnsBoolean |
windowCapture | () | method |
public function windowCapture(imageFile:File, windowSize:Array):void
Since : | CS5 |
Capture the current document window to the target TIFF image file.
Parameters
imageFile:File — (flash.filesystem.File) The TIFF file to which the captured image should be written.
| |
windowSize:Array — (Array) The size to make the window before capture.
|