Adobe Photoshop CS5 Object Library JS: ActionDescriptor

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

Property	Type	Access	Description
count	int	readonly	The number of keys contained in the descriptor.

Class

Property	Type	Access	Description
count	int	readonly	The number of keys contained in the descriptor.

Methods

Instances

void clear ()
Clears the descriptor.

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
value	string

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

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

Parameter	Type	Description
key	number

number getUnitDoubleValue (key: number)
...

Parameter	Type	Description
key	number

bool hasKey (key: number)
...

Parameter	Type	Description
key	number

bool isEqual (otherDesc: ActionDescriptor)
...

Parameter	Type	Description
otherDesc	ActionDescriptor

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

Parameter	Type	Description
key	number
value	bool

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

Parameter	Type	Description
key	number
value	number

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

Parameter	Type	Description
key	number
value	string

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

Parameter	Type	Description
key	number
value	number

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

Parameter	Type	Description
key	number
enumType	number
value	number

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

Parameter	Type	Description
key	number
value	number

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

Parameter	Type	Description
key	number
value	ActionList

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

Parameter	Type	Description
key	number
classID	number
value	ActionDescriptor

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

Parameter	Type	Description
key	number
value	File

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

Parameter	Type	Description
key	number
value	ActionReference

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

Parameter	Type	Description
key	number
value	string

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

Parameter	Type	Description
key	number
unitID	number
value	number

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.3i

Contents :: Index