K4 InDesign Javascript API Documentation

BasicsScriptArg

Arguments to pass to a script.

Extends

Instance Properties

Name Description Access
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
parent Application The parent of the ScriptArg (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
clear(
)
get(
name)
  → string
getElements(
)
  → ScriptArg
getValue(
name)
  → string
isDefined(
name)
  → bool
removeEventListener(
eventType, handler ​[, captures])
  → bool
restore(
)
save(
)
set(
name, value)
setValue(
name, value)
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)
clear(
)
Clears all script arguments.
get(
name)
  → string
Gets the value of a script argument.
name string The name of the script argument.
getElements(
)
  → ScriptArg
Resolves the object specifier, creating an array of object references.
getValue(
name)
  → string
Gets the value of a script argument.
name string The name of the script argument.
isDefined(
name)
  → bool
Verifies whether the script argument is defined.
name string The name of the script argument.
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)
restore(
)
Restores all script arguments.
save(
)
Saves the script arguments.
set(
name, value)
Sets the value of a script argument.
name string The name of the script argument.
value string The value.
setValue(
name, value)
Sets the value of a script argument.
name string The name of the script argument.
value string The value.
toSource(
)
  → string
Generates a string which, if executed, will return the ScriptArg.
toSpecifier(
)
  → string
Retrieves the object specifier.