DocumentPreset

A preset that contains all of the new document settings.

Properties

Property Type Access Description
bottom number r/w The bottom edge of the DocumentPreset.
columnCount number r/w The number of columns to place on the page.
columnGutter number r/w The distance between columns.
documentBleedBottomOffset number 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 number 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 number 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 number 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.
label string r/w A property that can be set to any string.
left number 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 number r/w The height of the page.
pageOrientation PageOrientation
:
LANDSCAPE
PORTRAIT
r/w The page orientation.
pageSize string r/w The size of the page.
pagesPerDocument number r/w The number of pages in the document. (Range: 1 to 9999)
pageWidth number r/w The width of the page.
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 number r/w The right edge of the DocumentPreset.
slugBottomOffset number r/w The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.
slugInsideOrLeftOffset number 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 number 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 number r/w The amount to offset the top slug.
top number r/w The top edge of the DocumentPreset.

Methods

DocumentPresetduplicate ()
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 DocumentPresetgetElements ()
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:

DocumentPresets.previousItem (

obj:
DocumentPreset )

DocumentPresets.nextItem (

obj:
DocumentPreset )

Documents.add (

[showingWindow:
bool=true ][, documentPreset:
DocumentPreset ][, withProperties:
Object])

Returned by:

DocumentPreset DocumentPreset .duplicate (

)

Array of DocumentPreset DocumentPreset .getElements (

)

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
)

Leave a Comment

Previous post:

Next post: