User manual ADOBE PHOTOSHOP CS 2.0 SCRIPTING GUIDE

[. . . ] Scripting Guide ® ® bc Adobe Photoshop cs2 © Copyright 2005 Adobe Systems Incorporated. Adobe® Creative Suite 2 Photoshop® Scripting Guide for Windows® and Macintosh®. NOTICE: All information contained herein is the property of Adobe Systems Incorporated. No part of this publication (whether in hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of Adobe Systems Incorporated. [. . . ] The following example displays a Hello World message when a user clicks CommandButton1. Private Sub CommandButton1_Click() HelloWorld End Sub Function The following script presents a form with one command button. When a user clicks the button, a dialog appears with the message Are you sure?When the user clicks a button, another dialog appears that displays the Boolean value of the clicked button: Yes = True; No = False. 'create a subroutine that calls the function DoConfirm 'and assigns it to the variable named Result Private Sub CommandButton1_Click() Result = DoConfirm("Are you sure?") Alert Result End Sub 'define the function Function DoConfirm(prompt) buttonPressed = Alert (prompt, vbYesNo) DoConfirm = (buttonPressed = vbYes) End Function JS In JavaScript, all subroutines are functions. The following sample script is a JavaScript version of the VBScript sample function in the previous example. /*create a variable and assign its value as the return value of the function named DoConfirm*/ var theResult = DoConfirm( "Are you sure?" ) //display an alert box with the assigned value as its message alert(theResult) //define DoConfirm function DoConfirm(message) { var result = confirm(message) return result Photoshop CS2 Adobe Photoshop CS2 Scripting Guide Scripting basics 31 } Executing JavaScripts from AS or VBS You can take advantage of JavaScript's platform-independence by running scripts from AppleScript or VBScript. You can execute either a single JavaScript statement or a complete JavaScript file. AS To run a JavaScript from AppleScript, you use the do javascript command. The following sample executes a single JavaScript command, which displays an alert box with the text alert text. do javascript "alert('alert text')" To pass a JavaScript file, you can create a reference to the file using as alias or to a reference to file as shown in the following examples set scriptFile to "applications: scripts: myscript" as alias do javascript scriptFile set scriptFile to a reference to file "applications: scripts: myscript" do javascript scriptFile Note: Refer to an AppleScript language guide or text book for information on referencing a file using either as alias or to a reference to file. VBS In VBScript, use the DoJavaScript method to execute a single JavaScript command. objApp. DoJavaScript ("alert('alert text')") To open a JavaScript file, use the DoJavaScriptFile method. The following sample opens a file on the D:\\ drive. Dim appRef As Photoshop. Application Set appRef = CreateObject("Photoshop. Application") appRef. DoJavaScriptFile ("D:\\Scripts\\MosaicTiles. jsx") Passing AS or VBS Arguments to JavaScript You can also pass arguments to JavaScript from either AppleScript or VBScript using the with arguments/(Arguments) parameter of the do javascript/DoJavaScript or DoJavaScriptFile command or methods. The parameter takes an array to pass any values. The following examples execute the following JavaScript, which is stored in a file named JSFile. jsx in your Applications\Scripts folder: alert( "You passed " + arguments. length + " arguments" ) for ( i = 0; i < arguments. length; ++i ) { alert( arguments[i]. toString() ) } AS tell application "Adobe Photoshop CS2" make new document do javascript (alias a path to the JavaScript shown above) ¬ with arguments {1, "test text", (fileApplications:Scripts:JSFile. jsx), ¬ current document} Photoshop CS2 Adobe Photoshop CS2 Scripting Guide Scripting basics 32 end tell VBS Dim appRef As Photoshop. Application Set appRef = CreateObject("Photoshop. Application") appRef. DoJavaScriptFile "C:\\Applications\Scripts\JSFile. jsx", _ Array(1, "test text", appRef. ActiveDocument) When running JavaScript from AppleScript or VBScript you can also control the debugging state. To do this, use the show debugger (ExecutionMode) argument. The values for ExectionMode are: NeverShowDebugger Disables debugging from the JavaScript. Any error that occurs in the JavaScript results in a JavaScript exception being thrown. Note: Refer to a JavaScript language guide for information on how to handle JavaScript exceptions. See `Bibliography' on page 34 for a listing of language guides. DebuggerOnError Automatically stops the execution of your JavaScript when a runtime error occurs and shows the JavaScript debugger. BeforeRunning Shows the JavaScript debugger at the beginning of your JavaScript. See `Testing and Troubleshooting' on page 32 for more information about debugging. Testing and Troubleshooting The AppleScript and VBScript scripting environments provide tools for monitoring the progress of your script while it is running--which makes it easier for you to track down any problems your script might be encountering or causing. AppleScript Debugging Apple's Script Editor application provides a syntax checking tool that you can use before you run your script. Additionally, Script Editor calls out problems in the script when you run the script. To view more details of how your script runs, display the Event Log and Results windows. To have Script Editor check your syntax: 1. Click Check Syntax in the Script Editor main window. Note: It is possible to create and compile scripts in AppleScript that will not run properly. You can double-check your syntax by using the Event Log and when you run your script. To use the Event Log window when you run a script: 1. The Script Editor displays the Event Log window. Select Show Events and Show Events Results. Click Run in the Script Editor main window. As the script executes, you'll see the commands sent to Photoshop CS2 and the responses. [. . . ] After viewing the document in Photoshop CS2, close the document without saving it. Note: Look up the following classes in the Adobe AppleScript Scripting Reference to see if you understand how you used them in this script: wave filter class art layer class rasterize command filter command document class > select command, combination type parameter VBS To select an area and apply a wave filter to it: 1. Type the following code into the script file HelloWorldDoc just above the commented statements that restore original preferences: 'create new variables to contain doc width and height 'convert inches to pixels by multiplying the number of inches by 'the resolution (which equals number of pixels per inch) docWidthInPixels = docWidthInInches * resolution docHeightInPixels = docHeightInInches * resolution Photoshop CS2 Adobe Photoshop CS2 Scripting Guide Scripting Photoshop CS2 81 'use the Rasterize() method of the ArtLayer class to 'convert the text in the ArtLayer object (contained in the newTextLayer variable) 'to postscript text type newTextLayer. Rasterize (1) 'create an array to define the selection property 'of the Document object 'define the selected area as an array of points in the document docRef. Selection. Select Array(Array(0, 0), _ Array(docWidthInPixels / 2, 0), _ Array(docWidthInPixels / 2, docHeightInPixels), _ Array(0, docHeightInPixels), Array(0, 0)) 'use the ApplyWave() method of the ArtLayer class 'to apply the wave of the selected text newTextLayer. ApplyWave 1, 1, 100, 5, 10, 100, 100, 1, 1, 0 2. Choose Run > Run Sub/Userform or press F5 to run the script. [. . . ]