Adobe 65048599 Scripting Guide - Page 54

C

HAPTER

3: Scripting Photoshop

Understanding Clipboard Interaction

54

AS

Use the

filter

command and then both specify the layer and the name of the filter and any options.

filter current layer of current document using gaussian blur ¬

with options {radius:5}

N

OTE

:

In the

Adobe Photoshop CS5 AppleScript Scripting Reference

, or in the Photoshop AppleScript

Dictionary, look up the

filter

command; also look up class

filter

options

.

VBS

appRef.docRef.ActiveLayer.ApplyGaussianBlur 5

N

OTE

:

In the

Adobe Photoshop CS5 Visual Basic Scripting Reference

, on in the Visual Basic Object Browser

look up the

ApplyGaussianBlur

method and other methods of the

ArtLayer

object whose name begins

with “

Apply

.”

JS

docRef.activeLayer.applyGaussianBlur(5)

N

OTE

:

In the

Adobe Photoshop CS5 JavaScript Scripting Reference

, or in the ExtendScript Object Model

Viewer look up the

applyGaussianBlur()

method and other methods of the

artLayer

object whose

name begins with “

apply

.”

Other filters

If the filter type that you want to use on your layer is not part of the scripting interface, you can use the

Action Manager from a JavaScript to run a filter. If you are using AppleScript or VBScript, you can run the

JavaScript from your script. See

“Action Manager” on page 73

for information on using the Action

Manager. Also, see

“Executing JavaScripts from AS or VBS” on page 10

.

Understanding Clipboard Interaction

The clipboard commands in Photoshop operate on

ArtLayer

,

Selection

, and

Document

objects. The

commands can be used to operate on objects within a single document, or to move information between

documents.

The clipboard commands of the

art layer (ArtLayer/ArtLayer)

and

selection

(Selection/Selection)

objects are:

➤

copy

(Copy/copy)

➤

copy

merged

(Copy

Merge

parameter

value/copy(merge

parameter

value))

➤

cut(Cut/cut)

The clipboard commands of the

document/Document/Document

object are:

➤

paste

(Paste/paste)

➤

paste

into

(Paste

IntoSelection

parameter

value/paste(intoSelection

parameter

value))

N

OTE

:

For information on copy, copy merged, paste, paste into, and cut functions, see Photoshop Help.

Using the copy and paste commands

The following examples copy the contents of the background layer to the clipboard, create a new

document, and then paste the clipboard contents to the new document. The scripts assume that there is a

document already open in Photoshop and that the document has a background layer.

Section	Page
Adobe® Creative Suite® 5 Photoshop® Scripting Guide	2
Introduction	6
About this Manual	6
Conventions in this Guide	6
Photoshop Scripting Basics	8
Scripting Overview	8
Why use scripts instead of actions?	8
Scripting Support in Photoshop	9
JavaScript support	9
Executing other scripts	10
Startup scripts	10
Executing JavaScripts from AS or VBS	10
Photoshop Object Model	11
Containment hierarchy	11
Application and document classes	12
Layer classes	12
Layer Comp class	13
Channel class	13
Selection class	13
History State class	13
Document Info class	13
Path Item, Sub Path Item, and Path Point classes	14
Preferences class	14
Notifier class	14
Count Item class	14
Color Sampler class	14
Measurement Scale class	14
The containment hierarchy and the Photoshop user interface	14
Additional objects	16
Constants	16
Creating a sample Hello World script	17
Creating and running an AppleScript	18
Creating and running a VBScript	19
Creating and running a JavaScript	19
Scripting Photoshop	21
Viewing Photoshop Objects, Commands, and Methods	21
Viewing Photoshop’s AppleScript dictionary	21
Viewing Photoshop’s type library (VBS)	22
Targeting and Referencing the Application Object	22
Creating New Objects in a Script	23
Setting the Active Object	25
Setting the active document	26
Setting the active layer	27
Setting the active channels	28
Opening a Document	28
Opening a file with default file format	28
Specifying file formats to open	29
Saving a Document	31
Setting Application Preferences	32
Allowing or Preventing Dialogs	33
Working with the Photoshop Object Model	33
Using the Application object	34
Using the Document object	34
Manipulating a document object	35
Working with layer objects	36
Creating an ArtLayer object	37
Creating a Layer Set object	38
Referencing ArtLayer objects	38
Working with Layer Set objects	39
Linking layer objects	40
Applying styles to layers	40
Using the Text Item object	41
Determining a layer’s kind	41
Adding and manipulating text in a Text Item object	42
Working with Selection objects	42
Creating and defining a selection	43
Stroking the selection border	44
Inverting selections	44
Expanding, contracting, and feathering selections	44
Filling a selection	45
Loading and storing selections	45
Working with Channel objects	46
Changing channel types	46
Using the Document Info object	47
Using history state objects	47
Using Notifier objects	48
Using the PathItem object	49
Working with color objects	51
Solid color classes	52
Using hex values for RGB color	52
Getting and converting colors	52
Comparing colors	53
Getting a Web-safe color	53
Working with Filters	53
Other filters	54
Understanding Clipboard Interaction	54
Using the copy and paste commands	54
Using the copy merged command/method	55
Working with Units	56
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	60
Advanced Scripting	60
Working with document preferences	61
Applying color to a text item	64
Applying a wave filter	66
Defining the area of a selection object	67
Applying a MotionBlur filter	71
Action Manager	73
The ScriptListener Plug-In	73
Installing ScriptListener	73
Action Manager Scripting Objects	74
Recording a Script using ScriptListener	74
Using the Action Manager from JavaScript	75
Using the Action Manager from a VBS Script	76
Running JavaScript-based Action Manager code from VBScript	79
Running JavaScript-based Action Manager code from AppleScript	80
Using ScriptListener to find event IDs and class IDs	81

Adobe 65048599 Scripting Guide - Page 54

Other filters, Understanding Clipboard Interaction, Using the copy and paste commands

Page 54 highlights