DocumentPreference

Document preferences.

DocumentPreference Properties

Property Type Access Description
allowPageShuffle Boolean r/w If false then adding a page to a spread always adds it to that spread. If true a page can be shuffled to a different spread.
columnGuideColor Array of 3 Reals (0 – 255), UIColors enumeration (see table at end of chapter) r/w The color of the column guides.
columnGuideLocked Boolean r/w If true, the column guides are locked.
documentBleedBottomOffset Unit r/w The bottom document bleed offset.
documentBleedInsideOrLeftOffset Unit r/w The left or inside document bleed offset.
documentBleedOutsideOrRightOffset Unit r/w The outside or right document bleed offset.
documentBleedTopOffset Unit r/w The top document bleed offset.
documentBleedUniformSize Boolean r/w If true, the document bleed is the same on all sides of the page.
documentSlugUniformSize Boolean r/w If true, the document slug is the same on all sides of the page.
facingPages Boolean r/w If true, the document has facing pages.
marginGuideColor Array of 3 Reals (0 – 255), UIColors enumeration (see table at end of chapter) r/w The color of margin guides.
overprintBlack Boolean r/w If true, overprint black.
pageHeight Unit r/w The height of the page.
pageOrientation PageOrientation enumeration r/w The orientation of the page.
pagesPerDocument Long r/w The number of pages in a document.
pageWidth Unit r/w The width of the page.
parent Object read The parent of the object.
preserveLayoutWhenShuffling Boolean r/w If true, then when setting ‘allow page shuffle’ and the document has spreads with a number of pages greater than the default, this layout is preserved. If false then the pages on these spreads get shuffled.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
slugBottomOffset Unit r/w The bottom slug offset.
slugInsideOrLeftOffset Unit r/w The inside or left slug offset.
slugRightOrOutsideOffset Unit r/w The right or outside slug offset.
slugTopOffset Unit r/w The top slug offset.

DocumentPreference Methods

Method Returns Description
getElements Array of Objects Resolve the object specifier.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: