Class
A collection of documents. [], add, getByName
Documents
See also Document.
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 ([width:
UnitValue][, height:
UnitValue][, resolution:
number=72][, name:
string][, mode:
NewDocumentMode=NewDocumentMode.RGB][, initialFill:
DocumentFill=DocumentFill.WHITE][, pixelAspectRatio:
number=1.0][, bitsPerChannel:
BitsPerChannelType=BitsPerChannelType.EIGHT][, colorProfileName:
string])
A document.
| Parameter | Type | Description |
|---|---|---|
| width | UnitValue | The width of the document. (Optional) |
| height | UnitValue | The height of the document. (Optional) |
| resolution | number | The resolution of the document (in pixels per inch) (default: 72) (Optional) |
| name | string | The name of the document. (Optional) |
| mode | NewDocumentMode: NewDocumentMode.GRAYSCALE NewDocumentMode.RGB NewDocumentMode.CMYK NewDocumentMode.LAB NewDocumentMode.BITMAP | The document mode. (default: NewDocumentMode.RGB) (Optional) |
| initialFill | DocumentFill: DocumentFill.WHITE DocumentFill.BACKGROUNDCOLOR DocumentFill.TRANSPARENT | The initial fill of the document. (default: DocumentFill.WHITE) (Optional) |
| pixelAspectRatio | number | The initial pixel aspect ratio of the document. (default: 1.0) (Optional) |
| bitsPerChannel | BitsPerChannelType: BitsPerChannelType.ONE BitsPerChannelType.EIGHT BitsPerChannelType.SIXTEEN BitsPerChannelType.THIRTYTWO | The number of bits per channel. (default: BitsPerChannelType.EIGHT) (Optional) |
| colorProfileName | string | The name of color profile for document. (Optional) |
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, 28-Aug-2012 v3.0.3i | Contents :: Index |