K4 InDesign Javascript API Documentation

PreferencesScriptPreference

Scripting environment preferences.

Extends

Instance Properties

Name Description Access
enableRedraw bool If true, enables redraw during script execution. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
measurementUnit The measurement unit used during script processing. Can return: AutoEnum enumerator or MeasurementUnits enumerator. read-write
parent Application The parent of the ScriptPreference (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
scriptsFolder File The path to the Scripts folder for the application. read-only
scriptsList A list of the scripts in the Scripts folder. Can return: Array of Array of 2 Strings or Files. read-only
userInteractionLevel UserInteractionLevels Controls the display of dialogs and alerts during script processing. read-write
version string The version of the scripting environment. Can also accept: Real. read-write

Methods

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