Class
Document preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
DocumentPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allowPageShuffle | bool | readonly | 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 |
r/w | 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) | readonly | 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) | readonly | 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) | readonly | 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) | readonly | The amount to offset the top document bleed. |
| documentBleedUniformSize | bool | readonly | 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 | readonly | 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 | bool | r/w | If true, the document has facing pages. |
| intent | DocumentIntentOptions: DocumentIntentOptions.PRINT_INTENT DocumentIntentOptions.WEB_INTENT |
readonly | The intent for a document. |
| 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 | readonly | If true, the document A-master has auto textframes. |
| overprintBlack | bool | readonly | If true, overprints black when saving the document. |
| pageBinding | PageBindingOptions: PageBindingOptions.DEFAULT_VALUE PageBindingOptions.RIGHT_TO_LEFT PageBindingOptions.LEFT_TO_RIGHT |
r/w | The placement of 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 | readonly | 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 | readonly | 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) | readonly | 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) | readonly | 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) | readonly | 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) | readonly | The amount to offset the top slug. |
| startPageNumber | number (range: 1 - 999999) | readonly | 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. |
| textAreaDepth | number | r/w | The depth of the text area. |
| textAreaDepthUnit | TextAreaDepthUnit: TextAreaDepthUnit.DEPTH_CHARS TextAreaDepthUnit.DEPTH_WORDS TextAreaDepthUnit.DEPTH_LINES TextAreaDepthUnit.DEPTH_COLUMN_INCHES TextAreaDepthUnit.DEPTH_PAGES |
r/w | The unit in which to measure the text area depth. |
| textAreaWidth | Measurement Unit (Number or String) | r/w | The width of the text area. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of DocumentPreference getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the DocumentPreference.
Element of
Application.documentPreferences
Document.documentPreferences
Return
Array of DocumentPreference DocumentPreference.getElements ()
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |