DocumentPreference

Document preferences.

Go to Property Listing | Method Listing

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, DocumentIntentOptions, EventListeners, Events, HorizontalOrVertical, Number, Object, PageBindingOptions, PageOrientation, String, UIColors,

Hierarchy:

Superclass: Preference

Class: DocumentPreference

Property Listing

Property	Type	Access	Description
allowPageShuffle	Boolean	read/write	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.
columnDirection	HorizontalOrVertical HorizontalOrVertical.HORIZONTAL HorizontalOrVertical.VERTICAL	read/write	The direction of text in the column.
columnGuideColor	Array of 3 Reals (0 - 255) UIColors	read/write	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.
columnGuideLocked	Boolean	read/write	If true, locks column guides.
createPrimaryTextFrame	Boolean	read/write	If true, the document A-master has primary text frames when a new document is created.
documentBleedBottomOffset	Number String	read/write	The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false.
documentBleedInsideOrLeftOffset	Number String	read/write	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.
documentBleedOutsideOrRightOffset	Number String	read/write	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.
documentBleedTopOffset	Number String	read/write	The amount to offset the top document bleed.
documentBleedUniformSize	Boolean	read/write	If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document. The default setting is true.
documentSlugUniformSize	Boolean	read/write	If true, uses the slug top offset value for slug measurements on all sides of the document. The default value is false.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
facingPages	Boolean	read/write	If true, the document has facing pages.
intent	DocumentIntentOptions DocumentIntentOptions.MOBILE_INTENT DocumentIntentOptions.PRINT_INTENT DocumentIntentOptions.WEB_INTENT	read/write	The intent for a document.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
marginGuideColor	Array of 3 Reals (0 - 255) UIColors	read/write	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.
overprintBlack	Boolean	read/write	If true, overprints black when saving the document.
pageBinding	PageBindingOptions PageBindingOptions.DEFAULT_VALUE PageBindingOptions.LEFT_TO_RIGHT PageBindingOptions.RIGHT_TO_LEFT	read/write	The placement of the page binding.
pageHeight	Number String	read/write	The height of the page.
pageOrientation	PageOrientation PageOrientation.LANDSCAPE PageOrientation.PORTRAIT	read/write	The page orientation.
pageSize	String	read/write	The size of the page.
pageWidth	Number String	read/write	The width of the page.
pagesPerDocument	Number (range 1 - 9999)	read/write	The number of pages in the document. (Range: 1 to 9999)
parent	Application Document	readonly	The parent of the DocumentPreference (a Application or Document).
preserveLayoutWhenShuffling	Boolean	read/write	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.
properties	Object	read/write	A property that allows setting of several properties at the same time.
slugBottomOffset	Number String	read/write	The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.
slugInsideOrLeftOffset	Number String	read/write	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.
slugRightOrOutsideOffset	Number String	read/write	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.
slugTopOffset	Number String	read/write	The amount to offset the top slug.
snippetImportUsesOriginalLocation	Boolean	read/write	If true, causes UI-based snippet import to use original location for page items.
startPageNumber	Number (range 1 - 999999)	read/write	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.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

DocumentPreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)