DocumentPreference

Document preferences.

Properties

Property Type Access Description
allowPageShuffle bool r/w If true, guarantees that all new spreads added to the document 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
:
HORIZONTAL
VERTICAL
readonly The direction of text in the column
columnGuideColor any 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 number 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 number 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 number 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 number 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.
marginGuideColor any 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
:
DEFAULT_VALUE
RIGHT_TO_LEFT
LEFT_TO_RIGHT
readonly The page binding
pageHeight number r/w The height of the page.
pageOrientation PageOrientation
:
LANDSCAPE
PORTRAIT
r/w The page orientation.
pageSize string r/w The size of the page.
pagesPerDocument number r/w The number of pages in the document. (Range: 1 to 9999)
pageWidth number r/w The width of the page.
parent any 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 number r/w The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.
slugInsideOrLeftOffset number 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 number 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 number r/w The amount to offset the top slug.

Methods

Array of DocumentPreferencegetElements ()
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

Returned by:

Array of DocumentPreference DocumentPreference .getElements (

)

Leave a Comment

Previous post:

Next post: