Adobe InDesign CS5.5 (7.5) Object Model JS: DocumentPreset

InDesign CS5.5

Class

DocumentPreset

 A preset that contains all of the new document settings.

QuickLinks

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

Hierarchy

Application
DocumentPreset
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
bottomMeasurement Unit (Number or String) r/wThe bottom edge of the DocumentPreset.
columnCountnumber (range: 1 - 216) r/wThe number of columns to place on the page.
columnGutterMeasurement Unit (Number or String) (range: 0 - 1440) r/wThe distance between columns.
documentBleedBottomOffsetMeasurement Unit (Number or String) r/wThe amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false.
documentBleedInsideOrLeftOffsetMeasurement Unit (Number or String) r/wThe 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.
documentBleedOutsideOrRightOffsetMeasurement Unit (Number or String) r/wThe 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.
documentBleedTopOffsetMeasurement Unit (Number or String) r/wThe amount to offset the top document bleed.
documentBleedUniformSizebool r/wIf true, uses the document bleed top offset value for bleed offset measurements on all sides of the document. The default setting is true.
documentSlugUniformSizebool r/wIf true, uses the slug top offset value for slug measurements on all sides of the document. The default value is false.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
facingPagesbool r/wIf true, the document has facing pages.
idnumber readonlyThe unique ID of the DocumentPreset.
indexnumber readonlyThe index of the DocumentPreset within its containing object.
intentDocumentIntentOptions:
DocumentIntentOptions.PRINT_INTENT
DocumentIntentOptions.WEB_INTENT
r/wThe intent for a document.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
leftMeasurement Unit (Number or String) r/wThe left edge of the DocumentPreset.
masterTextFramebool r/wIf true, the document A-master has auto textframes.
namestring r/wThe name of the DocumentPreset.
pageHeightMeasurement Unit (Number or String) r/wThe height of the page.
pageOrientationPageOrientation:
PageOrientation.LANDSCAPE
PageOrientation.PORTRAIT
r/wThe page orientation.
pageSizestring r/wThe size of the page.
pageWidthMeasurement Unit (Number or String) r/wThe width of the page.
pagesPerDocumentnumber r/wThe number of pages in the document. (Range: 1 to 9999)
parentApplication readonlyThe parent of the DocumentPreset (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
rightMeasurement Unit (Number or String) r/wThe right edge of the DocumentPreset.
slugBottomOffsetMeasurement Unit (Number or String) r/wThe amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.
slugInsideOrLeftOffsetMeasurement Unit (Number or String) r/wThe amount to offset the inside or left slug. Note: To set the slug inside or left offset, document slug uniform size must be false.
slugRightOrOutsideOffsetMeasurement Unit (Number or String) r/wThe amount to offset the outside or right slug. Note: To set the slug right or outside offset, document slug uniform size must be false.
slugTopOffsetMeasurement Unit (Number or String) r/wThe amount to offset the top slug.
startPageNumbernumber (range: 1 - 999999) r/wThe 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.
topMeasurement Unit (Number or String) r/wThe top edge of the DocumentPreset.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

DocumentPreset duplicate ()
Duplicates the DocumentPreset.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of DocumentPreset getElements ()
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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the DocumentPreset.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

DocumentPreset DocumentPresets.nextItem (obj: DocumentPreset)

DocumentPreset DocumentPresets.previousItem (obj: DocumentPreset)

Document Documents.add ([showingWindow: bool=true][, documentPreset: DocumentPreset][, withProperties: Object])

Return

DocumentPreset DocumentPreset.duplicate ()

Array of DocumentPreset DocumentPreset.getElements ()

DocumentPreset DocumentPresets.[] (index: number)

DocumentPreset DocumentPresets.add ([withProperties: Object])

DocumentPreset DocumentPresets.anyItem ()

Array of DocumentPreset DocumentPresets.everyItem ()

DocumentPreset DocumentPresets.firstItem ()

DocumentPreset DocumentPresets.item (index: varies)

DocumentPreset DocumentPresets.itemByID (id: number)

DocumentPreset DocumentPresets.itemByName (name: string)

Array of DocumentPreset DocumentPresets.itemByRange (from: varies, to: varies)

DocumentPreset DocumentPresets.lastItem ()

DocumentPreset DocumentPresets.middleItem ()

DocumentPreset DocumentPresets.nextItem (obj: DocumentPreset)

DocumentPreset DocumentPresets.previousItem (obj: DocumentPreset)

Jongware, 28-Apr-2012 v3.0.3iContents :: Index