Adobe InCopy CS5 (7.0) Object Model JS: ScriptPreference

InCopy CS5

Class

ScriptPreference

 Scripting environment preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
ScriptPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
enableRedrawbool r/wIf true, enables redraw during script execution.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
measurementUnitAutoEnumMeasurementUnits r/wThe measurement unit used during script processing. Can return: AutoEnum enumerator or MeasurementUnits enumerator.
parentApplication readonlyThe parent of the ScriptPreference (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
scriptsFolderFile readonlyThe path to the Scripts folder for the application.
scriptsList Array of
Array of 2 Strings
Files
readonlyA list of the scripts in the Scripts folder. Can return: Array of Array of 2 Strings or Files.
userInteractionLevelUserInteractionLevels:
UserInteractionLevels.NEVER_INTERACT
UserInteractionLevels.INTERACT_WITH_ALL
UserInteractionLevels.INTERACT_WITH_ALERTS
r/wControls the display of dialogs and alerts during script processing.
versionstring r/wThe version of the scripting environment. Can also accept: Real.

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 ScriptPreference 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 ScriptPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.scriptPreferences

Return

Array of ScriptPreference ScriptPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index