Object

DocumentPreset

A preset that contains all of the new document settings.

Hierarchy

DocumentPreset

Properties

Type	Access	Description
Number \| String unit	read/write	The bottom edge of the DocumentPreset.
Number 1–216	read/write	The number of columns to place on the page.
Number \| String unit	read/write	The distance between columns.
Boolean	read/write	If true, the document A-master has primary text frames when a new document is created.
Number \| String unit	read/write	The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false.
Number \| String unit	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.
Number \| String unit	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.
Number \| String unit	read/write	The amount to offset the top document bleed.
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.
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<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
Boolean	read/write	If true, the document has facing pages.
Number	readonly	The unique ID of the DocumentPreset.
Number	readonly	The index of the DocumentPreset within its containing object.
DocumentIntentOptions	read/write	The intent for a document.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
Number \| String unit	read/write	The left edge of the DocumentPreset.
String	read/write	The name of the DocumentPreset.
Number \| String unit	read/write	The height of the page.
PageOrientation	read/write	The page orientation.
String	read/write	The size of the page.
Number \| String unit	read/write	The width of the page.
Number 1–9999	read/write	The number of pages in the document. (Range: 1 to 9999)
Application	readonly	The parent of the DocumentPreset (a Application).
Object	read/write	A property that allows setting of several properties at the same time.
Number \| String unit	read/write	The right edge of the DocumentPreset.
Number \| String unit	read/write	The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.
Number \| String unit	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.
Number \| String unit	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.
Number \| String unit	read/write	The amount to offset the top slug.
Number 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.
Number \| String unit	read/write	The top edge of the DocumentPreset.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

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

captures? Boolean This parameter is obsolete.

→ DocumentPreset

Duplicates the DocumentPreset.

→ String

Gets the label value associated with the specified key.

key String The key.

→ DocumentPreset[]

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

→ void

Sets the label to the value associated with the specified key.

key String The key.

value String The value.

→ void

Deletes the DocumentPreset.

→ Boolean

Removes the event listener.

eventType String The registered event type.

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

captures? Boolean This parameter is obsolete.

→ String

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

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a DocumentPreset.

Event.parent EventListener.parent MutationEvent.parent

Parameter of 4

Method parameters that accept a DocumentPreset.

DocumentPresets.itemByRange(from)DocumentPresets.nextItem(obj)DocumentPresets.previousItem(obj)Documents.add(documentPreset)

Return 15

Methods that return a DocumentPreset.

DocumentPreset.duplicate()DocumentPreset.getElements()DocumentPresets.[]()DocumentPresets.add()DocumentPresets.anyItem()DocumentPresets.everyItem()DocumentPresets.firstItem()DocumentPresets.item()DocumentPresets.itemByID()DocumentPresets.itemByName()DocumentPresets.itemByRange()DocumentPresets.lastItem()DocumentPresets.middleItem()DocumentPresets.nextItem()DocumentPresets.previousItem()