K4 InDesign Javascript API Documentation

PreferencesColorSetting

Color management settings.

Extends

Instance Properties

Name Description Access
accurateLABSpots bool If true, uses LAB alternates for spot colors when available. read-write
cmsSettings string The current color management system settings configuration. Note: For information on possible values, see CMS settings list. read-write
cmsSettingsList string A list of valid color management system settings configurations. read-only
cmsSettingsPath File The file path of the CSF file to use. read-write
cmykPolicy ColorSettingsPolicy The policy for handling colors in a CMYK color model, including reading and embedding color profiles, resolving mismatches between embedded color profiles and the working space, and moving colors between documents. read-write
enableColorManagement bool If true, enables color management. read-write
engine string The color management module (CMM) for mapping color space gamuts between documents. read-write
engineList string The available color engines. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
idealizedBlackToExport bool If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to print or export. read-write
idealizedBlackToScreen bool If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to the screen. read-write
intent DefaultRenderingIntent The default rendering intent. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
mismatchAskWhenOpening bool If true, displays a prompt when opening a file whose embedded color profile does not match the current working space. The prompt provides the option to override the default mismatch behavior. read-write
mismatchAskWhenPasting bool If true, displays a prompt when importing an object (via pasting, drag-and-drop, or other similar methods) whose colors do not match the current working space. The prompt provides the option to override the default mismatch behavior. read-write
missingAskWhenOpening bool If true, displays a prompt when opening a file that does not have an embedded color profile. The prompt provides the option to assign a color profile. read-write
parent Application The parent of the ColorSetting (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
rgbPolicy ColorSettingsPolicy The policy for handling colors in an RGB color model, including reading and embedding color profiles, handling mismatches between embedded color profiles and the working space, and moving colors from one document to another. read-write
useBPC bool If true, uses black point compensation to ensure that shadow detail is preserved by simulating the full dynamic range of the output device. read-write
workingSpaceCMYK string The current CMYK profile. read-write
workingSpaceCMYKList string A list of valid CMYK color profiles. read-only
workingSpaceRGB string The current RGB profile. read-write
workingSpaceRGBList string A list of valid RGB color profiles. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → ColorSetting
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(
)
  → ColorSetting
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 ColorSetting.
toSpecifier(
)
  → string
Retrieves the object specifier.