Adobe Photoshop CS5 Object Library JS: ActionDescriptor

Photoshop CS5

Class

ActionDescriptor

 A record of key-value pairs for actions, such as those included on the Adobe Photoshop Actions menu. The ActionDescriptor class is part of the Action Manager functionality. For more details on the Action Manager, see the Photoshop Scripting Guide.

QuickLinks

clear, erase, fromStream, getBoolean, getClass, getData, getDouble, getEnumerationType, getEnumerationValue, getInteger, getKey, getList, getObjectType, getObjectValue, getPath, getReference, getString, getType, getUnitDoubleType, getUnitDoubleValue, hasKey, isEqual, putBoolean, putClass, putData, putDouble, putEnumerated, putInteger, putList, putObject, putPath, putReference, putString, putUnitDouble, toStream

Properties

PropertyTypeAccessDescription
countint readonlyThe number of keys contained in the descriptor.

Class

PropertyTypeAccessDescription
countint readonlyThe number of keys contained in the descriptor.

Methods

Instances

void clear ()
Clears the descriptor.

void erase (key: number)
Erases a key from the descriptor.

ParameterTypeDescription
keynumber

void fromStream (value: string)
Creates a descriptor from a stream of bytes; for reading from disk.

ParameterTypeDescription
valuestring

bool getBoolean (key: number)
Gets the value of a key of type boolean.

ParameterTypeDescription
keynumber

number getClass (key: number)
Gets the value of a key of type class.

ParameterTypeDescription
keynumber

string getData (key: number)
Gets raw byte data as a string value.

ParameterTypeDescription
keynumber

number getDouble (key: number)
Gets the value of a key of type double.

ParameterTypeDescription
keynumber

number getEnumerationType (key: number)
Gets the enumeration type of a key.

ParameterTypeDescription
keynumber

number getEnumerationValue (key: number)
Gets the enumeration value of a key.

ParameterTypeDescription
keynumber

number getInteger (key: number)
Gets the value of a key of type integer.

ParameterTypeDescription
keynumber

number getKey (key: number)
Gets the ID of the Nth key, provided by index.

ParameterTypeDescription
keynumber

ActionList getList (key: number)
Gets the value of a key of type list.

ParameterTypeDescription
keynumber

number getObjectType (key: number)
Gets the class ID of an object in a key of type object.

ParameterTypeDescription
keynumber

ActionDescriptor getObjectValue (key: number)
Gets the value of a key of type object.

ParameterTypeDescription
keynumber

File getPath (key: number)
Gets the value of a key of type File.

ParameterTypeDescription
keynumber

ActionReference getReference (key: number)
Gets the value of a key of type ActionReference.

ParameterTypeDescription
keynumber

string getString (key: number)
Gets the value of a key of type string.

ParameterTypeDescription
keynumber

DescValueType getType (key: number)
Gets the type of a key.

ParameterTypeDescription
keynumber

number getUnitDoubleType (key: number)
Gets the unit type of a key of type UnitDouble.

ParameterTypeDescription
keynumber

number getUnitDoubleValue (key: number)
...

ParameterTypeDescription
keynumber

bool hasKey (key: number)
...

ParameterTypeDescription
keynumber

bool isEqual (otherDesc: ActionDescriptor)
...

ParameterTypeDescription
otherDescActionDescriptor

void putBoolean (key: number, value: bool)
...

ParameterTypeDescription
keynumber
valuebool

void putClass (key: number, value: number)
...

ParameterTypeDescription
keynumber
valuenumber

void putData (key: number, value: string)
...

ParameterTypeDescription
keynumber
valuestring

void putDouble (key: number, value: number)
...

ParameterTypeDescription
keynumber
valuenumber

void putEnumerated (key: number, enumType: number, value: number)
...

ParameterTypeDescription
keynumber
enumTypenumber
valuenumber

void putInteger (key: number, value: number)
...

ParameterTypeDescription
keynumber
valuenumber

void putList (key: number, value: ActionList)
...

ParameterTypeDescription
keynumber
valueActionList

void putObject (key: number, classID: number, value: ActionDescriptor)
...

ParameterTypeDescription
keynumber
classIDnumber
valueActionDescriptor

void putPath (key: number, value: File)
...

ParameterTypeDescription
keynumber
valueFile

void putReference (key: number, value: ActionReference)
...

ParameterTypeDescription
keynumber
valueActionReference

void putString (key: number, value: string)
...

ParameterTypeDescription
keynumber
valuestring

void putUnitDouble (key: number, unitID: number, value: number)
...

ParameterTypeDescription
keynumber
unitIDnumber
valuenumber

string toStream ()
...

Element of

Application.playbackParameters

Used in:

bool ActionDescriptor.isEqual (otherDesc: ActionDescriptor)

void ActionDescriptor.putObject (key: number, classID: number, value: ActionDescriptor)

ActionDescriptor Application.executeAction (eventID: int[, descriptor: ActionDescriptor][, displayDialogs: DialogModes])

void Application.putCustomOptions (key: string, customObject: ActionDescriptor[, persistent: bool=true])

Return

ActionDescriptor ActionDescriptor.getObjectValue (key: number)

ActionDescriptor Application.executeAction (eventID: int[, descriptor: ActionDescriptor][, displayDialogs: DialogModes])

ActionDescriptor Application.executeActionGet (reference: ActionReference)

ActionDescriptor Application.getCustomOptions (key: string)

Jongware, 28-Aug-2012 v3.0.3iContents :: Index