GeneralPreference

General application preferences.

Go to Property Listing | Method Listing

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, File, Number, Object, PageNumberingOptions, PreviewPagesOptions, PreviewSizeOptions, String, ToolTipOptions, ToolsPanelOptions

Hierarchy:

Superclass: Preference

Class: GeneralPreference

Property Listing

Property	Type	Access	Description
applicationBarShown	Boolean	readonly	If true, application bar is shown.
autoAddCharStyleToCCLibraries	Boolean	read/write	If true, on creating new char style through the new char style dialog, it will be exported to CC Libraries as well
autoAddParaStyleToCCLibraries	Boolean	read/write	If true, on creating new para style through the new para style dialog, it will be exported to CC Libraries as well
autoAddSwatchToCCLibraries	Boolean	read/write	If true, on creating new swatch through the new swatch dialog, it will be exported to CC Libraries as well
autoCollapseIconPanels	Boolean	read/write	If true, panel drawers close automatically.
autoShowHiddenPanels	Boolean	read/write	If true, vertical reveal strips appear when palette UI is hidden.
completeFontDownloadGlyphLimit	Number	read/write	The threshold at which to trigger font subsetting based on the number of glyphs the font contains.
createLinksOnContentPlace	Boolean	read/write	Enable the creation of links on content place
customMonitorPpi	Number	read/write	When using a custom monitor resolution, what is the value of that resolution in pixels per inch
enableContentAwareFit	Boolean	read/write	If true, enable content-aware fit as default while placing items
enableFloatingWindowDocking	Boolean	read/write	If true, floating windows can be docked by user as tabs.
enableMultiTouchGestures	Boolean	read/write	Controls whether or not multi-touch gestures are enabled.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
greekVectorGraphicsOnDrag	Boolean	read/write	Controls whether or not to greek vector graphics when dragging at high quality.
highlightObjectUnderSelectionTool	Boolean	read/write	Controls whether or not to highlight object under selection tool.
includePreview	Boolean	read/write	If true, includes a preview in saved documents.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
keyboardShortcutSet	String	read/write	keyboard shortcut set
mainMonitorPpi	Number	readonly	The value of the system reported main monitor resolution
mapStylesOnContentPlace	Boolean	read/write	Enable the mapping of styles on content place
objectsMoveWithPage	Boolean	read/write	Controls whether page items move when a page is repositioned from the UI. The option/alt key temporarily reverses this property
openDocumentsAsTabs	Boolean	read/write	If true, documents open as tabs.
openRecentLength	Number (range 0 - 30)	read/write	Number of items to show in the Open Recent menu list. Range: 0 to 30
pageNumbering	PageNumberingOptions PageNumberingOptions.ABSOLUTE PageNumberingOptions.SECTION	read/write	The page numbering method.
panelTabHeightPreference	Boolean	read/write	If true, Large Tabs are shown for panels else Smaller tabs are shown
parent	Application	readonly	The parent of the GeneralPreference (a Application).
pasteboardColorPreference	Number	read/write	Specify the Pasteboard color preference (0 or 1). Specify 0 to set preference to Default White, and 1 to set preference to Match with Theme Color.
placeCursorUsesThumbnails	Boolean	read/write	Controls whether or not to show thumbnails of imported files in the Place icon.
preventSelectingLockedItems	Boolean	read/write	Controls whether or not you can select and interact with a locked item. When this is off, only position is locked.
previewPages	PreviewPagesOptions PreviewPagesOptions.ALL_PAGES PreviewPagesOptions.FIRST_10_PAGES PreviewPagesOptions.FIRST_2_PAGES PreviewPagesOptions.FIRST_5_PAGES PreviewPagesOptions.FIRST_PAGE	read/write	The pages to create preview images for. Note: Valid when include preview is true.
previewSize	PreviewSizeOptions PreviewSizeOptions.EXTRA_LARGE PreviewSizeOptions.LARGE PreviewSizeOptions.MEDIUM PreviewSizeOptions.SMALL	read/write	The preview size. Note: Valid when include preview is true.
properties	Object	read/write	A property that allows setting of several properties at the same time.
setActiveWorkspace	String	read/write	set active workspace
showAnchorObjectAdornment	Boolean	read/write	Controls whether or not the anchor object adornment is shown.
showContentGrabber	Boolean	read/write	Controls whether or not the content grabber adornment is shown.
showConveyor	Boolean	read/write	Show the conveyor on content collector or content placer tool activation
showLegacyNewDocumentDialog	Boolean	read/write	If true, legacy new document dialog will be shown when Ctrl/Cmd + N are pressed.
showLiveCorners	Boolean	read/write	Controls whether or not the live corners grabber adornment is shown.
showMasterPageOverlay	Boolean	read/write	Controls whether or not to show the master page overlay when a page is selected using the Page Tool.
showStartWorkspace	Boolean	read/write	If true, show start workspace when no documents are open
showStockPurchaseAdornment	Boolean	read/write	If true, show stock cart adornment on unlicensed stock images
showTransformationValues	Boolean	read/write	Controls whether or not to dynamically display transformation information as part of the cursor while manipulating page items.
showWhatsNewOnStartup	Boolean	read/write	If true, show What's New dialog on startup.
temporaryFolder	File	read/write	The location in which to store temporary files.
toolTips	ToolTipOptions ToolTipOptions.FAST ToolTipOptions.NONE ToolTipOptions.NORMAL	read/write	Tool tip behavior.
toolsPanel	ToolsPanelOptions ToolsPanelOptions.DOUBLE_COLUMN ToolsPanelOptions.SINGLE_COLUMN ToolsPanelOptions.SINGLE_ROW	read/write	Controls the appearance of the Tools panel.
uiBrightnessPreference	Number	read/write	Specify the Application User Interface brightness preference (from 0.0 to 1.0). To use color theme brightness preset values, specify 0.0 for Dark, 0.50 for Medium Dark, 0.51 for Medium Bright, and 1.0 for Bright. Any value between 0.0 and 1.0 will automatically be mapped to closest preset.
ungroupRemembersLayers	Boolean	read/write	If true, objects after ungrouping go back to their original layers.
useApplicationFrame	Boolean	readonly	If true, application lives in a frame.
useCustomMonitorResolution	Boolean	read/write	Enable the use of a custom monitor resolution in pixels per inch as opposed to querying the system settings
useIncomingSpotUponConflict	Boolean	read/write	If true, use incoming spot color definition in case of conflict, when placing or pasting content

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

GeneralPreference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)