Package | com.adobe.indesign |
Class | public class DocumentPreset |
Inheritance | DocumentPreset ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined 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 | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | 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 | ||
![]() | 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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | DocumentPreset | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
bottom | property |
bottom:Object
Since : | CS5 |
The bottom edge of the DocumentPreset.
public function get bottom():Object
public function set bottom(value:Object):void
columnCount | property |
columnCount:Number
Since : | CS5 |
The number of columns to place on the page.
public function get columnCount():Number
public function set columnCount(value:Number):void
columnGutter | property |
columnGutter:Object
Since : | CS5 |
The distance between columns.
public function get columnGutter():Object
public function set columnGutter(value:Object):void
documentBleedBottomOffset | property |
documentBleedBottomOffset:Object
Since : | CS5 |
The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false.
public function get documentBleedBottomOffset():Object
public function set documentBleedBottomOffset(value:Object):void
documentBleedInsideOrLeftOffset | property |
documentBleedInsideOrLeftOffset:Object
Since : | CS5 |
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.
public function get documentBleedInsideOrLeftOffset():Object
public function set documentBleedInsideOrLeftOffset(value:Object):void
documentBleedOutsideOrRightOffset | property |
documentBleedOutsideOrRightOffset:Object
Since : | CS5 |
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.
public function get documentBleedOutsideOrRightOffset():Object
public function set documentBleedOutsideOrRightOffset(value:Object):void
documentBleedTopOffset | property |
documentBleedTopOffset:Object
Since : | CS5 |
The amount to offset the top document bleed.
public function get documentBleedTopOffset():Object
public function set documentBleedTopOffset(value:Object):void
documentBleedUniformSize | property |
documentBleedUniformSize:Boolean
Since : | CS5 |
If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document. The default setting is true.
public function get documentBleedUniformSize():Boolean
public function set documentBleedUniformSize(value:Boolean):void
documentSlugUniformSize | property |
documentSlugUniformSize:Boolean
Since : | CS5 |
If true, uses the slug top offset value for slug measurements on all sides of the document. The default value is false.
public function get documentSlugUniformSize():Boolean
public function set documentSlugUniformSize(value:Boolean):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
facingPages | property |
facingPages:Boolean
Since : | CS5 |
If true, the document has facing pages.
public function get facingPages():Boolean
public function set facingPages(value:Boolean):void
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the DocumentPreset.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the DocumentPreset within its containing object.
public function get index():Number
intent | property |
intent:DocumentIntentOptions
Since : | CS5 |
The intent for a document.
public function get intent():DocumentIntentOptions
public function set intent(value:DocumentIntentOptions):void
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
left | property |
left:Object
Since : | CS5 |
The left edge of the DocumentPreset.
public function get left():Object
public function set left(value:Object):void
masterTextFrame | property |
masterTextFrame:Boolean
Since : | CS5 |
If true, the document A-master has auto textframes.
public function get masterTextFrame():Boolean
public function set masterTextFrame(value:Boolean):void
name | property |
name:String
Since : | CS5 |
The name of the DocumentPreset.
public function get name():String
public function set name(value:String):void
pageHeight | property |
pageHeight:Object
Since : | CS5 |
The height of the page.
public function get pageHeight():Object
public function set pageHeight(value:Object):void
pageOrientation | property |
pageOrientation:PageOrientation
Since : | CS5 |
The page orientation.
public function get pageOrientation():PageOrientation
public function set pageOrientation(value:PageOrientation):void
pageSize | property |
pageSize:String
Since : | CS5 |
The size of the page.
public function get pageSize():String
public function set pageSize(value:String):void
pagesPerDocument | property |
pagesPerDocument:Number
Since : | CS5 |
The number of pages in the document. (Range: 1 to 9999)
public function get pagesPerDocument():Number
public function set pagesPerDocument(value:Number):void
pageWidth | property |
pageWidth:Object
Since : | CS5 |
The width of the page.
public function get pageWidth():Object
public function set pageWidth(value:Object):void
parent | property |
parent:Application
[read-only] Since : | CS5 |
The parent of the DocumentPreset (a Application).
public function get parent():Application
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
right | property |
right:Object
Since : | CS5 |
The right edge of the DocumentPreset.
public function get right():Object
public function set right(value:Object):void
slugBottomOffset | property |
slugBottomOffset:Object
Since : | CS5 |
The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.
public function get slugBottomOffset():Object
public function set slugBottomOffset(value:Object):void
slugInsideOrLeftOffset | property |
slugInsideOrLeftOffset:Object
Since : | CS5 |
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.
public function get slugInsideOrLeftOffset():Object
public function set slugInsideOrLeftOffset(value:Object):void
slugRightOrOutsideOffset | property |
slugRightOrOutsideOffset:Object
Since : | CS5 |
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.
public function get slugRightOrOutsideOffset():Object
public function set slugRightOrOutsideOffset(value:Object):void
slugTopOffset | property |
slugTopOffset:Object
Since : | CS5 |
The amount to offset the top slug.
public function get slugTopOffset():Object
public function set slugTopOffset(value:Object):void
startPageNumber | property |
startPageNumber:Number
Since : | CS5 |
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.
public function get startPageNumber():Number
public function set startPageNumber(value:Number):void
top | property |
top:Object
Since : | CS5 |
The top edge of the DocumentPreset.
public function get top():Object
public function set top(value:Object):void
addEventListenerDocumentPreset | () | method |
public function addEventListenerDocumentPreset(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
duplicate | () | method |
public function duplicate():DocumentPreset
Since : | CS5 |
Duplicates the DocumentPreset.
ReturnsDocumentPreset |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
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
Since : | CS5 |
Deletes the DocumentPreset.
removeEventListenerDocumentPreset | () | method |
public function removeEventListenerDocumentPreset(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |