Adobe InDesign CS (3.0) Object Model JS: DocumentPreset

InDesign CS

Class

DocumentPreset

 A preset that contains all of the new document settings.

QuickLinks

duplicate, extractLabel, insertLabel, remove

Hierarchy

Application
DocumentPreset

Properties

PropertyTypeAccessDescription
bottomMeasurement Unit (Number or String) r/wThe bottom edge of the DocumentPreset.
columnCountnumber r/wThe number of columns
columnGutterMeasurement Unit (Number or String) r/wThe distance between columns in a text frame
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.
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.
labelstring r/wA property that can be set to any string.
leftMeasurement Unit (Number or String) r/wThe left edge of the DocumentPreset.
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.
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.
topMeasurement Unit (Number or String) r/wThe top edge of the DocumentPreset.

Methods

Instances

DocumentPreset duplicate ()
Duplicates the DocumentPreset.

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

ParameterTypeDescription
keystringThe key.

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.

Used in:

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

Return

DocumentPreset DocumentPreset.duplicate ()

DocumentPreset DocumentPresets.add ([withProperties: Object])

Jongware, 27-Jun-2010 v3.0.3dContents :: Index