Adobe InDesign CS2 (4.0) Object Model JS: ScriptArg

InDesign CS2

Class

ScriptArg

 Arguments to pass to a script.

QuickLinks

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

Hierarchy

Application
ScriptArg

Properties

PropertyTypeAccessDescription
parentApplication readonlyThe parent of the ScriptArg (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

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

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

Jongware, 27-Jun-2010 v3.0.3dContents :: Index