DocumentPreset

A preset that contains all of the new document settings.

Go to Property Listing | Method Listing

Methods:

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

Objects:

Application, Boolean, DocumentIntentOptions, EventListeners, Events, 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.
createPrimaryTextFrame	Boolean	read/write	If true, the document A-master has primary text frames when a new document is created.
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.
documentBleedUniformSize	Boolean	read/write	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	Boolean	read/write	If true, uses the slug top offset value for slug measurements on all sides of the document. The default value is false.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
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.
intent	DocumentIntentOptions DocumentIntentOptions.PRINT_INTENT DocumentIntentOptions.WEB_INTENT DocumentIntentOptions.DPS_INTENT	read/write	The intent for a document.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
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.
pageSize	String	read/write	The size of the page.
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.
startPageNumber	Number (range 1 - 999999)	read/write	The starting page number for a document. This is the same as the starting page number for the first section of a document. Default value is 1.
top	Number String	read/write	The top edge of the DocumentPreset.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	Varies	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

Varies

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

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.

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

Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	Varies	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

Varies

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent