Class

DocumentPreference

 Document preferences. Base Class: Preference

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

Application | Document

Preference

DocumentPreference

Properties

Property	Type	Access	Description
allowPageShuffle	bool	r/w	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	readonly	The direction of text in the column
columnGuideColor	3 Reals (0 - 255) UIColors	r/w	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	bool	r/w	If true, locks column guides.
documentBleedBottomOffset	Measurement Unit (Number or String)	r/w	The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false.
documentBleedInsideOrLeftOffset	Measurement Unit (Number or String)	r/w	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	Measurement Unit (Number or String)	r/w	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	Measurement Unit (Number or String)	r/w	The amount to offset the top document bleed.
documentBleedUniformSize	bool	r/w	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	bool	r/w	If true, uses the slug top offset value for slug measurements on all sides of the doucment. The default value is false.
facingPages	bool	r/w	If true, the document has facing pages.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
marginGuideColor	3 Reals (0 - 255) UIColors	r/w	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.
masterTextFrame	bool	r/w	If true, the document A-master has auto textframes.
overprintBlack	bool	r/w	If true, overprints black when saving the document.
pageBinding	PageBindingOptions: PageBindingOptions.DEFAULT_VALUE PageBindingOptions.RIGHT_TO_LEFT PageBindingOptions.LEFT_TO_RIGHT	readonly	The page binding
pageHeight	Measurement Unit (Number or String)	r/w	The height of the page.
pageOrientation	PageOrientation: PageOrientation.LANDSCAPE PageOrientation.PORTRAIT	r/w	The page orientation.
pageSize	string	r/w	The size of the page.
pageWidth	Measurement Unit (Number or String)	r/w	The width of the page.
pagesPerDocument	number	r/w	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	bool	r/w	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	r/w	A property that allows setting of several properties at the same time.
slugBottomOffset	Measurement Unit (Number or String)	r/w	The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.
slugInsideOrLeftOffset	Measurement Unit (Number or String)	r/w	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	Measurement Unit (Number or String)	r/w	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	Measurement Unit (Number or String)	r/w	The amount to offset the top slug.
snippetImportUsesOriginalLocation	bool	r/w	If true, causes UI-based snippet import to use original location for page items.

Methods

Instances

Array of DocumentPreference getElements ()
Resolves the object specifier, creating an array of object references.

string toSource ()
Generates a string which, if executed, will return the DocumentPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.documentPreferences

Document.documentPreferences

Return

Array of DocumentPreference DocumentPreference.getElements ()

Jongware, 20-Jun-2010 v3.0.3d

Contents :: Index