Adobe Illustrator CS4 Type Library JS: Artboards

Illustrator CS4

Class

Artboards

 A collection of artboards.

QuickLinks

[], add, getActiveArtboardIndex, getByName, remove, removeAll, setActiveArtboardIndex

Hierarchy

Object
Artboards

Properties

PropertyTypeAccessDescription
lengthint readonlyNumber of elements in the collection.
parentObject readonlyThe object's container.
typenamestring readonlyThe class name of the object.

Methods

Instances

Artboard [] (index: uint)
Get an element in the collection with the provided index.

ParameterTypeDescription
indexuint

Artboard add (artboardRect: Rect)
Add artboard object.

ParameterTypeDescription
artboardRectRectSize and position of artboard.

int getActiveArtboardIndex ()
Retrieves the index position of the active artboard in the document's list.

Artboard getByName (name: string)
Get the first element in the collection with the provided name.

ParameterTypeDescription
namestring

void remove (index: int)
Delete artboard object.

ParameterTypeDescription
indexintIndex of the crop area to be deleted.

void removeAll ()
Deletes all elements.

void setActiveArtboardIndex (index: int)
Makes a specific artboard active, and makes it current in the iteration order.

ParameterTypeDescription
indexintThe 0-based index position of the artboard in the document list.

Element of

Document.artboards

Jongware, 27-Jun-2010 v3.0.3dContents :: Index