Home » Adobe Manuals » Computer Software » Adobe 23102480 » Manual Viewer

Adobe 23102480 Scripting Guide - Page 17

Creating and Running a JavaScript, File > Scripts

UPC - 883919080222

Add to My Manuals
Save this manual to your list of manuals

Page 17 highlights

Adobe Photoshop CS3 Scripting Guide Photoshop CS3 Photoshop CS3 Scripting Basics 17 appRef.Preferences.RulerUnits = originalRulerUnits 2. Save file as a text file with a .vbs file name extension. 3. Double-click the file in Windows Explorer to run the script. The script opens Photoshop CS3. Creating and Running a JavaScript Follow these steps to create and run a JavaScript that displays the text Hello World! in a Photoshop CS3 document. Because you will be actually using Photoshop CS3 to run your JavaScripts, it is not necessary to include code that opens Photoshop CS3 at the beginning of the script. Note: Adobe has created the Extend Script scripting language to augment JavaScript for use with Photoshop CS3. You can use the Extend Script command #target to target the Photoshop CS3 application and create the ability to open JavaScripts that manipulate Photoshop CS3 from anywhere in your file system. See the "Script UI" chapter of the JavaScript Tools Guide for more information. ➤ To create and run your first Photoshop CS3 JavaScript: 1. Type the following script. Note: Entering comments is optional. // Hello Word Script // Remember current unit settings and then set units to // the value expected by this script var originalUnit = preferences.rulerUnits preferences.rulerUnits = Units.INCHES // Create a new 2x4 inch document and assign it to a variable var docRef = app.documents.add( 2, 4 ) // Create a new art layer containing text var artLayerRef = docRef.artLayers.add() artLayerRef.kind = LayerKind.TEXT // Set the contents of the text layer. var textItemRef = artLayerRef.textItem textItemRef.contents = "Hello, World" // Release references docRef = null artLayerRef = null textItemRef = null // Restore original ruler unit setting app.preferences.rulerUnits = originalUnit 2. Save file as a text file with a .jsx file name extension in the Presets/Scripts folder in your Adobe Photoshop CS3 directory. Note: You must place your JavaScripts in the Presets/Scripts folder in order to make the scripts accessible from the File > Scripts menu in Photoshop CS3. The scripts do not appear on the File > Scripts menu until you restart the application.

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

Match case Limit results 1 per page

Photoshop CS3

Adobe Photoshop CS3

Scripting Guide

Photoshop CS3 Scripting Basics

appRef.Preferences.RulerUnits = originalRulerUnits

Save file as a text file with a

.vbs

file name extension.

Double-click the file in Windows Explorer to run the script.

The script opens Photoshop CS3.

Creating and Running a JavaScript

Follow these steps to create and run a JavaScript that displays the text

Hello World!

in a Photoshop CS3

document.

Because you will be actually using Photoshop CS3 to run your JavaScripts, it is not necessary to include

code that opens Photoshop CS3 at the beginning of the script.

Note:

Adobe has created the Extend Script scripting language to augment JavaScript for use with

Photoshop CS3. You can use the Extend Script command

#target

to target the Photoshop CS3

application and create the ability to open JavaScripts that manipulate Photoshop CS3 from

anywhere in your file system. See the “Script UI” chapter of the

JavaScript Tools Guide

for more

information.

➤

To create and run your first Photoshop CS3 JavaScript:

Type the following script.

Note:

Entering comments is optional.

// Hello Word Script

// Remember current unit settings and then set units to

// the value expected by this script

var originalUnit = preferences.rulerUnits

preferences.rulerUnits = Units.INCHES

// Create a new 2x4 inch document and assign it to a variable

var docRef = app.documents.add( 2, 4 )

// Create a new art layer containing text

var artLayerRef = docRef.artLayers.add()

artLayerRef.kind = LayerKind.TEXT

// Set the contents of the text layer.

var textItemRef = artLayerRef.textItem

textItemRef.contents = "Hello, World"

// Release references

docRef = null

artLayerRef = null

textItemRef = null

// Restore original ruler unit setting

app.preferences.rulerUnits = originalUnit

Save file as a text file with a

.jsx

file name extension in the Presets/Scripts folder in your Adobe

Photoshop CS3 directory.

Note:

You must place your JavaScripts in the Presets/Scripts folder in order to make the scripts

accessible from the

File > Scripts

menu in Photoshop CS3. The scripts do not appear on the

File

> Scripts

menu until you restart the application.