Document preferences.
document preference Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allow page shuffle | boolean | 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. |
| class | type | read | The class descriptor type. |
| column direction | horizontal, vertical, horizontal, vertical, horizontal, vertical, horizontal, vertical, |
read | The direction of text in the column |
| column guide color | 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: list of 3 fixed (0 – 255) or light blue/red/green/blue/yellow/magenta/cyan/gra… |
| column guide locked | boolean | r/w | If true, locks column guides. |
| document bleed bottom offset | 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. |
| document bleed inside or left offset | 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. |
| document bleed outside or right offset | 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. |
| document bleed top offset | number | r/w | The amount to offset the top document bleed. |
| document bleed uniform size | boolean | 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. |
| document slug uniform size | boolean | r/w | If true, uses the slug top offset value for slug measurements on all sides of the doucment. The default value is false. |
| facing pages | boolean | r/w | If true, the document has facing pages. |
| margin guide color | 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: list of 3 fixed (0 – 255) or light blue/red/green/blue/yellow/magenta/cyan/gray/bl… |
| master text frame | boolean | r/w | If true, the document A-master has auto textframes. |
| object reference | document preference | read | An object reference for the object. |
| overprint black | boolean | r/w | If true, overprints black when saving the document. |
| page binding | default, right to left, left to right, |
read | The page binding |
| page height | number | r/w | The height of the page. |
| page orientation | landscape, portrait, |
r/w | The page orientation. |
| page size | text | r/w | The size of the page. |
| page width | number | r/w | The width of the page. |
| pages per document | integer | r/w | The number of pages in the document. (Range: 1 to 9999) |
| parent | specifier | read | The parent of the document preference (a application or document). Can return: application or document. |
| preserve layout when shuffling | boolean | 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 | record | r/w | A property that allows setting of several properties at the same time. |
| slug bottom offset | number | r/w | The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false. |
| slug inside or left offset | 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. |
| slug right or outside offset | 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. |
| slug top offset | number | r/w | The amount to offset the top slug. |
| snippet import uses original location | boolean | r/w | If true, causes UI-based snippet import to use original location for page items. |