DocumentPreset

A preset that contains all of the new document settings.

Methods:

duplicate, extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Objects:

Boolean, Number, Object, PageOrientation, String

Property Listing

Property

Type

Access

Description

bottom

Number

String

read/write

The bottom edge of the DocumentPreset.

columnCount

Number (range 1 - 216)

read/write

The number of columns to place on the page.

columnGutter

Number

String

read/write

The distance between columns.

documentBleedBottomOffset

Number

String

read/write

The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false.

documentBleedInsideOrLeftOffset

Number

String

read/write

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

Number

String

read/write

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

Number

String

read/write

The amount to offset the top document bleed.

facingPages

Boolean

read/write

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.

label

String

read/write

A property that can be set to any string.

left

Number

String

read/write

The left edge of the DocumentPreset.

name

String

read/write

The name of the DocumentPreset.

pageHeight

Number

String

read/write

The height of the page.

pageOrientation

PageOrientation

PageOrientation.LANDSCAPE

PageOrientation.PORTRAIT

read/write

The page orientation.

pageWidth

Number

String

read/write

The width of the page.

pagesPerDocument

Number (range 1 - 9999)

read/write

The number of pages in the document. (Range: 1 to 9999)

parent

Application

readonly

The parent of the DocumentPreset (a Application).

properties

Object

read/write

A property that allows setting of several properties at the same time.

right

Number

String

read/write

The right edge of the DocumentPreset.

slugBottomOffset

Number

String

read/write

The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.

slugInsideOrLeftOffset

Number

String

read/write

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

Number

String

read/write

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

Number

String

read/write

The amount to offset the top slug.

top

Number

String

read/write

The top edge of the DocumentPreset.

Method Listing

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.

Object getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined remove ()

Deletes the DocumentPreset.

String toSource ()

Generates a string which, if executed, will return the DocumentPreset.

String toSpecifier ()

Retrieves the object specifier.

Return

DocumentPresets.add()

DocumentPreset.duplicate()

DocumentPresets.anyItem()

DocumentPresets.everyItem()

DocumentPresets.nextItem()

DocumentPresets.previousItem()

DocumentPresets.itemByID()

DocumentPresets.item()

DocumentPresets.itemByName()

DocumentPresets.itemByRange()

DocumentPresets.firstItem()

DocumentPresets.lastItem()

DocumentPresets.middleItem()