K4 InDesign Javascript API Documentation

PreferencesDocumentPreference

Document preferences.

Extends

Instance Properties

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

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → DocumentPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → DocumentPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the DocumentPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.