Adobe InDesign CS6 (8.0) Object Model JS: ScriptArg

InDesign CS6

Class

ScriptArg

 Arguments to pass to a script. Base Class: Preference

QuickLinks

addEventListener, clear, get, getElements, getValue, isDefined, removeEventListener, restore, save, set, setValue, toSource, toSpecifier

Hierarchy

Application
Preference
ScriptArg
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication readonlyThe parent of the ScriptArg (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.

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)

void clear ()
Clears all script arguments.

string get (name: string)
Gets the value of a script argument.

ParameterTypeDescription
namestringThe name of the script argument.

Array of ScriptArg getElements ()
Resolves the object specifier, creating an array of object references.

string getValue (name: string)
Gets the value of a script argument.

ParameterTypeDescription
namestringThe name of the script argument.

bool isDefined (name: string)
Verifies whether the script argument is defined.

ParameterTypeDescription
namestringThe name of the script argument.

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)

void restore ()
Restores all script arguments.

void save ()
Saves the script arguments.

void set (name: string, value: string)
Sets the value of a script argument.

ParameterTypeDescription
namestringThe name of the script argument.
valuestringThe value.

void setValue (name: string, value: string)
Sets the value of a script argument.

ParameterTypeDescription
namestringThe name of the script argument.
valuestringThe value.

string toSource ()
Generates a string which, if executed, will return the ScriptArg.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.scriptArgs

Return

Array of ScriptArg ScriptArg.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index