Adobe 19400084 - Photoshop CS3 Extended User manual

bbc
JAVASCRIPT SCRIPTING REFERENCE

© 2007 Adobe Systems Incorporated. All rights reserved.
Adobe® Creative Suite® 3 Photoshop®JavaScript Scripting Reference 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 software described in this document is furnished under
license and may only be used or copied in accordance with the terms of such license.
This publication and the information herein is furnished AS IS, is subject to change without notice, and should not be construed as a
commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or
inaccuracies, makes no warranty of any kind (express, implied, or statutory) with respect to this publication, and expressly disclaims any and
all warranties of merchantability, fitness for particular purposes, and noninfringement of third party rights.
Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual
organization.
Adobe®, the Adobe logo, Acrobat®, GoLive®,InDesign®, Illustrator®, Photoshop®are either registered trademarks or trademarks of Adobe
Systems Incorporated in the United States and/or other countries.
Apple®, Mac OS®, and Macintosh®are trademarks of Apple Computer, Inc., registered in the United States and other countries. Microsoft®, and
Windows®. are either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries. JavaScriptTM and
all Java-related marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. UNIX®is a
registered trademark of The Open Group.
All other trademarks are the property of their respective owners.
If this guide is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished
under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part
of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording,
or otherwise, without the prior written permission of Adobe Systems Incorporated. Please note that the content in this guide is protected
under copyright law even if it is not distributed with software that includes an end user license agreement.
The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a
commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or
inaccuracies that may appear in the informational content contained in this guide.
Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.

3
Contents
1 Introduction ............................................................................................................................... 31
JavaScript support in Adobe Photoshop CS3 ....................................................................................................................31
Executing scripts ....................................................................................................................................................................31
Installing scripts ...............................................................................................................................................................32
Executing other scripts..................................................................................................................................................32
Startup scripts .........................................................................................................................................................................32
Changes Since Earlier Versions................................................................................................................................................32
2 JavaScript Object Reference ..................................................................................................... 35
Working with the Properties Tables ......................................................................................................................................35
displayDialogs.................................................................................................................................................................35
Working with the Methods Tables.........................................................................................................................................35
executeAction.................................................................................................................................................................36
Working with Method Parameters ..................................................................................................................................36
ActionDescriptor ..........................................................................................................................................................................37
Properties..................................................................................................................................................................................37
count ..................................................................................................................................................................................37
typename .........................................................................................................................................................................37
Methods ....................................................................................................................................................................................37
clear ....................................................................................................................................................................................37
erase ...................................................................................................................................................................................37
fromStream......................................................................................................................................................................37
getBoolean.......................................................................................................................................................................37
getClass .............................................................................................................................................................................37
getData..............................................................................................................................................................................37
getDouble ........................................................................................................................................................................37
getEnumerationType ...................................................................................................................................................37
getEnumerationValue..................................................................................................................................................37
getInteger.........................................................................................................................................................................37
getKey................................................................................................................................................................................37
getList ................................................................................................................................................................................37
getObjectType................................................................................................................................................................38
getObjectValue...............................................................................................................................................................38
getPath..............................................................................................................................................................................38
getReference ...................................................................................................................................................................38
getString ...........................................................................................................................................................................38
getType .............................................................................................................................................................................38
getUnitDoubleType......................................................................................................................................................38
getUnitDoubleValue.....................................................................................................................................................38
hasKey................................................................................................................................................................................38
isEqual................................................................................................................................................................................38
putBoolean ......................................................................................................................................................................38
putClass.............................................................................................................................................................................38
putData .............................................................................................................................................................................38
putDouble ........................................................................................................................................................................38
putEnumerated ..............................................................................................................................................................38

Adobe Photoshop CS3
JavaScript Scripting Reference 4
putInteger ........................................................................................................................................................................38
putList................................................................................................................................................................................39
putObject..........................................................................................................................................................................39
putPath..............................................................................................................................................................................39
putReference...................................................................................................................................................................39
putString...........................................................................................................................................................................39
putUnitDouble................................................................................................................................................................39
toStream ...........................................................................................................................................................................39
ActionList.........................................................................................................................................................................................40
Properties..................................................................................................................................................................................40
count ..................................................................................................................................................................................40
typename .........................................................................................................................................................................40
Methods ....................................................................................................................................................................................40
clear ....................................................................................................................................................................................40
getBoolean.......................................................................................................................................................................40
getClass .............................................................................................................................................................................40
getData..............................................................................................................................................................................40
getDouble ........................................................................................................................................................................40
getEnumerationType ...................................................................................................................................................40
getEnumerationValue..................................................................................................................................................40
getInteger.........................................................................................................................................................................40
getList ................................................................................................................................................................................40
getObjectType................................................................................................................................................................40
getObjectValue...............................................................................................................................................................41
getPath..............................................................................................................................................................................41
getReference ...................................................................................................................................................................41
getString ...........................................................................................................................................................................41
getType .............................................................................................................................................................................41
getUnitDoubleType......................................................................................................................................................41
getUnitDoubleValue.....................................................................................................................................................41
putBoolean ......................................................................................................................................................................41
putClass.............................................................................................................................................................................41
putData .............................................................................................................................................................................41
putDouble ........................................................................................................................................................................41
putEnumerated ..............................................................................................................................................................41
putInteger ........................................................................................................................................................................41
putList................................................................................................................................................................................41
putObject..........................................................................................................................................................................41
putPath..............................................................................................................................................................................41
putReference...................................................................................................................................................................42
putString...........................................................................................................................................................................42
putUnitDouble................................................................................................................................................................42
ActionReference ...........................................................................................................................................................................43
Properties..................................................................................................................................................................................43
typename .........................................................................................................................................................................43
Methods ....................................................................................................................................................................................43
getContainer ...................................................................................................................................................................43
getDesiredClass..............................................................................................................................................................43
getEnumeratedType.....................................................................................................................................................43
getEnumeratedValue ...................................................................................................................................................43
getForm.............................................................................................................................................................................43

Adobe Photoshop CS3
JavaScript Scripting Reference 5
getIdentifier.....................................................................................................................................................................43
getIndex............................................................................................................................................................................43
getName ...........................................................................................................................................................................43
getOffset ...........................................................................................................................................................................43
getProperty......................................................................................................................................................................43
putClass.............................................................................................................................................................................43
putEnumerated ..............................................................................................................................................................44
putIdentifier.....................................................................................................................................................................44
putIndex............................................................................................................................................................................44
putName...........................................................................................................................................................................44
putOffset...........................................................................................................................................................................44
putProperty......................................................................................................................................................................44
Application .....................................................................................................................................................................................45
Properties..................................................................................................................................................................................45
activeDocument.............................................................................................................................................................45
backgroundColor...........................................................................................................................................................45
colorSettings ...................................................................................................................................................................45
displayDialogs.................................................................................................................................................................45
documents .......................................................................................................................................................................45
fonts....................................................................................................................................................................................45
foregroundColor............................................................................................................................................................45
freeMemory .....................................................................................................................................................................45
locale ..................................................................................................................................................................................45
macintoshFileTypes......................................................................................................................................................45
measurementLog ..........................................................................................................................................................45
name...................................................................................................................................................................................46
notifiers .............................................................................................................................................................................46
notifiersEnabled.............................................................................................................................................................46
path.....................................................................................................................................................................................46
playbackDisplayDialogs ..............................................................................................................................................46
playbackParameters .....................................................................................................................................................46
preferences ......................................................................................................................................................................46
preferencesFolder .........................................................................................................................................................46
recentFiles ........................................................................................................................................................................46
scriptingBuildDate ........................................................................................................................................................46
scriptingVersion .............................................................................................................................................................46
typename .........................................................................................................................................................................46
version ...............................................................................................................................................................................46
windowsFileTypes.........................................................................................................................................................46
Methods ....................................................................................................................................................................................47
batch ..................................................................................................................................................................................47
beep....................................................................................................................................................................................47
bringToFront ...................................................................................................................................................................47
charIDToTypeID..............................................................................................................................................................47
doAction ...........................................................................................................................................................................47
eraseCustomOptions....................................................................................................................................................47
executeAction.................................................................................................................................................................47
executeActionGet..........................................................................................................................................................47
featureEnabled ...............................................................................................................................................................48
getCustomOptions........................................................................................................................................................48
load .....................................................................................................................................................................................48

Adobe Photoshop CS3
JavaScript Scripting Reference 6
makeContactSheet........................................................................................................................................................48
makePDFPresentation .................................................................................................................................................48
makePhotoGallery.........................................................................................................................................................48
makePhotomerge..........................................................................................................................................................48
makePicturePackage....................................................................................................................................................48
open ...................................................................................................................................................................................49
openDialog ......................................................................................................................................................................49
purge..................................................................................................................................................................................49
putCustomOptions .......................................................................................................................................................49
refresh................................................................................................................................................................................49
stringIDToTypeID...........................................................................................................................................................49
typeIDToCharID..............................................................................................................................................................50
typeIDToStringID...........................................................................................................................................................50
ArtLayer............................................................................................................................................................................................53
Properties..................................................................................................................................................................................53
allLocked...........................................................................................................................................................................53
blendMode.......................................................................................................................................................................53
bounds...............................................................................................................................................................................53
fillOpacity..........................................................................................................................................................................53
grouped ............................................................................................................................................................................53
isBackgroundLayer........................................................................................................................................................53
kind .....................................................................................................................................................................................53
linkedLayers.....................................................................................................................................................................54
name...................................................................................................................................................................................54
opacity...............................................................................................................................................................................54
parent.................................................................................................................................................................................54
pixelsLocked....................................................................................................................................................................54
positionLocked...............................................................................................................................................................54
textItem.............................................................................................................................................................................54
transparentPixelsLocked.............................................................................................................................................54
typename .........................................................................................................................................................................54
visible .................................................................................................................................................................................54
Methods ....................................................................................................................................................................................54
adjustBrightnessContrast ...........................................................................................................................................54
adjustColorBalance.......................................................................................................................................................54
adjustCurves....................................................................................................................................................................55
adjustLevels.....................................................................................................................................................................55
applyAddNoise...............................................................................................................................................................55
applyAverage..................................................................................................................................................................55
applyBlur...........................................................................................................................................................................55
applyBlurMore ................................................................................................................................................................55
applyClouds.....................................................................................................................................................................55
applyCustomFilter.........................................................................................................................................................55
applyDeInterlace............................................................................................................................................................55
applyDespeckle..............................................................................................................................................................55
applyDifferenceClouds................................................................................................................................................55
applyDiffuseGlow ..........................................................................................................................................................55
applyDisplace..................................................................................................................................................................56
applyDustAndScratches..............................................................................................................................................56
applyGaussianBlur.........................................................................................................................................................56
applyGlassEffect.............................................................................................................................................................56

Adobe Photoshop CS3
JavaScript Scripting Reference 7
applyHighPass ................................................................................................................................................................56
applyLensBlur .................................................................................................................................................................57
applyLensFlare................................................................................................................................................................57
applyMaximum ..............................................................................................................................................................58
applyMedianNoise ........................................................................................................................................................58
applyMinimum ...............................................................................................................................................................58
applyMotionBlur ............................................................................................................................................................58
applyNTSC........................................................................................................................................................................58
applyOceanRipple.........................................................................................................................................................58
applyOffset.......................................................................................................................................................................58
applyPinch .......................................................................................................................................................................58
applyPolarCoordinates................................................................................................................................................58
applyRadialBlur ..............................................................................................................................................................58
applyRipple......................................................................................................................................................................58
applySharpen..................................................................................................................................................................58
applySharpenEdges......................................................................................................................................................59
applySharpenMore .......................................................................................................................................................59
applyShear .......................................................................................................................................................................59
applySmartBlur...............................................................................................................................................................59
applySpherize .................................................................................................................................................................59
applyStyle.........................................................................................................................................................................59
applyTextureFill..............................................................................................................................................................59
applyTwirl.........................................................................................................................................................................59
applyUnSharpMask.......................................................................................................................................................59
applyWave........................................................................................................................................................................59
applyZigZag.....................................................................................................................................................................60
autoContrast....................................................................................................................................................................60
autoLevels ........................................................................................................................................................................60
clear ....................................................................................................................................................................................60
copy ....................................................................................................................................................................................60
cut........................................................................................................................................................................................60
desaturate ........................................................................................................................................................................60
duplicate...........................................................................................................................................................................60
equalize.............................................................................................................................................................................60
invert ..................................................................................................................................................................................60
link.......................................................................................................................................................................................60
merge.................................................................................................................................................................................61
mixChannels....................................................................................................................................................................61
move...................................................................................................................................................................................61
photoFilter .......................................................................................................................................................................62
posterize ...........................................................................................................................................................................62
rasterize.............................................................................................................................................................................62
remove...............................................................................................................................................................................62
resize ..................................................................................................................................................................................62
rotate..................................................................................................................................................................................62
selectiveColor..................................................................................................................................................................62
shadowHighlight ...........................................................................................................................................................62
threshold...........................................................................................................................................................................63
translate ............................................................................................................................................................................63
unlink .................................................................................................................................................................................63
ArtLayers..........................................................................................................................................................................................65

Adobe Photoshop CS3
JavaScript Scripting Reference 8
Properties..................................................................................................................................................................................65
length.................................................................................................................................................................................65
parent.................................................................................................................................................................................65
typename .........................................................................................................................................................................65
Methods ....................................................................................................................................................................................65
index...................................................................................................................................................................................65
add ......................................................................................................................................................................................65
getByName ......................................................................................................................................................................65
removeAll .........................................................................................................................................................................65
BatchOptions .................................................................................................................................................................................66
Properties..................................................................................................................................................................................66
destination .......................................................................................................................................................................66
destinationFolder ..........................................................................................................................................................66
errorFile.............................................................................................................................................................................66
fileNaming........................................................................................................................................................................66
macintoshCompatible .................................................................................................................................................66
overrideOpen..................................................................................................................................................................66
overrideSave....................................................................................................................................................................67
startingSerial ...................................................................................................................................................................67
suppressOpen.................................................................................................................................................................67
suppressProfile ...............................................................................................................................................................67
typename .........................................................................................................................................................................67
unixCompatible..............................................................................................................................................................67
windowsCompatible ....................................................................................................................................................67
BitmapConversionOptions .......................................................................................................................................................68
Properties..................................................................................................................................................................................68
angle...................................................................................................................................................................................68
frequency..........................................................................................................................................................................68
method..............................................................................................................................................................................68
patternName...................................................................................................................................................................68
resolution..........................................................................................................................................................................68
shape..................................................................................................................................................................................68
typename .........................................................................................................................................................................68
BMPSaveOptions ..........................................................................................................................................................................69
Properties..................................................................................................................................................................................69
alphaChannels................................................................................................................................................................69
depth..................................................................................................................................................................................69
flipRowOrder...................................................................................................................................................................69
osType................................................................................................................................................................................69
rleCompression ..............................................................................................................................................................69
typename .........................................................................................................................................................................69
CameraRAWOpenOptions ........................................................................................................................................................70
Properties..................................................................................................................................................................................70
bitsPerChannel ...............................................................................................................................................................70
blueHue.............................................................................................................................................................................70
blueSaturation................................................................................................................................................................70
brightness.........................................................................................................................................................................70
chromaticAberrationBY...............................................................................................................................................70
chromaticAberrationRC...............................................................................................................................................70
colorNoiseReduction....................................................................................................................................................70
colorSpace........................................................................................................................................................................70

Adobe Photoshop CS3
JavaScript Scripting Reference 9
contrast .............................................................................................................................................................................70
exposure ...........................................................................................................................................................................70
greenHue..........................................................................................................................................................................70
greenSaturation .............................................................................................................................................................70
luminanceSmoothing ..................................................................................................................................................70
redHue...............................................................................................................................................................................70
redSaturation ..................................................................................................................................................................70
resolution..........................................................................................................................................................................70
saturation .........................................................................................................................................................................70
settings..............................................................................................................................................................................70
shadows ............................................................................................................................................................................70
shadowTint ......................................................................................................................................................................71
sharpness..........................................................................................................................................................................71
size ......................................................................................................................................................................................71
temperature.....................................................................................................................................................................71
tint.......................................................................................................................................................................................71
typename .........................................................................................................................................................................71
vignettingAmount ........................................................................................................................................................71
vignettingMidpoint ......................................................................................................................................................71
whiteBalance...................................................................................................................................................................71
Channel............................................................................................................................................................................................72
Properties..................................................................................................................................................................................72
color....................................................................................................................................................................................72
histogram .........................................................................................................................................................................72
kind .....................................................................................................................................................................................72
name...................................................................................................................................................................................72
opacity...............................................................................................................................................................................72
parent.................................................................................................................................................................................72
typename .........................................................................................................................................................................73
visible .................................................................................................................................................................................73
Methods ....................................................................................................................................................................................73
duplicate...........................................................................................................................................................................73
merge.................................................................................................................................................................................73
remove...............................................................................................................................................................................73
Channels..........................................................................................................................................................................................74
Properties..................................................................................................................................................................................74
length.................................................................................................................................................................................74
parent.................................................................................................................................................................................74
typename .........................................................................................................................................................................74
Methods ....................................................................................................................................................................................74
index...................................................................................................................................................................................74
add ......................................................................................................................................................................................74
getByName ......................................................................................................................................................................74
removeAll .........................................................................................................................................................................74
CMYKColor......................................................................................................................................................................................79
Properties..................................................................................................................................................................................79
black ...................................................................................................................................................................................79
cyan.....................................................................................................................................................................................79
magenta............................................................................................................................................................................79
typename .........................................................................................................................................................................79
yellow.................................................................................................................................................................................79

Adobe Photoshop CS3
JavaScript Scripting Reference 10
ColorSampler .................................................................................................................................................................................80
Properties..................................................................................................................................................................................80
color....................................................................................................................................................................................80
position .............................................................................................................................................................................80
parent.................................................................................................................................................................................80
typename .........................................................................................................................................................................80
Methods ....................................................................................................................................................................................80
move...................................................................................................................................................................................80
remove...............................................................................................................................................................................80
ColorSamplers ...............................................................................................................................................................................81
Properties..................................................................................................................................................................................81
length.................................................................................................................................................................................81
parent.................................................................................................................................................................................81
typename .........................................................................................................................................................................81
Methods ....................................................................................................................................................................................81
index...................................................................................................................................................................................81
add ......................................................................................................................................................................................81
getByName ......................................................................................................................................................................81
removeAll .........................................................................................................................................................................81
ContactSheetOptions .................................................................................................................................................................82
Properties..................................................................................................................................................................................82
acrossFirst.........................................................................................................................................................................82
bestFit ................................................................................................................................................................................82
caption...............................................................................................................................................................................82
columnCount ..................................................................................................................................................................82
flatten.................................................................................................................................................................................82
font......................................................................................................................................................................................82
fontSize..............................................................................................................................................................................82
height.................................................................................................................................................................................82
horizontal .........................................................................................................................................................................82
mode ..................................................................................................................................................................................82
resolution..........................................................................................................................................................................82
rowCount..........................................................................................................................................................................82
typename .........................................................................................................................................................................82
useAutoSpacing.............................................................................................................................................................82
vertical ...............................................................................................................................................................................83
width ..................................................................................................................................................................................83
CountItem.......................................................................................................................................................................................84
Properties..................................................................................................................................................................................84
position .............................................................................................................................................................................84
parent.................................................................................................................................................................................84
typename .........................................................................................................................................................................84
Methods ....................................................................................................................................................................................84
remove...............................................................................................................................................................................84
CountItems .....................................................................................................................................................................................85
Properties..................................................................................................................................................................................85
length.................................................................................................................................................................................85
parent.................................................................................................................................................................................85
typename .........................................................................................................................................................................85
Methods ....................................................................................................................................................................................85
index...................................................................................................................................................................................85