K4 InDesign Javascript API Documentation

PreferencesDocumentPreset

A preset that contains all of the new document settings.

Instance Properties

Name Description Access
bottom Measurement Unit (Number or String)=any The bottom edge of the DocumentPreset. read-write
columnCount number The number of columns to place on the page. read-write
columnGutter Measurement Unit (Number or String)=any The distance between columns. read-write
createPrimaryTextFrame bool If true, the document A-master has primary text frames when a new document is created. read-write
documentBleedBottomOffset Measurement Unit (Number or String)=any The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false. read-write
documentBleedInsideOrLeftOffset Measurement Unit (Number or String)=any 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. read-write
documentBleedOutsideOrRightOffset Measurement Unit (Number or String)=any 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. read-write
documentBleedTopOffset Measurement Unit (Number or String)=any The amount to offset the top document bleed. read-write
documentBleedUniformSize bool If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document. The default setting is true. read-write
documentSlugUniformSize bool If true, uses the slug top offset value for slug measurements on all sides of the document. The default value is false. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
facingPages bool If true, the document has facing pages. read-write
id number The unique ID of the DocumentPreset. read-only
index number The index of the DocumentPreset within its containing object. read-only
intent DocumentIntentOptions The intent for a document. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
left Measurement Unit (Number or String)=any The left edge of the DocumentPreset. read-write
name string The name of the DocumentPreset. read-write
pageHeight Measurement Unit (Number or String)=any The height of the page. read-write
pageOrientation PageOrientation The page orientation. read-write
pageSize string The size of the page. read-write
pageWidth Measurement Unit (Number or String)=any The width of the page. read-write
pagesPerDocument number The number of pages in the document. (Range: 1 to 9999) read-write
parent Application The parent of the DocumentPreset (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
right Measurement Unit (Number or String)=any The right edge of the DocumentPreset. read-write
slugBottomOffset Measurement Unit (Number or String)=any The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false. read-write
slugInsideOrLeftOffset Measurement Unit (Number or String)=any 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. read-write
slugRightOrOutsideOffset Measurement Unit (Number or String)=any 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. read-write
slugTopOffset Measurement Unit (Number or String)=any The amount to offset the top slug. read-write
startPageNumber number 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. read-write
top Measurement Unit (Number or String)=any The top edge of the DocumentPreset. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → DocumentPreset
extractLabel(
key)
  → string
getElements(
)
  → DocumentPreset
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
duplicate(
)
  → DocumentPreset
Duplicates the DocumentPreset.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → DocumentPreset
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the DocumentPreset.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the DocumentPreset.
toSpecifier(
)
  → string
Retrieves the object specifier.