Adobe 23102480 Scripting Guide - Page 79

Photoshop CS3

Adobe Photoshop CS3

Scripting Guide

Action Manager

79

desc7.putInteger( id34, height );

var id35 = charIDToTypeID( "Amnt" );

desc7.putInteger( id35, amount );

executeAction( id32, desc7 );

}

2.

At the end of the file

emboss.jsx

, add the following line of JavaScript code, which executes the

emboss function with arguments passed to it from an external invocation. See

Introduction to Scripting

for more information about passing arguments from a AppleScript to a JavaScript.

// Call emboss with values provided in the "arguments" collection

emboss( arguments[0], arguments[1], arguments[2] );

3.

The following AppleScript code sample opens a document and runs the Emboss filter on it:

tell application "Adobe Photoshop CS3"

set theFile to alias “Application:Documents:MyFile”

open theFile

do javascript (file <

path to Emboss.jsx

>) ¬

with arguments { 75,2,89 }

end tell

Using ScriptListener to find event IDs and class IDs

The section demonstrates how to use ScriptListener to determine event IDs and class IDs for actions taken

by Photoshop CS3. These event and class IDs are used to set up notification using the

Notifier Class

.

You can determine the event ID for any recordable action by using ScriptListener. Simply install the

ScriptListener plug in, as described in

‘Installing ScriptListener’ on page 72

. Then execute the action you

want to find the event ID for. The event is logged in the Script Listener log file. (See

‘The ScriptListener

Plug-In’ on page 72

) If the event applies to several different classes of objects, the class ID is also logged in

the log file.

The following examples show how to find the event ID for the “Open Document” event, and the event and

class IDs for the “New” event, which applies to several different classes.

➤

Finding the event ID for the “Open Document” event

1.

Make sure that the ScriptListener plug in is installed.

2.

Open Photoshop CS3, then open a document.

3.

Find the ScriptListener log file and open it. You can use either the VBScript log file or the JavaScript log

file. In the JavaScript version of the file, you will see code that looks something like this at the end of the

file, everything below the row of equal signs the log of the last action taken:

// =======================================================

var id14 = charIDToTypeID( "Opn " );

var desc5 = new ActionDescriptor();

var id15 = charIDToTypeID( "null" );

desc5.putPath( id15, new File( "C:\\Program Files\\Adobe\\Adobe Photoshop

CS3\\Samples\\Fish.psd" ) );

executeAction( id14, desc5, DialogModes.NO );

4.

The

executeAction

method runs the action from a script, and it needs the event ID to identify which

action to take. The first argument, in this case

id14

, provides the event ID to the method. You can see

the variable

id14

defined several lines earlier, and it shows that the event ID for the Open Document

action is

"Opn ".

Section	Page
Contents	3
Introduction	5
About this manual	5
Conventions in this guide	5
Photoshop CS3 Scripting Basics	7
Scripting Overview	7
Why use scripts instead of actions?	7
Scripting Support in Photoshop CS3	8
JavaScript Support	8
Executing other scripts	9
Startup Scripts	9
Executing JavaScripts from AS or VBS	9
Photoshop CS3 Object Model	9
Containment Hierarchy	10
Application and Document Classes	10
Layer Classes	11
Layer Comp Class	11
Channel Class	11
Selection Class	11
History State Class	12
Document Info Class	12
Path Item, Sub Path Item, and Path Point Classes	12
Preferences Class	12
Notifier Class	12
Count Item Class	12
Color Sampler Class	12
Measurement Scale Class	12
The Containment Hierarchy and the Photoshop CS3 User Interface	12
Additional Objects	14
Constants	14
Creating a Sample Hello World Script	15
Creating and Running an AppleScript	15
Creating and Running a VBScript	16
Creating and Running a JavaScript	17
Scripting Photoshop CS3	19
Viewing Photoshop CS3 Objects, Commands, and Methods	19
Viewing Photoshop CS3’s AppleScript Dictionary	19
Viewing Photoshop CS3’s Type Library (VBS)	20
Targeting and Referencing the Application Object	20
Creating New Objects in a Script	21
Setting the Active Object	23
Setting the Active Document	24
Setting the Active Layer	25
Setting the Active Channels	25
Opening a Document	26
Opening a File with Default File Format	26
Specifying File Formats to Open	27
Saving a Document	29
Setting Application Preferences	30
Allowing or Preventing Dialogs	31
Working with the Photoshop CS3 Object Model	31
Using the Application Object	31
Using the Document Object	32
Manipulating a Document Object	32
Working with Layer Objects	34
Creating an ArtLayer Object	34
Creating a Layer Set Object	35
Referencing ArtLayer Objects	36
Working with Layer Set Objects	37
Linking Layer Objects	38
AS	38
VBS	38
JS	38
Applying Styles to Layers	38
Using the Text Item Object	39
Determining a Layer’s Kind	40
Adding and Manipulating Text in a Text Item Object	40
Working with Selection Objects	41
Creating and Defining a Selection	41
Stroking the Selection Border	42
Inverting Selections	43
Expanding, Contracting, and Feathering Selections	43
Filling a Selection	43
Loading and Storing Selections	44
Working with Channel Objects	45
Changing Channel Types	45
Using the Document Info Object	46
Using History State Objects	46
Using Notifier Objects	47
Using the PathItem Object	48
Working with Color Objects	50
Solid Color Classes	51
Using Hex Values for RGB Color	51
Getting and Converting Colors	51
Comparing Colors	52
Getting a Web Safe Color	52
Working with Filters	53
AS	53
VBS	53
JS	53
Other Filters	53
Understanding Clipboard Interaction	54
Using the Copy and Paste commands	54
Using the Copy Merged Command/Method	55
Working with Units	55
Unit Values	56
Special Unit Value Types	56
AppleScript Unit Considerations	56
Using Unit Values in Calculations	57
Unit Value Usage	57
Setting Ruler and Type Units in a Script	59
Sample Workflow Automation JavaScripts	59
Advanced Scripting	60
Working with Document Preferences	60
Applying Color to a Text Item	63
Applying a Wave Filter	66
Defining the Area of a Selection Object	66
Applying a MotionBlur Filter	69
Action Manager	72
The ScriptListener Plug-In	72
Installing ScriptListener	72
Action Manager Scripting Objects	73
Recording a Script using ScriptListener	73
Using the Action Manager from JavaScript	74
Using the Action Manager from a VBS Script	75
Running JavaScript-based Action Manager code from VBScript	78
Running JavaScript-based Action Manager code from AppleScript	78
Using ScriptListener to find event IDs and class IDs	79

Adobe 23102480 Scripting Guide - Page 79

Using ScriptListener to find event IDs and class IDs

Page 79 highlights