Packagecom.adobe.indesign
Classpublic class DocumentPreset
InheritanceDocumentPreset Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  bottom : Object
The bottom edge of the DocumentPreset.
DocumentPreset
  columnCount : Number
The number of columns to place on the page.
DocumentPreset
  columnGutter : Object
The distance between columns.
DocumentPreset
  documentBleedBottomOffset : Object
The amount to offset the bottom document bleed.
DocumentPreset
  documentBleedInsideOrLeftOffset : Object
The amount to offset the inside or left document bleed.
DocumentPreset
  documentBleedOutsideOrRightOffset : Object
The amount to offset the outside or right document bleed.
DocumentPreset
  documentBleedTopOffset : Object
The amount to offset the top document bleed.
DocumentPreset
  documentBleedUniformSize : Boolean
If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document.
DocumentPreset
  documentSlugUniformSize : Boolean
If true, uses the slug top offset value for slug measurements on all sides of the document.
DocumentPreset
  eventListeners : EventListeners
[read-only] A collection of event listeners.
DocumentPreset
  events : Events
[read-only] A collection of events.
DocumentPreset
  facingPages : Boolean
If true, the document has facing pages.
DocumentPreset
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the DocumentPreset.
DocumentPreset
  index : Number
[read-only] The index of the DocumentPreset within its containing object.
DocumentPreset
  intent : DocumentIntentOptions
The intent for a document.
DocumentPreset
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
DocumentPreset
  label : String
A property that can be set to any string.
DocumentPreset
  left : Object
The left edge of the DocumentPreset.
DocumentPreset
  masterTextFrame : Boolean
If true, the document A-master has auto textframes.
DocumentPreset
  name : String
The name of the DocumentPreset.
DocumentPreset
  pageHeight : Object
The height of the page.
DocumentPreset
  pageOrientation : PageOrientation
The page orientation.
DocumentPreset
  pageSize : String
The size of the page.
DocumentPreset
  pagesPerDocument : Number
The number of pages in the document.
DocumentPreset
  pageWidth : Object
The width of the page.
DocumentPreset
  parent : Application
[read-only] The parent of the DocumentPreset (a Application).
DocumentPreset
  properties : Object
A property that allows setting of several properties at the same time.
DocumentPreset
  right : Object
The right edge of the DocumentPreset.
DocumentPreset
  slugBottomOffset : Object
The amount to offset the bottom slug.
DocumentPreset
  slugInsideOrLeftOffset : Object
The amount to offset the inside or left slug.
DocumentPreset
  slugRightOrOutsideOffset : Object
The amount to offset the outside or right slug.
DocumentPreset
  slugTopOffset : Object
The amount to offset the top slug.
DocumentPreset
  startPageNumber : Number
The starting page number for a document.
DocumentPreset
  top : Object
The top edge of the DocumentPreset.
DocumentPreset
Public Methods
 MethodDefined By
  
addEventListenerDocumentPreset(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
DocumentPreset
  
Duplicates the DocumentPreset.
DocumentPreset
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
DocumentPreset
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
Resolves the object specifier, creating an array of object references.
DocumentPreset
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
DocumentPreset
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
remove():void
Deletes the DocumentPreset.
DocumentPreset
  
removeEventListenerDocumentPreset(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
DocumentPreset
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
DocumentPreset
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
bottomproperty
bottom:Object

The bottom edge of the DocumentPreset.


Implementation
    public function get bottom():Object
    public function set bottom(value:Object):void
columnCountproperty 
columnCount:Number

The number of columns to place on the page.


Implementation
    public function get columnCount():Number
    public function set columnCount(value:Number):void
columnGutterproperty 
columnGutter:Object

The distance between columns.


Implementation
    public function get columnGutter():Object
    public function set columnGutter(value:Object):void
documentBleedBottomOffsetproperty 
documentBleedBottomOffset:Object

The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false.


Implementation
    public function get documentBleedBottomOffset():Object
    public function set documentBleedBottomOffset(value:Object):void
documentBleedInsideOrLeftOffsetproperty 
documentBleedInsideOrLeftOffset:Object

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.


Implementation
    public function get documentBleedInsideOrLeftOffset():Object
    public function set documentBleedInsideOrLeftOffset(value:Object):void
documentBleedOutsideOrRightOffsetproperty 
documentBleedOutsideOrRightOffset:Object

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.


Implementation
    public function get documentBleedOutsideOrRightOffset():Object
    public function set documentBleedOutsideOrRightOffset(value:Object):void
documentBleedTopOffsetproperty 
documentBleedTopOffset:Object

The amount to offset the top document bleed.


Implementation
    public function get documentBleedTopOffset():Object
    public function set documentBleedTopOffset(value:Object):void
documentBleedUniformSizeproperty 
documentBleedUniformSize:Boolean

If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document. The default setting is true.


Implementation
    public function get documentBleedUniformSize():Boolean
    public function set documentBleedUniformSize(value:Boolean):void
documentSlugUniformSizeproperty 
documentSlugUniformSize:Boolean

If true, uses the slug top offset value for slug measurements on all sides of the document. The default value is false.


Implementation
    public function get documentSlugUniformSize():Boolean
    public function set documentSlugUniformSize(value:Boolean):void
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
facingPagesproperty 
facingPages:Boolean

If true, the document has facing pages.


Implementation
    public function get facingPages():Boolean
    public function set facingPages(value:Boolean):void
idproperty 
id:Number  [read-only]

The unique ID of the DocumentPreset.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the DocumentPreset within its containing object.


Implementation
    public function get index():Number
intentproperty 
intent:DocumentIntentOptions

The intent for a document.


Implementation
    public function get intent():DocumentIntentOptions
    public function set intent(value:DocumentIntentOptions):void
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
leftproperty 
left:Object

The left edge of the DocumentPreset.


Implementation
    public function get left():Object
    public function set left(value:Object):void
masterTextFrameproperty 
masterTextFrame:Boolean

If true, the document A-master has auto textframes.


Implementation
    public function get masterTextFrame():Boolean
    public function set masterTextFrame(value:Boolean):void
nameproperty 
name:String

The name of the DocumentPreset.


Implementation
    public function get name():String
    public function set name(value:String):void
pageHeightproperty 
pageHeight:Object

The height of the page.


Implementation
    public function get pageHeight():Object
    public function set pageHeight(value:Object):void
pageOrientationproperty 
pageOrientation:PageOrientation

The page orientation.


Implementation
    public function get pageOrientation():PageOrientation
    public function set pageOrientation(value:PageOrientation):void
pageSizeproperty 
pageSize:String

The size of the page.


Implementation
    public function get pageSize():String
    public function set pageSize(value:String):void
pagesPerDocumentproperty 
pagesPerDocument:Number

The number of pages in the document. (Range: 1 to 9999)


Implementation
    public function get pagesPerDocument():Number
    public function set pagesPerDocument(value:Number):void
pageWidthproperty 
pageWidth:Object

The width of the page.


Implementation
    public function get pageWidth():Object
    public function set pageWidth(value:Object):void
parentproperty 
parent:Application  [read-only]

The parent of the DocumentPreset (a Application).


Implementation
    public function get parent():Application
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rightproperty 
right:Object

The right edge of the DocumentPreset.


Implementation
    public function get right():Object
    public function set right(value:Object):void
slugBottomOffsetproperty 
slugBottomOffset:Object

The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.


Implementation
    public function get slugBottomOffset():Object
    public function set slugBottomOffset(value:Object):void
slugInsideOrLeftOffsetproperty 
slugInsideOrLeftOffset:Object

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.


Implementation
    public function get slugInsideOrLeftOffset():Object
    public function set slugInsideOrLeftOffset(value:Object):void
slugRightOrOutsideOffsetproperty 
slugRightOrOutsideOffset:Object

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.


Implementation
    public function get slugRightOrOutsideOffset():Object
    public function set slugRightOrOutsideOffset(value:Object):void
slugTopOffsetproperty 
slugTopOffset:Object

The amount to offset the top slug.


Implementation
    public function get slugTopOffset():Object
    public function set slugTopOffset(value:Object):void
startPageNumberproperty 
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.


Implementation
    public function get startPageNumber():Number
    public function set startPageNumber(value:Number):void
topproperty 
top:Object

The top edge of the DocumentPreset.


Implementation
    public function get top():Object
    public function set top(value:Object):void
Method Detail
addEventListenerDocumentPreset()method
public function addEventListenerDocumentPreset(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
duplicate()method 
public function duplicate():DocumentPreset

Duplicates the DocumentPreset.

Returns
DocumentPreset
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

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

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

remove()method 
public function remove():void

Deletes the DocumentPreset.

removeEventListenerDocumentPreset()method 
public function removeEventListenerDocumentPreset(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String