Class
A collection of documents. [], add, addDocument, getByName
Documents
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | int | readonly | Number of elements in the collection. |
| parent | Object | readonly | The object's container. |
| typename | string | readonly | The class name of the object. |
Methods
Instances
Document [] (index:
uint)
Get an element in the collection with the provided index.
| Parameter | Type | Description |
|---|---|---|
| index | uint |
Document add ([documentColorSpace:
DocumentColorSpace=DocumentColorSpace.CMYK][, width:
number=612.0][, height:
number=792.0][, numArtboards:
int=1][, artboardLayout:
DocumentArtboardLayout=DocumentArtboardLayout.GridByRow][, artboardSpacing:
number=20.0][, artboardRowsOrCols:
int=1])
A document.
| Parameter | Type | Description |
|---|---|---|
| documentColorSpace | DocumentColorSpace: DocumentColorSpace.RGB DocumentColorSpace.CMYK | The color model used for the document. (default: DocumentColorSpace.CMYK) (Optional) |
| width | number | Width of the artboard. (default: 612.0) (Optional) |
| height | number | Height of the artboard. (default: 792.0) (Optional) |
| numArtboards | int | Number of artboards for new document.Range (1:100). (default: 1) (Optional) |
| artboardLayout | DocumentArtboardLayout: DocumentArtboardLayout.GridByRow DocumentArtboardLayout.GridByCol DocumentArtboardLayout.Row DocumentArtboardLayout.Column DocumentArtboardLayout.RLGridByRow DocumentArtboardLayout.RLGridByCol DocumentArtboardLayout.RLRow | Layout of artboards for new document. (default: DocumentArtboardLayout.GridByRow) (Optional) |
| artboardSpacing | number | Spacing between artboards for new document. (default: 20.0) (Optional) |
| artboardRowsOrCols | int | 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) (Optional) |
Document addDocument (startupPreset:
string, presetSettings:
DocumentPreset)
Create a document from the preset.
| Parameter | Type | Description |
|---|---|---|
| startupPreset | string | The name of startup document preset. |
| presetSettings | DocumentPreset | The custom document preset settings. |
Document getByName (name:
string)
Get the first element in the collection with the provided name.
| Parameter | Type | Description |
|---|---|---|
| name | string |
Element of
Application.documents
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |