DocumentPreset
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| bottom | Measurement Unit (Number or String) | r/w | The bottom edge of the DocumentPreset. |
| columnCount | number (range: 1 - 216) | r/w | The number of columns to place on the page. |
| columnGutter | Measurement Unit (Number or String) (range: 0 - 1440) | r/w | The distance between columns. |
| documentBleedBottomOffset | Measurement Unit (Number or String) | r/w | The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false. |
| documentBleedInsideOrLeftOffset | Measurement Unit (Number or String) | r/w | The amount to offset the inside or left document bleed. Note: To set the bleed inside or left offset, document bleed uniform size must be false. |
| documentBleedOutsideOrRightOffset | Measurement Unit (Number or String) | r/w | The amount to offset the outside or right document bleed. Note: To set the bleed outside or right offset, document bleed uniform size must be false. |
| documentBleedTopOffset | Measurement Unit (Number or String) | r/w | The amount to offset the top document bleed. |
| documentBleedUniformSize | bool | r/w | If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document. The default setting is true. |
| documentSlugUniformSize | bool | r/w | If true, uses the slug top offset value for slug measurements on all sides of the doucment. The default value is false. |
| facingPages | bool | r/w | If true, the document has facing pages. |
| id | number | readonly | The unique ID of the DocumentPreset. |
| index | number | readonly | The index of the DocumentPreset within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| left | Measurement Unit (Number or String) | r/w | The left edge of the DocumentPreset. |
| masterTextFrame | bool | r/w | If true, the document A-master has auto textframes. |
| name | string | r/w | The name of the DocumentPreset. |
| pageHeight | Measurement Unit (Number or String) | r/w | The height of the page. |
| pageOrientation | PageOrientation: PageOrientation.LANDSCAPE PageOrientation.PORTRAIT |
r/w | The page orientation. |
| pageSize | string | r/w | The size of the page. |
| pageWidth | Measurement Unit (Number or String) | r/w | The width of the page. |
| pagesPerDocument | number | r/w | The number of pages in the document. (Range: 1 to 9999) |
| parent | Application | readonly | The parent of the DocumentPreset (a Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| right | Measurement Unit (Number or String) | r/w | The right edge of the DocumentPreset. |
| slugBottomOffset | Measurement Unit (Number or String) | r/w | The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false. |
| slugInsideOrLeftOffset | Measurement Unit (Number or String) | r/w | The amount to offset the inside or left slug. Note: To set the slug inside or left offset, document slug uniform size must be false. |
| slugRightOrOutsideOffset | Measurement Unit (Number or String) | r/w | The amount to offset the outside or right slug. Note: To set the slug right or outside offset, document slug uniform size must be false. |
| slugTopOffset | Measurement Unit (Number or String) | r/w | The amount to offset the top slug. |
| top | Measurement Unit (Number or String) | r/w | The top edge of the DocumentPreset. |
Methods
Instances
DocumentPreset duplicate ()
Duplicates the DocumentPreset.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of DocumentPreset getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the DocumentPreset.
string toSource ()
Generates a string which, if executed, will return the DocumentPreset.
string toSpecifier ()
Retrieves the object specifier.
Used in:
array of DocumentPreset DocumentPresets.itemByRange (from: any, to: any)
DocumentPreset DocumentPresets.nextItem (obj: DocumentPreset)
DocumentPreset DocumentPresets.previousItem (obj: DocumentPreset)
Document Documents.add ([showingWindow: bool=true][, documentPreset: DocumentPreset][, withProperties: Object])
Return
DocumentPreset DocumentPreset.duplicate ()
Array of DocumentPreset DocumentPreset.getElements ()
DocumentPreset DocumentPresets.[] (index: number)
DocumentPreset DocumentPresets.add ([withProperties: Object])
DocumentPreset DocumentPresets.anyItem ()
Array of DocumentPreset DocumentPresets.everyItem ()
DocumentPreset DocumentPresets.firstItem ()
DocumentPreset DocumentPresets.item (index: any)
DocumentPreset DocumentPresets.itemByID (id: number)
DocumentPreset DocumentPresets.itemByName (name: string)
Array of DocumentPreset DocumentPresets.itemByRange (from: any, to: any)
DocumentPreset DocumentPresets.lastItem ()
DocumentPreset DocumentPresets.middleItem ()
DocumentPreset DocumentPresets.nextItem (obj: DocumentPreset)
DocumentPreset DocumentPresets.previousItem (obj: DocumentPreset)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |