Adobe InDesign CS6 (8.0) Object Model JS: GeneralPreference

InDesign CS6

Class

GeneralPreference

 General application preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
GeneralPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
applicationBarShownbool r/wIf true, application bar is shown.
autoCollapseIconPanelsbool r/wIf true, panel drawers close automatically.
autoShowHiddenPanelsbool r/wIf true, vertical reveal strips appear when palette UI is hidden.
completeFontDownloadGlyphLimitnumber r/wThe threshold at which to trigger font subsetting based on the number of glyphs the font contains.
createLinksOnContentPlacebool r/wEnable the creation of links on content place
customMonitorPpinumber r/wWhen using a custom monitor resolution, what is the value of that resolution in pixels per inch
enableFloatingWindowDockingbool r/wIf true, floating windows can be docked by user as tabs.
enableMultiTouchGesturesbool r/wControls whether or not multi-touch gestures are enabled.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
greekVectorGraphicsOnDragbool r/wControls whether or not to greek vector graphics when dragging at high quality.
highlightObjectUnderSelectionToolbool r/wControls whether or not to highlight object under selection tool.
includePreviewbool r/wIf true, includes a preview in saved documents.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
mainMonitorPpinumber readonlyThe value of the system reported main monitor resolution
mapStylesOnContentPlacebool r/wEnable the mapping of styles on content place
objectsMoveWithPagebool r/wControls whether page items move when a page is repositioned from the UI. The option/alt key temporarily reverses this property
openDocumentsAsTabsbool r/wIf true, documents open as tabs.
openRecentLengthnumber (range: 0 - 30) r/wNumber of items to show in the Open Recent menu list. Range: 0 to 30
pageNumberingPageNumberingOptions:
PageNumberingOptions.SECTION
PageNumberingOptions.ABSOLUTE
r/wThe page numbering method.
parentApplication readonlyThe parent of the GeneralPreference (a Application).
placeCursorUsesThumbnailsbool r/wControls whether or not to show thumbnails of imported files in the Place icon.
preventSelectingLockedItemsbool r/wControls whether or not you can select and interact with a locked item. When this is off, only position is locked.
previewPagesPreviewPagesOptions:
PreviewPagesOptions.FIRST_PAGE
PreviewPagesOptions.FIRST_2_PAGES
PreviewPagesOptions.FIRST_5_PAGES
PreviewPagesOptions.FIRST_10_PAGES
PreviewPagesOptions.ALL_PAGES
r/wThe pages to create preview images for. Note: Valid when include preview is true.
previewSizePreviewSizeOptions:
PreviewSizeOptions.SMALL
PreviewSizeOptions.MEDIUM
PreviewSizeOptions.LARGE
PreviewSizeOptions.EXTRA_LARGE
r/wThe preview size. Note: Valid when include preview is true.
propertiesObject r/wA property that allows setting of several properties at the same time.
showAnchorObjectAdornmentbool r/wControls whether or not the anchor object adornment is shown.
showContentGrabberbool r/wControls whether or not the content grabber adornment is shown.
showConveyorbool r/wShow the conveyor on content collector or content placer tool activation
showLiveCornersbool r/wControls whether or not the live corners grabber adornment is shown.
showMasterPageOverlaybool r/wControls whether or not to show the master page overlay when a page is selected using the Page Tool.
showTransformationValuesbool r/wControls whether or not to dynamically display transformation information as part of the cursor while manipulating page items.
temporaryFolderFile r/wThe location in which to store temporary files.
toolTipsToolTipOptions:
ToolTipOptions.NORMAL
ToolTipOptions.NONE
ToolTipOptions.FAST
r/wTool tip behavior.
toolsPanelToolsPanelOptions:
ToolsPanelOptions.SINGLE_COLUMN
ToolsPanelOptions.DOUBLE_COLUMN
ToolsPanelOptions.SINGLE_ROW
r/wControls the appearance of the Tools panel.
useApplicationFramebool r/wIf true, application lives in a frame.
useCustomMonitorResolutionbool r/wEnable the use of a custom monitor resolution in pixels per inch as opposed to querying the system settings

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of GeneralPreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the GeneralPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.generalPreferences

Return

Array of GeneralPreference GeneralPreference.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index