K4 InDesign Javascript API Documentation

PreferencesGeneralPreference

General application preferences.

Extends

Instance Properties

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

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → GeneralPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → GeneralPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the GeneralPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.