Packagecom.adobe.indesign
Classpublic class DocumentPreference
InheritanceDocumentPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  allowPageShuffle : Boolean
If true, guarantees that when pages are added to a spread it will contain a maximum of two pages.
DocumentPreference
  columnDirection : HorizontalOrVertical
The direction of text in the column.
DocumentPreference
  columnGuideColor : Object
The color of the column guides, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values,, or as a UI color.
DocumentPreference
  columnGuideLocked : Boolean
If true, locks column guides.
DocumentPreference
  documentBleedBottomOffset : Object
The amount to offset the bottom document bleed.
DocumentPreference
  documentBleedInsideOrLeftOffset : Object
The amount to offset the inside or left document bleed.
DocumentPreference
  documentBleedOutsideOrRightOffset : Object
The amount to offset the outside or right document bleed.
DocumentPreference
  documentBleedTopOffset : Object
The amount to offset the top document bleed.
DocumentPreference
  documentBleedUniformSize : Boolean
If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document.
DocumentPreference
  documentSlugUniformSize : Boolean
If true, uses the slug top offset value for slug measurements on all sides of the document.
DocumentPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
DocumentPreference
  events : Events
[override] [read-only] A collection of events.
DocumentPreference
  facingPages : Boolean
If true, the document has facing pages.
DocumentPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  intent : DocumentIntentOptions
The intent for a document.
DocumentPreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
DocumentPreference
  marginGuideColor : Object
The color of the margin guides, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color.
DocumentPreference
  masterTextFrame : Boolean
If true, the document A-master has auto textframes.
DocumentPreference
  overprintBlack : Boolean
If true, overprints black when saving the document.
DocumentPreference
  pageBinding : PageBindingOptions
The placement of the page binding.
DocumentPreference
  pageHeight : Object
The height of the page.
DocumentPreference
  pageOrientation : PageOrientation
The page orientation.
DocumentPreference
  pageSize : String
The size of the page.
DocumentPreference
  pagesPerDocument : Number
The number of pages in the document.
DocumentPreference
  pageWidth : Object
The width of the page.
DocumentPreference
  parent : Object
[override] [read-only] The parent of the DocumentPreference (a Application or Document).
DocumentPreference
  preserveLayoutWhenShuffling : Boolean
If true, preserves the layout of spreads that contained more than two pages when allow page shuffle was turned on.
DocumentPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
DocumentPreference
  slugBottomOffset : Object
The amount to offset the bottom slug.
DocumentPreference
  slugInsideOrLeftOffset : Object
The amount to offset the inside or left slug.
DocumentPreference
  slugRightOrOutsideOffset : Object
The amount to offset the outside or right slug.
DocumentPreference
  slugTopOffset : Object
The amount to offset the top slug.
DocumentPreference
  snippetImportUsesOriginalLocation : Boolean
If true, causes UI-based snippet import to use original location for page items.
DocumentPreference
  startPageNumber : Number
The starting page number for a document.
DocumentPreference
Public Methods
 MethodDefined By
  
addEventListenerDocumentPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
DocumentPreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 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
[override] Resolves the object specifier, creating an array of object references.
DocumentPreference
 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
 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
  
removeEventListenerDocumentPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
DocumentPreference
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
DocumentPreference
 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
allowPageShuffleproperty
allowPageShuffle:Boolean

If true, guarantees that when pages are added to a spread it will contain a maximum of two pages. If false, allows pages to be added or moved into existing spreads. For override information, see preserve layout when shuffling.


Implementation
    public function get allowPageShuffle():Boolean
    public function set allowPageShuffle(value:Boolean):void
columnDirectionproperty 
columnDirection:HorizontalOrVertical

The direction of text in the column.


Implementation
    public function get columnDirection():HorizontalOrVertical
    public function set columnDirection(value:HorizontalOrVertical):void
columnGuideColorproperty 
columnGuideColor:Object

The color of the column guides, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values,, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get columnGuideColor():Object
    public function set columnGuideColor(value:Object):void
columnGuideLockedproperty 
columnGuideLocked:Boolean

If true, locks column guides.


Implementation
    public function get columnGuideLocked():Boolean
    public function set columnGuideLocked(value:Boolean):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] [override]

A collection of event listeners.


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

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
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] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
marginGuideColorproperty 
marginGuideColor:Object

The color of the margin guides, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get marginGuideColor():Object
    public function set marginGuideColor(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
overprintBlackproperty 
overprintBlack:Boolean

If true, overprints black when saving the document.


Implementation
    public function get overprintBlack():Boolean
    public function set overprintBlack(value:Boolean):void
pageBindingproperty 
pageBinding:PageBindingOptions

The placement of the page binding.


Implementation
    public function get pageBinding():PageBindingOptions
    public function set pageBinding(value:PageBindingOptions):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:Object  [read-only] [override]

The parent of the DocumentPreference (a Application or Document).


Implementation
    public function get parent():Object
preserveLayoutWhenShufflingproperty 
preserveLayoutWhenShuffling:Boolean

If true, preserves the layout of spreads that contained more than two pages when allow page shuffle was turned on. If false, changes multi-page spreads to two-page spreads if the spreads were created or changed since allow page shuffle was turned on.


Implementation
    public function get preserveLayoutWhenShuffling():Boolean
    public function set preserveLayoutWhenShuffling(value:Boolean):void
propertiesproperty 
properties:Object[override]

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
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
snippetImportUsesOriginalLocationproperty 
snippetImportUsesOriginalLocation:Boolean

If true, causes UI-based snippet import to use original location for page items.


Implementation
    public function get snippetImportUsesOriginalLocation():Boolean
    public function set snippetImportUsesOriginalLocation(value:Boolean):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
Method Detail
addEventListenerDocumentPreference()method
public function addEventListenerDocumentPreference(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
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerDocumentPreference()method 
public function removeEventListenerDocumentPreference(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 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String