Adobe Illustrator CS6 Type Library - documentation.help · Adobe's XML files.) So I wrote an XSLT stylesheet to read, parse, split ... installation of InDesign is upgraded with some

AdobeIllustratorCS6TypeLibrary

Contents

JavaScriptReferenceGuideScriptingisoneofthemostpowerfulfeaturesinIllustrator.Itcansavelotsoftime:almostanythingyoucandowiththeuserinterface,youcandowithscripts,andthereareevenafewthingsyoucandoinscriptingthatyoucannotdofromwithintheuserinterface.Thecontentsontherightiscategorizedbyfunction;intheindexatthebottom,youcanfindallobjectsinalphabeticalorder.Eachobjectdescriptionlistsitselements,properties,andmethods.Thisentiresitewasentirelycreatedautomatically!Ohwow-readmore!

JavaScriptBaseClassesSuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobeIllustratorColorclassesforAdobeIllustratorTextprocessingcommandsandclassesforAdobeIllustratorTransformationmatrixeventsandclassesforAdobeIllustratorClassesusedonlyforcreatingpathitems.Cannotbeusetoaccesspageitems.FileopeningoptionsclassesforAdobeIllustratorFilesaveoptionsclassesforAdobeIllustratorFileexportoptions

classesforAdobeIllustratorCommandsandclassesforcontrolingAdobeIllustrator'sdynamicpublishingbehaviorMiscellaneousstandardeventsandclassesPrintingclassesforAdobeIllustratorTracingclassesforAdobeIllustratorCollectionsOtherClassesScriptUIClasses

Jongware,25-Nov-2012v3.0.3i

Contents::Index

AdobeIllustratorCS6

Aboutthesepages TheExtendScriptToolkit

Editorcomeswithabuilt-inHelpfunction,whichdisplaysallobjectsaccessibleinJavaScriptforInDesign,Bridge,Illustrator,andPhotoshop.ItdoessobysendingarequesttothetargetprogramtooutputanXMLdatafile,containingtheprototypesanddefinitionsforallofitsscriptablecomponents.ThisXMLfileissavedinacache(presumablybecauseit'salengthyoperation)andsubsequentiallydisplayedwhenrequested.Ifitdetectsanewplugin,therequestissentagainandtheXMLfileisrebuiltfromscratch.Thatmeansthatonlinehelpforanynewscriptableplugincommandsareavailableimmediatelyforyournewscripts.Amazing!

XMLisaveryreadabledataformat...ifyou'reabitheadlikeme!Butwouldn'titbenicetobeabletoformatthishelptextjustasyoulike,andbereadable(and

searchable!)inyourfavouriteprogram,suchasyourwebbrowser?Well,theXMLformathasauniqueadvantageoverjustaboutanyotherdatafile.It'shighlystructured,andthiscontentcanbemanipulatedusingXSLT—theExtensibleStylesheetLanguageTransformationslanguage,asdefinedbytheWorldWideWebConsortium(W3C).AnXSLTstylesheetcansortandmanipulateXMLinput,insertallkindsofextradata(suchas,oh,acopyrightmanifestatthetopofeveryoutput),andwritetheresulttooneormoreoutputfiles.Whathasthattodowiththese750pagesofHTML?Ididn'tcreateasingleoneofthem.(Thispageiscreated'AllByHand'TM—butit'snotpartofAdobe'sXMLfiles.)

SoIwroteanXSLTstylesheettoread,parse,split,andsortthehugeinputfile,andtooutputitasformattedandhyperlinkedHTMLpages.Thiswasnomeantaskatall—theinputfileisover

113,000lineslong,andthelatestversionofthestylesheetcontainsjustunderathousandlines.Allinall,ittookmemorethan50hoursofhardworktocreatetheoutputyouseebeforeyou.Butwait!couldn'tIjusthavesearch-and-replacedtheXMLcommandsintoHTML?Sure—manuallysortingandsuch,butstilldoable.ButifIeverwanttochangesomething—say,Iwant4columnsofindexinsteadof3,orIdon'twanttousetablesanymore,butrealCSS3columns—allIhavetodoisre-writea(small)partoftheXSLTstylesheetandlettheSaxonXSLTinterpretergoovertheXMLagain.IfmyinstallationofInDesignisupgradedwithsomescriptableplugin,allIhavetodoisrunSaxonagain.SincetheXMLhelpforCS4hasthesameformatting,IcanrunSaxonagainonitshelpfile.Andthereyouhaveit!Anotherentirelynewsetofmorethan750files,allproperlyindexedandhyperlinked,withoutmedoinganymorethan

changinghowitshouldlook!a

UnderstandingXMLiseasy,especiallyifyouarewell-versedinHTML.Ifthelatter,youshouldreallyknowaboutXHTML—thewell-formattedyoungerbrotherofthatplainoldtack-together-with-sticky-tapethatgrewsobloatedovertheyears.XMLisevenmoresostructured,andthestepovershouldn'tbedifficult.XSLTissomethingquiteelse.Firstoff,it'sdefinedintermsofXML(meaning:youcanrunanXSLTstylesheetoveranXSLTstylesheet,forexampletoformatitforprintingorviewing).It'saprogramminglanguage,butitdoesn'tworkinthedo-this-then-thatsequentialsteps;instead,it'saprocedurallanguage,anditdescribeswhattodooneachandeveryXMLelementitencountersintheinputXMLdocument.WritingyourfirstXSLTstylesheetcanbefrustrating(usually,becauseyourfirstattemptsdon'tappeartodoanythingatall)untilyou

getintothepropermindset.SoonyouwillbescanningeveryfolderonyourcomputerforXMLfilestoexamine!(MacOSXusers:a.plistconfigurationfileisalsoXML;lotsofotherfilesinthatsystemareaswell.)

So,whydidIworksohardonwritingthesheetforthis?Well,itwasfuntocreatesomethingnew—agoodreasoninitself.Besides,Ineededthetraining.Asatypesetter,oneofmyupcomingjobsincludesadictionarythatisbeingassembledasExceldata.Iexperimentedwithasmalldataset,exportingitfromExcelasXML,andthenconvertingittoplaintext,sortingentriesandconcatenatingduplicatesallinonego.AfterthatIreckoned,"INX"—InDesign'scompatibilityfileformat—"isalsoanXMLfile",andwentontoincludeallnecessaryformatting,frompagesandparagraphs,rightuptothestyleandformattingofindividualwords.Saxonstilldidn'tbreakintoasweat—andnowallIhavetodoifthe

completedatacomesin,isexportittoXML,runmysheetoverittocreateanINXoutputfile,andopenthatonewithInDesign.Thepublisherwillbeamazedifhereceivesacompletesetofproofswithinacoupleofhours(let'sbegenerous),nomatterifit'sahundredpagesofoutputorathousand.Howdoesthatsoundforpagethroughput!?

AcknowledgementsThefirstCHMconversionofthefilesforCS3wasdonebyfellowscriptingenthousiastABCGREEN.Additionally,hehelpedmesetupmysystemtocompileotherversionsaswell.Thanks,mate!

NoteaDuetoaharddiskcrashofmyWindowsmachineIlostallofmyinstalledprograms.Fortunately,mygoodfriendRenéKramer(1967-2010)wasabletorescuemost(ifnotall)ofmydata.Thanks,René-thatbottleofwhiskeywaswellearned.Enjoyit,whereeveryouare.SothisversionisnotcreatedwithSaxononaWindowscomputer.WorkingonmyMac,IdownloadedKernowforSaxon.Theolderversion1.4comescompletewithaJavainterfaceandSaxon8B,andtomysurprise(andrelief)ittookjust

http://sourceforge.net/projects/kernowforsaxon/

afewclickstore-generatetheentireHelpsetanew.IsaiditbeforeandI'llsayitagain:SupportOpenSourceSoftware!


Contents::Index


ContentsJavaScriptBaseClasses

BasicJavaScriptprogrammingstartshere.

JavaScriptBaseClassesSuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobeIllustratorColorclassesforAdobeIllustratorTextprocessingcommandsandclassesforAdobeIllustratorTransformationmatrixeventsandclassesforAdobeIllustratorClassesusedonlyforcreatingpathitems.Cannotbeusetoaccesspageitems.FileopeningoptionsclassesforAdobeIllustratorFilesaveoptionsclassesforAdobeIllustrator

$ArrayBooleanDateErrorFileFolderFunctionGlobalElementsMathNamespaceNumberObjectQNameReflectionReflectionInfoRegExpSocketStringUnitValueXMLXMLList

FileexportoptionsclassesforAdobeIllustratorCommandsandclassesforcontrolingAdobeIllustrator'sdynamicpublishingbehaviorMiscellaneousstandardeventsandclassesPrintingclassesforAdobeIllustratorTracingclassesforAdobeIllustratorCollectionsOtherClassesScriptUIClasses


Contents::Index


ContentsSuitethatappliestoallapplications


ApplicationDocument



Contents::Index


Contents

ScriptingcommandsandclassesforAdobeIllustrator

JavaScriptBaseClassesSuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobeIllustratorColorclassesforAdobeIllustratorTextprocessingcommandsandclassesforAdobeIllustratorTransformationmatrixeventsandclassesforAdobeIllustratorClassesusedonlyforcreatingpathitems.Cannotbeusetoaccesspageitems.FileopeningoptionsclassesforAdobeIllustrator

AntiAliasingMethodArtClippingOptionArtStyleArtboardAutoCADColorsAutoCADCompatibilityAutoCADExportFileFormatAutoCADExportOptionAutoCADGlobalScaleOptionAutoCADRasterFormatAutoCADUnitBlendAnimationTypeBlendModesBlendsExpandPolicyBrushColorConversionColorDestinationColorModelColorProfileCompatibilityCompoundPathItemCompressionQualityCoordinateSystemCropOptionsDocumentArtboardLayoutDocumentColorSpaceDocumentPresetDocumentPresetTypeDocumentPreviewModeDocumentRasterResolutionDocumentTransparencyGridDownsampleMethodEPSPostScriptLevelEnum

FilesaveoptionsclassesforAdobeIllustratorFileexportoptionsclassesforAdobeIllustratorCommandsandclassesforcontrolingAdobeIllustrator'sdynamicpublishingbehaviorMiscellaneousstandardeventsandclassesPrintingclassesforAdobeIllustratorTracingclassesforAdobeIllustratorCollectionsOtherClassesScriptUIClasses

EPSPreviewFXGVersionFiltersPreservePolicyFlashExportStyleFlashExportVersionFlashImageFormatFlashJPEGMethodFlashPlaybackSecurityGradientGradientStopGradientTypeGradientsPreservePolicyGraphItemGroupItemImageColorSpaceJavaScriptExecutionModeJustificationKnockoutStateLayerLayerOrderTypeLegacyTextItemMeshItemMonochromeCompressionNonNativeItemOutputFlatteningPDFBoxTypePDFChangesAllowedEnumPDFCompatibilityPDFOverprintPDFPrintAllowedEnumPDFTrimMarkWeightPDFXStandardPageItemPathItemPathPointPathPointSelectionPerspectiveGridPlaneTypePhotoshopCompatibilityPlacedItem

PluginItemPointTypePolarityValuesPreferencesPrinterPostScriptLevelEnumRasterEffectOptionsRasterItemRasterLinkStateRasterizationColorModelRasterizeOptionsRulerUnitsSVGCSSPropertyLocationSVGDTDVersionSVGDocumentEncodingSVGFontSubsettingSVGFontTypeSaveOptionsScreenModeSpotColorKindStrokeCapStrokeJoinSymbolSymbolItemSymbolRegistrationPointTIFFByteOrderTabStopAlignmentTabStopInfoTagTextAntialiasTextFontTextFrameItemTextOrientationTextPreservePolicyTextTypeTransformationUserInteractionLevelVariableKindViewZOrderMethod


Contents::Index


ContentsColorclassesforAdobeIllustrator


CMYKColorColorColorConvertPurposeGradientColorGrayColorLabColorNoColorPatternPatternColorRGBColorSpotSpotColorSwatchSwatchGroup



Contents::Index


Contents

TextprocessingcommandsandclassesforAdobeIllustrator


AlternateGlyphsFormAutoKernTypeAutoLeadingTypeBaselineDirectionTypeBurasagariTypeEnumCaseChangeTypeCharacterAttributesCharacterStyleFigureStyleTypeFirstBaselineTypeFontBaselineOptionFontCapsOptionFontOpenTypePositionOptionInsertionPointKinsokuOrderEnumLanguageTypeParagraphAttributesParagraphStyleStoryStyleRunAlignmentTypeTextPathTextRangeWariChuJustificationType



Contents::Index


Contents

TransformationmatrixeventsandclassesforAdobeIllustrator

JavaScriptBaseClassesSuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobeIllustratorColorclassesforAdobeIllustratorTextprocessingcommandsandclassesforAdobeIllustratorTransformationmatrixeventsandclassesforAdobeIllustratorClassesusedonlyforcreatingpathitems.Cannotbeusetoaccesspageitems.FileopeningoptionsclassesforAdobeIllustratorFilesaveoptions

Matrix

classesforAdobeIllustratorFileexportoptionsclassesforAdobeIllustratorCommandsandclassesforcontrolingAdobeIllustrator'sdynamicpublishingbehaviorMiscellaneousstandardeventsandclassesPrintingclassesforAdobeIllustratorTracingclassesforAdobeIllustratorCollectionsOtherClassesScriptUIClasses


Contents::Index


Contents

Classesusedonlyforcreatingpathitems.Cannotbeusetoaccesspageitems.




Contents::Index


Contents

FileopeningoptionsclassesforAdobeIllustrator

JavaScriptBaseClassesSuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobeIllustratorColorclassesforAdobeIllustratorTextprocessingcommandsandclassesforAdobeIllustratorTransformationmatrixeventsandclassesforAdobeIllustratorClassesusedonlyforcreatingpathitems.Cannotbeusetoaccesspageitems.FileopeningoptionsclassesforAdobeIllustratorFilesaveoptionsclassesforAdobe

LibraryTypeOpenOptionsOpenOptionsAutoCADOpenOptionsPDFOpenOptionsPhotoshop

IllustratorFileexportoptionsclassesforAdobeIllustratorCommandsandclassesforcontrolingAdobeIllustrator'sdynamicpublishingbehaviorMiscellaneousstandardeventsandclassesPrintingclassesforAdobeIllustratorTracingclassesforAdobeIllustratorCollectionsOtherClassesScriptUIClasses


Contents::Index


Contents

FilesaveoptionsclassesforAdobeIllustrator


EPSSaveOptionsFXGSaveOptionsIllustratorSaveOptionsPDFSaveOptions



Contents::Index


Contents

FileexportoptionsclassesforAdobeIllustrator


ColorDitherMethodColorReductionMethodDocumentTypeExportOptionsAutoCADExportOptionsFlashExportOptionsGIFExportOptionsJPEGExportOptionsPNG24ExportOptionsPNG8ExportOptionsPhotoshopExportOptionsSVGExportOptionsTIFFExportTypeImageCaptureOptions



Contents::Index


Contents

CommandsandclassesforcontrolingAdobeIllustrator'sdynamicpublishingbehavior

JavaScriptBaseClassesSuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobeIllustratorColorclassesforAdobeIllustratorTextprocessingcommandsandclassesforAdobeIllustratorTransformationmatrixeventsandclassesforAdobeIllustratorClassesusedonlyforcreatingpathitems.Cannotbeusetoaccesspageitems.FileopeningoptionsclassesforAdobe

DataSetVariable

IllustratorFilesaveoptionsclassesforAdobeIllustratorFileexportoptionsclassesforAdobeIllustratorCommandsandclassesforcontrolingAdobeIllustrator'sdynamicpublishingbehaviorMiscellaneousstandardeventsandclassesPrintingclassesforAdobeIllustratorTracingclassesforAdobeIllustratorCollectionsOtherClassesScriptUIClasses


Contents::Index


Contents

Miscellaneousstandardeventsandclasses




Contents::Index


Contents

PrintingclassesforAdobeIllustrator


FontSubstitutionPolicyInkInkInfoInkPrintStatusInkTypePPDFilePPDFileInfoPageMarksTypesPaperPaperInfoPostScriptImageCompressionTypePrintArtworkDesignationPrintColorIntentPrintColorManagementOptionsPrintColorProfilePrintColorSeparationModePrintColorSeparationOptionsPrintCoordinateOptionsPrintFlattenerOptionsPrintFontDownloadModePrintFontOptionsPrintJobOptionsPrintOptionsPrintOrientationPrintPageMarksOptionsPrintPaperOptionsPrintPositionPrintPostScriptOptionsPrintTilingPrinterPrinterColorModePrinterInfoPrinterTypeEnumPrintingBounds


ScreenScreenInfoScreenSpotFunctionTrappingType


Contents::Index


ContentsTracingclassesforAdobeIllustrator


TracingColorTypeTracingMethodTypeTracingModeTypeTracingObjectTracingOptionsViewType



Contents::Index


Contents Collections


ArtStylesArtboardsBrushesCharacterStylesCharactersCompoundPathItemsDataSetsDocumentsGradientStopsGradientsGraphItemsGroupItemsInsertionPointsLayersLegacyTextItemsLinesMeshItemsNonNativeItemsPageItemsParagraphStylesParagraphsPathItemsPathPointsPatternsPlacedItemsPluginItemsRasterItemsSpotsStoriesSwatchGroupsSwatchesSymbolItemsSymbolsTagsTextFontsTextFrameItems


TextRangesVariablesViewsWords


Contents::Index


Contents OtherClasses


PointRectangle



Contents::Index


Contents ScriptUIClasses

Don'tlikethepanelsanddialogsAdobecameupwith?Createyourownandseeifyoucandobetter.


BoundsButton(SUI)Checkbox(SUI)DimensionDrawStateDropDownListEditTextEnvironmentEvent(SUI)Events(SUI)FlashPlayerGroup(SUI)IconButtonKeyboardStateLayoutManagerListBox(SUI)ListItemPanel(SUI)Point(SUI)ProgressbarRadioButton(SUI)ScriptUIScriptUIBrushScriptUIFontScriptUIGraphicsScriptUIImageScriptUIPathScriptUIPenScrollbarSliderStaticText(SUI)TreeViewUIEventWindow(SUI)



Contents::Index

ClassIndex

$ABCDEFGHIJKLMNOP$

$ABCDEFGHIJKLMNOPAlternateGlyphsForm(enum)

AntiAliasingMethod(enum)

Application

Array

ArtClippingOption(enum)

ArtStyle

ArtStyles

Artboard

Artboards

AutoCADColors(enum)

AutoCADCompatibility(enum)

AutoCADExportFileFormat(enum)

$ABCDEFGHIJKLMNOPBaselineDirectionType(enum)

BlendAnimationType(enum)

BlendModes(enum)

BlendsExpandPolicy(enum)

Boolean

Bounds

Brush

Brushes

$ABCDEFGHIJKLMNOPCMYKColor

CaseChangeType(enum)

CharacterAttributes

CharacterStyle

CharacterStyles

Characters

Checkbox(SUI)

Color

ColorConversion(enum)

ColorConvertPurpose(enum)

ColorDestination(enum)

ColorDitherMethod(enum)

ColorModel(enum)

ColorProfile(enum)

ColorReductionMethod(enum)

ColorType(enum)

$ABCDEFGHIJKLMNOPDataSet DocumentColorSpace(enum)

DataSets

Date

Dimension

Document

DocumentArtboardLayout(enum)

DocumentPreset

DocumentPresetType(enum)

DocumentPreviewMode(enum)

DocumentRasterResolution(enum)

DocumentTransparencyGrid(enum)

$ABCDEFGHIJKLMNOPEPSPostScriptLevelEnum(enum)

EPSPreview(enum)

EPSSaveOptions

EditText

Environment

Error

Event(SUI)

Events(SUI)

ExportOptionsAutoCAD

ExportOptionsFlash

ExportOptionsGIF

ExportOptionsJPEG

$ABCDEFGHIJKLMNOPFXGSaveOptions

FXGVersion(enum)

FigureStyleType(enum)

File

FiltersPreservePolicy(enum)

FirstBaselineType(enum)

FlashExportStyle(enum)

FlashExportVersion(enum)

FlashImageFormat(enum)

FlashJPEGMethod(enum)

FlashPlaybackSecurity(enum)

FlashPlayer

$ABCDEFGHIJKLMNOPGradient

GradientColor

GradientStop

GradientStops

Gradients

GradientsPreservePolicy(enum)

GraphItem

GraphItems

GradientType(enum) GrayColor

$ABCDEFGHIJKLMNOPIconButton

IllustratorSaveOptions

ImageCaptureOptions

ImageColorSpace(enum)

Ink

InkInfo

InkPrintStatus(enum)

InkType(enum)

$ABCDEFGHIJKLMNOPJavaScriptExecutionMode(enum) Justification(enum)

$ABCDEFGHIJKLMNOPKeyboardState KinsokuOrderEnum(enum)

$ABCDEFGHIJKLMNOPLabColor

LanguageType(enum)

Layer

LayerOrderType(enum)

Layers

LayoutManager

LegacyTextItem

LegacyTextItems

$ABCDEFGHIJKLMNOPMath

Matrix

MeshItem

MeshItems

$ABCDEFGHIJKLMNOPNamespace

NoColor

NonNativeItem

NonNativeItems

$ABCDEFGHIJKLMNOPObject

OpenOptions

OpenOptionsAutoCAD

OpenOptionsPDF

$ABCDEFGHIJKLMNOP

$ABCDEFGHIJKLMNOPPDFBoxType(enum)

PDFChangesAllowedEnum(enum)

PDFCompatibility(enum)

PDFOverprint(enum)

PDFPrintAllowedEnum(enum)

PDFSaveOptions

PDFTrimMarkWeight(enum)

PDFXStandard(enum)

PPDFile

PPDFileInfo

PageItem

PageItems

PageMarksTypes(enum)

Panel(SUI)

Paper

PaperInfo

ParagraphAttributes

ParagraphStyle

ParagraphStyles

Paragraphs

PathItem

PathItems

PathPoint

PathPointSelection(enum)

PathPoints

Pattern

PatternColor

Patterns

PerspectiveGridPlaneType(enum)

PhotoshopCompatibility(enum)

PlacedItem

PlacedItems

PluginItem

PluginItems

Point

Point(SUI)

PointType(enum)

PolarityValues(enum)

PostScriptImageCompressionType(enum)

Preferences

PrintArtworkDesignation(enum)

PrintColorIntent(enum)

PrintColorManagementOptions

PrintColorProfile(enum)

$ABCDEFGHIJKLMNOPQName

$ABCDEFGHIJKLMNOPRGBColor RasterLinkState(enum)

RGBColor

RadioButton(SUI)

RasterEffectOptions

RasterItem

RasterItems

RasterLinkState(enum)

RasterizationColorModel(enum)

RasterizeOptions

Rectangle

Reflection

$ABCDEFGHIJKLMNOPSVGCSSPropertyLocation(enum)

SVGDTDVersion(enum)

SVGDocumentEncoding(enum)

SVGFontSubsetting(enum)

SVGFontType(enum)

SaveOptions(enum)

Screen

ScreenInfo

ScreenMode(enum)

ScreenSpotFunction

ScriptUI

ScriptUIBrush

ScriptUIFont

ScriptUIGraphics

ScriptUIImage

ScriptUIPath

ScriptUIPen

Scrollbar

Slider

Socket

Spot

SpotColor

SpotColorKind(enum)

Spots

StaticText(SUI)

Stories

Story

String

$ABCDEFGHIJKLMNOPTIFFByteOrder(enum)

TabStopAlignment(enum)

TabStopInfo

Tag

Tags

TextAntialias(enum)

TextFrameItem

TextFrameItems

TextOrientation(enum)

TextPath

TextPreservePolicy(enum)

TextRange

TextAntialias(enum)

TextFont

TextFonts

TextRange

TextRanges

TextType(enum)

$ABCDEFGHIJKLMNOPUIEvent UnitValue

$ABCDEFGHIJKLMNOPVariable

VariableKind(enum)

Variables

View

$ABCDEFGHIJKLMNOPWariChuJustificationType(enum) Window(SUI)

$ABCDEFGHIJKLMNOPXML XMLList

$ABCDEFGHIJKLMNOPZOrderMethod(enum)


Contents::Index

Class

$ The$objectprovidesanumberofdebuggingfacilitiesand

informationalmethods.

QuickLinks about,bp,colorPicker,evalFile,gc,getenv,setenv,sleep,toString,write,writeln

Class Property Type Access Description

build string readonly TheExtendScriptbuildinformation.

buildDate Date readonly TheExtendScriptbuilddate.

decimalPoint string r/w Thecharacterusedasthedecimalpointcharacterinformattednumericoutput.

engineName string readonly ThenameofthecurrentExtendScriptengine,ifset.

error Error r/w Themostrecentrun-timeerrorinformation.Assigningerrortexttothispropertygeneratesarun-timeerror;however,thepreferredwaytogeneratearun-timeerroristothrowanErrorobject.

fileName string readonly Thefilenameofthecurrentscript.

flags number r/w Getsorsetslow-leveldebugoutputflags.AlogicalANDofbitflagvalues:•0x0002(2):Displays

eachlinewithitslinenumberasitisexecuted.•0x0040(64):Enablesexcessivegarbagecollection.Usually,garbagecollectionstartswhenthenumberofobjectshasincreasedbyacertainamountsincethelastgarbagecollection.ThisflagcausesExtendScripttogarbagecollectafteralmosteverystatement.Thisimpairsperformanceseverely,butisusefulwhenyoususpectthatanobjectgetsreleasedtoosoon.•0x0080(128):Displaysallcallswiththeirargumentsandthereturnvalue.•0x0100(256):Enablesextendederrorhandling(seestrict).•0x0200(512):EnablesthelocalizationfeatureofthetoStringmethod.Equivalenttothelocalizeproperty.

global Object readonly Areferencetotheglobalobject,whichcontainstheJavaScriptglobalnamespace.

hiresTimer number readonly Ahigh-resolutiontimer,measuringthetimeinmicroseconds.ThetimerstartswhenExtendScript

isinitializedduringtheapplicationstartupsequence.EveryreadaccessresetsthetimertoZero.

includePath string readonly Thepathforincludefilesforthecurrentscript.

level number r/w Thecurrentdebugginglevel,whichenablesordisablestheJavaScriptdebugger.Oneof0(nodebugging),1(breakonruntimeerrors),or2(fulldebugmode).

line number readonly Thecurrentlinenumberofthecurrentlyexecutingscript.

locale string r/w Getsorsetsthecurrentlocale.ThestringcontainsfivecharactersintheformLL_RR,whereLLisanISO639languagespecifier,andRRisanISO3166regionspecifier.Initially,thisisthevaluethattheapplicationortheplatformreturnsforthecurrentuser.Youcansetittotemporarilychangethelocalefortesting.Toreturntotheapplicationorplatformsetting,settoundefined,null,ortheemptystring.

localize bool r/w Settotruetoenabletheextendedlocalizationfeaturesofthebuilt-intoString()method.

memCache number r/w TheExtendScriptmemorycachesize,inbytes.

os string readonly Thecurrentoperatingsystemversioninformation.

Example $.osResult:WindowsXP5.1ServicePack2

screens ArrayofObject

readonly Anarrayofobjectscontaininginformationaboutthedisplayscreensattachedtoyourcomputer.Eachobjecthasthepropertiesleft,top,right,bottom,whichcontainthefourcornersofeachscreeninglobalcoordinates.Apropertyprimaryistrueifthatobjectdescribestheprimarydisplay.

stack string readonly Thecurrentstacktrace.

strict any r/w Setsorclearsstrictmodeforobjectmodification.Whentrue,anyattempttowritetoaread-onlypropertycausesaruntimeerror.Someobjectsdonotpermitthecreationofnew

propertieswhentrue.

version string readonly TheversionnumberoftheExtendScriptengine.Formattedasathree-partnumberanddescription;forexample:"3.92.95(debug)".

Methods stringabout()ShowsanAboutboxfortheExtendScriptcomponent,andreturnsthetextforthebox.

voidbp([condition:any])Breaksexecutionatthecurrentposition.Parameter Type Description

condition any AstringcontainingaJavaScriptstatementtobeusedasacondition.Ifthestatementevaluatestotrueornonzerowhenthispointisreached,executionstops.(Optional)

numbercolorPicker(color:number)Invokestheplatform-specificcolorselectiondialog,andreturnstheselectedcolor.Parameter Type Description

color number Thecolortobepreselectedinthedialog,as0xRRGGBB,or-1fortheplatformdefault.

anyevalFile(file:File[,timeout:number=10000])Loadsandevaluatesafile.Parameter Type Description

file File Thefiletoload.

timeout number Anoptionaltimeoutinmilliseconds.(default:10000)(Optional)

voidgc()InitiatesgarbagecollectionintheExtendScriptengine.

stringgetenv(name:string)Retrievesthevalueofanenvironmentvariable.Parameter Type Description

name string Thenameofthevariable.

voidsetenv(name:string,value:string)Setsthevalueofanenvironmentvariable.Parameter Type Description

name string Thenameofthevariable.

value string Thevalueofthevariable.

voidsleep(msecs:number)Suspendsthecallingthreadforanumberofmilliseconds.Duringasleepperiod,checksat100millisecondintervalstoseewhetherthesleepshouldbeterminated.Thiscanhappenifthereisabreakrequest,orifthescripttimeouthasexpired.Parameter Type Description

msecs number Numberofmillisecondstosleep.

stringtoString()Convertsthisobjecttoastring.

voidwrite(text:any)PrintstexttotheConsole.Parameter Type Description

text any Thetexttoprint.Allargumentsareconcatenated.

voidwriteln(text:any)PrintstexttotheConsole,andaddsanewlinecharacter.Parameter Type Description

text any Thetexttoprint.Allargumentsareconcatenated.


Contents::Index

Class

Array Anarraywithintegerindexingandalengthproperty.

QuickLinks Array,concat,join,pop,push,reverse,shift,slice,sort,splice,toLocaleString,toSource,toString,unshift

Properties Property Type Access Description

length number r/w Thelengthofthearray

Methods ConstructorArrayArray(length:number[,element:any])Createsandreturnsanewarray.Takesanynumberofparameters,whichbecometheelementsofthearray,orasinglevaluewhichbecomesthelengthofanemptyarray.Notethatyoucannotcreateaone-elementarray,asthesingleparametervalueisinterpretedasthelength.Returnsthenewarray.Parameter Type Description

length number Ifnootherparametersarepassed,theinitiallengthoftheemptyarray.Otherwise,thefirstelement.

element any Ifthereismorethanoneparameter,thearrayisinitializedwiththegivenparameters.(Optional)

Example newArray()newArray(length)newArray(11,22,33,44)

InstancesArrayconcat(value:any)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedas

separatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description

value any Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.

Example array.concat(value1,...valueN)

stringjoin([delimiter:string])Joinsallelementsofthearrayintoastring;optionally,eachelementisseparatedbydelimiter.Returnsthestringcontainingthejoinedelementsanddelimiters.Parameter Type Description

delimiter string Astringusedtoseparateeachelementofthearray.Ifomitted,thearrayelementsareseparatedwithacomma.(Optional)

Example array.join(delimiter)

anypop()Removesthelastelementfromthearray,decreasesthelengthby1,andreturnsthevalueoftheelement.Returnsthevalueofthedeletedarrayelement.

Example array.pop()

numberpush(value:number)Placesoneormorevaluesontotheendofthearrayandincreaseslengthbyn.Returnsthenewlengthofthearray.Parameter Type Description

value number Anynumberofvaluestobepushedontotheendofthearray.

Example array.push(value1,...valueN)

Arrayreverse()Reversestheorderoftheelementsinthearray.Returnsthereversedarray.

Example array.reverse()

anyshift()Removesthefirstelementfromthearray,decreasesthelengthby1,andreturnsthevalueoftheelement.Returnsthevalueofthedeletedarrayelement.

Example array.shift()

Arrayslice()Createsanewarray,whichcontainsasubsetoftheoriginalarray'selements.Theslicebeginswiththeindexstart,andcontinuesupto,butnotincludingtheindex,end.Ifstartorendisanegativenumber,theindexedisresolvedcountingbackwardsfromtheendofthearrayresultingintheelementarray[array.length+negativeIndex].Returnsanewarraycontainingelementsarray[start]througharray[end-1].

Example array.slice(start,end)

voidsort(userFunction:Function)Sortstheelementsofthearrayinplace,usingthegivenfunctiontocomparetoelements.Ifnofunctionisprovided,theelementsaresortedalphabetically.Returnsnoreturnvalue.Parameter Type Description

userFunction Function Auser-suppliedfunctionoftheformuserFunction(a,b)whichreturnslessthan0ifaisgreaterthanb,0ifaandbareequal,andgreaterthan0ifbisgreaterthana.

Example array.sort(userFunction)

Arraysplice(start:number[,num:number][,value:any])Removesnumelementsfromthearraybeginningwithindex,

start.Optionallyinsertnewelementsbeginningatindexstart.Toensurecontiguity,elementsaremoveduptofillinanygaps.Returnsanewarraycontaininganyelementsdeletedfromtheoriginalarray.Parameter Type Description

start number Theindexofthefirstelementtoremove.Negativevaluesarerelativetotheendofthearray.

num number Thenumberofarrayelementstoremove,includingstart.Ifomitted,allelementsfromarrayindexstarttotheendofthearrayareremoved.(Optional)

value any Alistofoneormorevaluestobeaddedtothearraystartingatindexstart.Mustspecifyavaluefornum,tousethisargument.(Optional)

Example array.splice(start,num,value1,...valuen)

stringtoLocaleString()Convertsanarraytoastringandreturnsthestring(localized).

stringtoSource()Createsastringrepresentationofthisobjectthatcanbefedbacktoeval()tore-createanobject.Worksonlywithbuilt-inclasses.

stringtoString()Convertsanarraytoastringandreturnsthestring.Yieldsthesameresultasarray.join()whencalledwithoutaparameter.Returnsacomma-separatedlistofalltheelementsofthearray.

Example array.toString()

numberunshift(value:any)

Addsoneormoreelementstothebeginningofthearray.Returnsthenewarraylength.Parameter Type Description

value any Thevaluesofoneormoreelementstobeaddedtothebeginningofthearray.

Example array.unshift(value1,...valuen)

Elementof ListItem.subItems

Usedin: anyFunction.apply(thisObj:Object,args:Array)

Return ArrayArray.Array(length:number[,element:any])ArrayArray.concat(value:any)ArrayArray.reverse()ArrayArray.slice()ArrayArray.splice(start:number[,num:number][,value:

any])ArrayFolder.getFiles(mask:any)ArrayRegExp.exec(text:string)ArrayString.match(regexp:RegExp)ArrayXML.inScopeNamespaces()ArrayXML.namespaceDeclarations()


Contents::Index

Class

Boolean WrapsaBooleanvalue.

QuickLinks Boolean,toSource,toString,valueOf

Methods ConstructorboolBoolean(value:any)CreatesandreturnsanewBooleanobjectsettothevalueoftheargumentconvertedtoaboolean.Parameter Type Description

value any ThevaluetobeconvertedtoaBoolean.

Example newBoolean(value)

InstancesstringtoSource()Createsastringrepresentationofthisobjectthatcanbefedbacktoeval()tore-createanobject.Worksonlywithbuilt-inclasses.

stringtoString()Returnsthestringrepresentationofthevalueofbool.Themethodreturnsthestringtrueiftheprimitivevalueofboolistrue;otherwiseitreturnsthestringfalse.

Example bool.toString()

boolvalueOf()Returnstheprimitivevalueofbool.Themethodreturnstrueiftheprimitivevalueofboolistrue;otherwiseitreturnsfalse.

Example bool.valueOf()

Elementof Button.activeButton.enabledButton.visible

Checkbox.activeCheckbox.enabledCheckbox.valueCheckbox.visibleDrawState.altKeyPressedDrawState.capsLockKeyPressedDrawState.cmdKeyPressedDrawState.ctrlKeyPressedDrawState.hasFocusDrawState.leftButtonPressedDrawState.middleButtonPressedDrawState.mouseOverDrawState.numLockKeyPressedDrawState.optKeyPressedDrawState.rightButtonPressedDrawState.shiftKeyPressedDropDownList.activeDropDownList.enabledDropDownList.visibleEditText.activeEditText.enabledEditText.visibleEvent.bubblesEvent.cancelableEvent.capturesEvent.currentTargetFlashPlayer.activeFlashPlayer.enabledFlashPlayer.visibleGroup.enabledGroup.visibleIconButton.activeIconButton.enabledIconButton.visibleKeyboardState.altKeyKeyboardState.ctrlKeyKeyboardState.metaKeyKeyboardState.shiftKeyListBox.active

ListBox.enabledListBox.visibleListItem.checkedListItem.expandedListItem.selectedPanel.enabledPanel.visibleProgressbar.enabledProgressbar.visibleRadioButton.activeRadioButton.enabledRadioButton.valueRadioButton.visibleScrollbar.activeScrollbar.enabledScrollbar.visibleSlider.activeSlider.enabledSlider.visibleStaticText.activeStaticText.enabledStaticText.visibleTreeView.activeTreeView.enabledTreeView.visibleUIEvent.bubblesUIEvent.cancelableUIEvent.capturesUIEvent.currentTargetWindow.activeWindow.enabledWindow.maximizedWindow.minimizedWindow.visible

Usedin: BooleanButton.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanButton.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanCheckbox.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanCheckbox.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanDropDownList.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanDropDownList.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanEditText.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanEditText.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanFlashPlayer.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

voidFlashPlayer.playMovie([rewind:Boolean=false])BooleanFlashPlayer.removeEventListener(eventName:

String,handler:Function[,capturePhase:Boolean=false])

BooleanGroup.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanGroup.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanIconButton.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanIconButton.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanListBox.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanListBox.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanPanel.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanPanel.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanProgressbar.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanProgressbar.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanRadioButton.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanRadioButton.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanScrollbar.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanScrollbar.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanSlider.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanSlider.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanStaticText.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanStaticText.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanTreeView.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanTreeView.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

UIEventUIEvent.UIEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,view:Object][,detail:Number])

voidUIEvent.initEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,cancelable:Boolean=false])

voidUIEvent.initUIEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,view:Object][,detail:Number])

BooleanWindow.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

voidWindow.alert(message:String[,title:String][,errorIcon:Boolean=false])

BooleanWindow.confirm(message:String[,noAsDefault:Boolean=false][,title:String])

BooleanWindow.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

Return BooleanButton(SUI).addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanButton(SUI).removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanCheckbox(SUI).addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanCheckbox(SUI).removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])






BooleanFlashPlayer.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanGroup(SUI).addEventListener(eventName:String,handler:Function[,capturePhase:

Boolean=false])BooleanGroup(SUI).removeEventListener(eventName:




BooleanListBox(SUI).addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanListBox(SUI).removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanPanel(SUI).addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanPanel(SUI).removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])



BooleanRadioButton(SUI).addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanRadioButton(SUI).removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])




BooleanSlider.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])BooleanStaticText(SUI).addEventListener(eventName:


BooleanStaticText(SUI).removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])



BooleanWindow(SUI).addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanWindow(SUI).confirm(message:String[,noAsDefault:Boolean=false][,title:String])

BooleanWindow(SUI).onClose()BooleanWindow(SUI).removeEventListener(eventName:



Contents::Index

Class

Date Adate/timeobject.

QuickLinks Date,UTC,getDate,getDay,getFullYear,getHours,getMilliseconds,getMinutes,getMonth,getSeconds,getTime,getTimezoneOffset,getUTCDate,getUTCDay,getUTCFullYear,getUTCHours,getUTCMilliseconds,getUTCMinutes,getUTCMonth,getUTCSeconds,getYear,parse,setDate,setFullYear,setHours,setMilliseconds,setMinutes,setMonth,setSeconds,setTime,setUTCDate,setUTCFullYear,setUTCHours,setUTCMilliseconds,setUTCMinutes,setUTCMonth,setUTCSeconds,setYear,toDateString,toGMTString,toLocaleDateString,toLocaleString,toLocaleTimeString,toSource,toString,toTimeString,toUTCString,valueOf

Methods ConstructorDateDate(year:number[,month:number=0][,day:number=0][,hours:number=0][,min:number=0][,sec:number=0][,ms:number=0])ReturnsanewDateobjectholdingthecurrentdateandtime.Ifparametersaresupplied,returnsanewDateobjectholdingthesupplieddateandtime.Parameter Type Description

year number Theyearexpressedinfourdigits.

month number(range:0-11)

Anintegervaluefrom0(Jan)to11(Dec).(default:0)(Optional)

day number(range:1-31)

Anintegervaluefrom1to31,Ifthisargumentisnotsupplied,itsvalueissetto0.(default:0)(Optional)

hours number(range:0-23)

Anintegervaluefrom0(midnight)to23(11PM).Ifthisargumentisnotsupplied,itsvalueissetto0.(default:0)(Optional)

min number(range:0-59)

Anintegervaluefrom0to59.Ifthisargumentisnotsupplied,itsvalueissetto0.(default:0)(Optional)

sec number(range:0-59)

AnIntegervaluefrom0to59.Ifthisargumentisnotsupplied,itsvalueissetto0.(default:0)(Optional)

ms number(range:0-999)


Example newDate()newDate(2006,9,25,15,30)

ClassDateUTC(year:number[,month:number=0][,day:number=0][,hours:number=0][,min:number=0][,sec:number=0][,ms:number=0])ReturnsthenumberofmillisecondsbetweenmidnightJanuary1,1970,UTC,andthespecifiedtime.Parameter Type Description

year number Theyearexpressedinfourdigits,forexample,2001.Toindicateforayearfrom1900to1999,youcanspecifyavaluefrom0to99.


Anintegervaluefrom0(Jan)to11(Dec).(default:0)(Optional)

day number(range:1-31)

Anintegervaluefrom1to31,Ifthisargumentisnotsupplied,itsvalueissetto0.(default:0)(Optional)


Anintegervaluefrom0(midnight)to23(11PM).Ifthisargumentisnotsupplied,itsvalueissetto0.(default:

0)(Optional)




AnIntegervaluefrom0to59.Ifthisargumentisnotsupplied,itsvalueissetto0.(default:0)(Optional)



Example Date.UTC(year,month,date,hour,min,sec,ms)

Dateparse(text:string)Parsesastring,returninganewDateobject.ThestringshouldbesimilartothestringreturnedbttoString().Parameter Type Description

text string Thestringtoparse.

InstancesnumbergetDate()ReturnsthedayofthemonthofthespecifiedDateobjectinlocaltime.Range:1-31

Example date.getDate()

numbergetDay()ReturnsthedayoftheweekforthespecifiedDateobjectinlocaltime.Thisisanintegerfrom0(Sunday)to6(Saturday).Returnsthedayoftheweekfordate.Range:0-6

Example date.getDay()

numbergetFullYear()ReturnsthefourdigityearofthespecifiedDateobjectinlocaltime.

Example date.getFullYear()

numbergetHours()ReturnsthehourofthespecifiedDateobjectinlocaltime.Range:0-23

Example date.getHours()

numbergetMilliseconds()ReturnsthemillisecondsofthespecifiedDateobjectinlocaltime.Range:0-999

Example date.getMilliseconds()

numbergetMinutes()ReturnstheminutesofthespecifiedDateobjectinlocaltime.Range:0-59

Example date.getMinutes()

numbergetMonth()ReturnsthemonthofthespecifiedDateobjectinlocaltime.Range:0-11

Example date.getMonth()

numbergetSeconds()ReturnsthesecondsofthespecifiedDateobjectinlocaltime.Range:0-59

Example date.getSeconds()

numbergetTime()ReturnsthenumberofmillisecondssincemidnightJanuary1,1970UTCforthespecifiedDateobject.

Example date.getTime()

numbergetTimezoneOffset()Returnsthedifferenceinminutesbetweenthecomputer'slocaltimeandUTC.

Example date.getTimezoneOffset()

numbergetUTCDate()ReturnsthedayofthemonthofthespecifiedDateobject

accordingtoUTC.Range:1-31

Example date.getUTCDate()

numbergetUTCDay()ReturnsthedayoftheweekforthespecifiedDateobjectaccordingtoUTC.Range:0-6

Example date.getUTCDay()

numbergetUTCFullYear()ReturnsthefourdigityearofthespecifiedDateobjectaccordingtoUTC.

Example date.getUTCFullYear()

numbergetUTCHours()ReturnsthehourofthespecifiedDateobjectaccordingtoUTC.Range:0-23

Example date.getUTCHours()

numbergetUTCMilliseconds()ReturnsthemillisecondsofthespecifiedDateobjectaccordingtoUTC.Range:0-999

Example date.getUTCMilliseconds()

numbergetUTCMinutes()ReturnstheminutesofthespecifiedDateobjectaccordingtoUTC.Range:0-59

Example date.getUTCMinutes()

numbergetUTCMonth()ReturnsthemonthofthespecifiedDateobjectaccordingtoUTC.Range:0-11

Example date.getUTCMonth()

numbergetUTCSeconds()ReturnsthesecondsofthespecifiedDateobjectaccordingtoUTC.Range:0-59

Example date.getUTCSeconds()

numbergetYear()

ReturnstheyearofthespecifiedDateobject,asadifferencefrom1900,inlocaltime.

Example date.getYear()

numbersetDate(date:number)SetsthedayofthemonthofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970.Parameter Type Description

date number(range:1-31)

Anintegerfrom1to31indicatingthedayofthemonth.

Example date.setDate(date)

numbersetFullYear(year:number)SetstheyearofaspecifiedDateobjectaccordingtolocaltime.Thismethodcanalsosetmonthanddateifthoseargumentsarespecified.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970.Parameter Type Description

year number Afour-digitintegervalueindicatingtheyeartoset.

Example date.setFullYear(year,month,date)

numbersetHours(hour:number)SetsthehoursofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970.Parameter Type Description

hour number(range:0-23)

Anintegervaluefrom0(midnight)to23(11PM).

Example date.setHours(hour)

numbersetMilliseconds(ms:number)SetsthemillisecondsofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970.Parameter Type Description


Anintegervaluefrom0to999.

Example date.setMilliseconds(ms)

numbersetMinutes(minutes:number)SetstheminutesofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970.Parameter Type Description

minutes number(range:0-59)


Example date.setMinutes(minutes)

numbersetMonth(month:number)SetsthemonthofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970.Parameter Type Description


Anintegervaluefrom0(Jan)to11(Dec).

Example date.setMonth(month)

numbersetSeconds(seconds:number)SetsthesecondsofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateand

midnight,January1,1970.Parameter Type Description

seconds number(range:0-59)


Example date.setSeconds(seconds)

numbersetTime(ms:number)SetsthedateofaspecifiedDateobjectinmillisecondssincemidnight,January1,1970.Returnsthevalueofms.Parameter Type Description

ms number Anintegerindicatingthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970.

Example date.setTime(ms)

numbersetUTCDate(date:number)SetsthedateofaspecifiedDateobjectaccordingtouniversaltime.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970inUTCtime.Parameter Type Description

date number(range:1-31)

Anintegerfrom1to31indicatingthedayofthemonth.

Example date.setUTCDate(date)

numbersetUTCFullYear(year:number)SetstheyearofaspecifiedDateobjectaccordingtoUTC,canalsosetthemonthanddate.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970,inUTC.Parameter Type Description

year number Theyearexpressedinfourdigits.

Example date.setUTCFullYear(year,month,date)

numbersetUTCHours(hours:number)SetsthehoursofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970,inUTC.Parameter Type Description


Anintegervaluefrom0(midnight)to23(11PM)indicatingthehourtobeset.

Example date.setUTCHours(hours)

numbersetUTCMilliseconds(ms:number)SetsthemillisecondsofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970,inUTC.Parameter Type Description


Anintegervalueintherangeof0to999indicatingthenumberofmillisecondstoset.

Example date.setUTCMilliseconds(ms)

numbersetUTCMinutes(min:number)SetstheminutesofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970,inUTC.Parameter Type Description


Anintegervalueintherange0to59indicatingthenumberofminutestobeset.

Example date.setUTCMinutes(min)

numbersetUTCMonth(month:number)SetsthemonthofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetand

midnight,January1,1970,inUTC.Parameter Type Description


Anintegervalueintherange0(Jan.)to11(Dec.)indicatingthemonthtoset.

Example date.setUTCMonth(month)

numbersetUTCSeconds(sec:number)SetsthesecondsofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970,inUTC.Parameter Type Description


Anintegervalueintherange0to59indicatingthenumberofsecondstoset.

Example date.setUTCSeconds(sec)

numbersetYear(year:number)SetstheyearofaspecifiedDateobjectaccordingtolocaltime,asadifferencebetweenthecurrentyearand1900.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970.Parameter Type Description

year number Anintegervalueindicatingtheyeartoset.Themethodinterpretsa1-or2-digitvaluetomeanthe1900s;forexample,13isinterpretedtomean1913.

Example date.setYear(year,month,date)

stringtoDateString()Returnsthedateasastring.

stringtoGMTString()ReturnsthedateandtimeadjustedtoGMT(UTC)asastring.

stringtoLocaleDateString()Returnsthedateasalocalized

string.

stringtoLocaleString()ReturnsastringvaluerepresentingthedateandtimestoredintheDateobjectinhumanreadableformat(localized).

stringtoLocaleTimeString()Returnsthetimeasalocalizedstring.


stringtoString()ReturnsastringvaluerepresentingthedateandtimestoredintheDateobjectinhumanreadableformat.Returnsthefollowingstringisanexampleoftheformatreturnedbythismethod:MonAug13,10:54:21GMT-07002001.

Example date.toString()

stringtoTimeString()Returnsthetimeasastring.

stringtoUTCString()ReturnsthedateandtimeadjustedtoUTCasastring.

numbervalueOf()ThevalueOf()methodreturnsthenumberofmillisecondsthathavepassedsincemidnight,Returnsaninteger.

Elementof $.buildDateEvent.timeStampFile.createdFile.modifiedFolder.createdFolder.modifiedUIEvent.timeStamp

Return DateDate.Date(year:number[,month:number=0][,day:number=0][,hours:number=0][,min:number=0][,sec:number=0][,ms:number=0])

DateDate.UTC(year:number[,month:number=0][,day:number=0][,hours:number=0][,min:number=0][,sec:number=0][,ms:number=0])

DateDate.parse(text:string)


Contents::Index

Class

Error Wrapsaruntimeerror.

QuickLinks Error,toSource,toString


description string r/w Theerrormessage.

Methods ConstructorErrorError(msg:string[,file:string][,line:number])CreatesanewErrorobject.Parameter Type Description

msg string Theerrormessage.

file string Thenameofthefile.(Optional)

line number Thelinenumber.(Optional)

InstancesstringtoSource()Createsastringrepresentationofthisobjectthatcanbefedbacktoeval()tore-createanobject.Worksonlywithbuilt-inclasses.

stringtoString()Convertthisobjecttoastring.

Elementof $.error

Return ErrorError.Error(msg:string[,file:string][,line:number])


Contents::Index

Class

File Representsafileinthelocalfilesysteminaplatform-

independentmanner.

QuickLinks File,changePath,close,copy,createAlias,decode,encode,execute,getRelativeURI,isEncodingAvailable,open,openDialog,openDlg,read,readch,readln,remove,rename,resolve,saveDialog,saveDlg,seek,tell,toSource,toString,write,writeln

Hierarchy Folder

File


absoluteURI string readonly ThefullpathnameforthereferencedfileinURInotation.

alias bool readonly Iftrue,theobjectreferstoafilesystemaliasorshortcut.

created Date readonly Thecreationdateofthereferencedfile,ornulliftheobjectdoesnotrefertoafileondisk.

creator string readonly InMacOS,thefilecreatorasafour-characterstring.InWindowsorUNIX,valueis"????".

displayName string readonly Thelocalizednameofthereferencedfile,withoutthepathspecification.

encoding string r/w Getsorsetstheencodingforsubsequentread/write

operations.OneoftheencodingconstantslistedintheJavaScriptToolsGuide.Ifthevalueisnotrecognized,usesthesystemdefaultencoding.Aspecialencoder,BINARY,isusedtoreadbinaryfiles.ItstoreseachbyteofthefileasoneUnicodecharacterregardlessofanyencoding.Whenwriting,thelowerbyteofeachUnicodecharacteristreatedasasinglebytetowrite.

eof bool readonly Whentrue,areadattemptcausedthecurrentpositiontobeattheendofthefile,orthefileisnotopen.

error string r/w Astringcontainingamessagedescribingthemostrecentfilesystemerror.Typicallysetbythefilesystem,butascriptcansetit.Settingthisvalueclearsanyerrormessageandresetstheerrorbitforopenedfiles.Containstheemptystringifthereisnoerror.

exists bool readonly Iftrue,thisobjectreferstoafileorfile-systemaliasthatactuallyexistsinthe

filesystem.

fsName string readonly Theplatform-specificfullpathnameforthereferencedfile.

fullName string readonly ThefullpathnameforthereferencedfileinURInotation.

hidden bool r/w Whentrue,thefileisnotshownintheplatform-specificfilebrowser.Iftheobjectreferencesafile-systemaliasorshortcut,theflagisalteredonthealias,notontheoriginalfile.

length number r/w Thesizeofthefileinbytes.Canbesetonlyforafilethatisnotopen,inwhichcaseittruncatesorpadsthefilewith0-bytestothenewlength.

lineFeed string r/w Howlinefeedcharactersarewritteninthefilesystem.Oneofthevalues"Windows","Macintosh",or"Unix".

modified Date readonly Thedateofthereferencedfile'slastmodification,ornulliftheobjectdoesnotrefertoafileonthedisk.

name string readonly ThefilenameportionoftheabsoluteURIforthe

referencedfile,withoutthepathspecification.

parent Folder readonly TheFolderobjectforthefolderthatcontainsthisfile.

path string readonly ThepathportionoftheabsoluteURIforthereferencedfile,withoutthefilename.

readonly bool r/w Whentrue,preventsthefilefrombeingalteredordeleted.Ifthereferencedfileisafile-systemaliasorshortcut,theflagisalteredonthealias,notontheoriginalfile.

relativeURI string readonly ThepathnamefortheobjectinURInotation,relativetothecurrentfolder.

type string readonly Thefiletypeasafour-characterstring.

•InMacOS,theMacOSfiletype.•InWindows,"appl"for.EXEfiles,"shlb"for.DLLfilesand"TEXT"foranyotherfile.


fs string readonly Thenameofthefilesystem.ThisisaclasspropertyaccessedthroughtheFileconstructor.

Validvaluesare"Windows","Macintosh",and"Unix".

Methods ConstructorFileFile([path:string])CreatesandreturnsanewFileobjectreferringtoagivenfilesystemlocation.Parameter Type Description

path string Thefullorpartialpathnameofthefile,inplatform-specificorURIformat.Thevaluestoredintheobjectistheabsolutepath.Thefilethatthepathreferstodoesnotneedtoexist.Ifthepathreferstoanexistingfolder:•TheFilefunctionreturnsaFolderobjectinsteadofaFileobject.•ThenewoperatorreturnsaFileobjectforanonexistingfilewiththesamename.(Optional)

Example newFile(path)

Classstringdecode(uri:string)DecodesaUTF-8encodedstringasrequiredbyRFC2396,andreturnsthedecodedstring.SeealsoString.decodeURI().Parameter Type Description

uri string TheUTF-8encodedstringtodecode.

stringencode(name:string)EncodesastringasrequiredbyRFC2396,andreturnstheencodedstring.AllspecialcharactersareencodedinUTF-8andstoredasescapedcharactersstartingwiththepercentsignfollowedbytwohexadecimaldigits.Forexample,thestring"myfile"isencodedas"my%20file".

Specialcharactersarethosewithanumericvaluegreaterthan127,exceptthefollowing:/-_.!~*'()SeealsoencodeURI().Parameter Type Description

name string Thestringtoencode.

boolisEncodingAvailable(name:string)Reportswhetheragivenencodingisavailable.Parameter Type Description

name string Theencodingname.Typicalvaluesare"ASCII","binary",or"UTF-8".Foracompletelistofsupportedencodings,seetheJavaScriptToolsGuide.

FileopenDialog(prompt:string[,filter:any=null][,multiSelect:bool=false])Opensadialogsotheusercanselectoneormorefilestoopen.Opensthebuilt-inplatform-specificfile-browsingdialoginwhichausercanselectanexistingfileormultiplefiles,andcreatesnewFileobjectstorepresenttheselectedfiles.•IftheuserclicksOK,returnsaFileobjectfortheselectedfile,oranarrayofobjectsifmultiplefilesareselected.•Iftheusercancels,returnsnull.Parameter Type Description

prompt string Theprompttext,displayedifthedialogallowsaprompt.

filter any Afilterthatlimitsthetypesoffilesdisplayedinthedialog.(default:null)

•InWindows,afilterexpressionsuchas"Javascriptfiles:*.jsx;Allfiles:*.*".•InMacOS,afilterfunctionthattakesaFileinstanceandreturnstrueifthefileshouldbeincludedinthedisplay,falseif

itshouldnot.(Optional)

multiSelect bool Whentrue,theusercanselectmultiplefilesandthereturnvalueisanarray.(default:false)(Optional)

FilesaveDialog(prompt:string[,filter:any=null])Opensadialogsotheusercanselectafilenametosaveto.Opensthebuilt-inplatform-specificfile-browsingdialoginwhichausercanselectanexistingfilelocationtowhichtosaveinformation,andcreatesanewFileobjecttorepresenttheselectedfilelocation.•IftheuserclicksOK,returnsaFileobjectfortheselectedfilelocation.•Iftheusercancels,returnsnull.Parameter Type Description

prompt string Theprompttext,displayedifthedialogallowsaprompt.

filter any InWindowsonly,afilterthatlimitsthetypesoffilesdisplayedinthedialog.(default:null)InWindowsonly,afilterexpressionsuchas"Javascriptfiles:*.jsx;Allfiles:*.*".NotusedInMacOS.(Optional)

InstancesboolchangePath(path:string)Changesthepathspecificationofthereferencedfile.Parameter Type Description

path string Astringcontainingthenewpath,absoluteorrelativetothecurrentfolder.

Example file.changePath("..");

boolclose()Closesthisopenfile.Returnstrueifthefilewasclosedsuccessfully,falseifanI/O

erroroccurred.

Example aFile.close()

boolcopy(target:string|File)Copiesthisobject'sreferencedfiletothespecifiedtargetlocation.Resolvesanyaliasestofindthesourcefile.Ifafileexistsatthetargetlocation,itisoverwritten.Returnstrueifthecopywassuccessful.Parameter Type Description

target string|File

AstringwiththeURIpathtothetargetlocation,oraFileobjectthatreferencesthetargetlocation.

Example aFile.copy(target)

voidcreateAlias(path:string)Makesthisfileafile-systemaliasorshortcuttothespecifiedfile.Thereferencedfileforthisobjectmustnotyetexistondisk.Returnstrueiftheoperationwassuccessful.Parameter Type Description

path string Astringcontainingthepathofthetargetfile.

boolexecute()Executesoropensthisfileusingtheappropriateapplication,asifithadbeendouble-clickedinafilebrowser.Youcanusethismethodtorunscripts,launchapplications,andsoon.Returnstrueimmediatelyiftheapplicationlaunchwassuccessful.

stringgetRelativeURI(basePath:string)Retrievesandreturnsthepathforthisfile,relativetothespecifiedbasepath,inURInotation.Ifnobasepathissupplied,theURIisrelativetothepathofthecurrentfolder.ReturnsastringcontainingtherelativeURI.

Parameter Type Description

basePath string AbasepathinURInotation.

Example aFile.getRelativeURI(basePath)

boolopen(mode:string[,type:string][,creator:string])Opensthereferencedfileforsubsequentread/writeoperations.Themethodresolvesanyaliasestofindthefile.Returnstrueifthefilewasopenedsuccessfully.Themethodattemptstodetecttheencodingoftheopenfile.ItreadsafewbytesatthecurrentlocationandtriestodetecttheByteOrderMarkcharacter0xFFFE.Iffound,thecurrentpositionisadvancedbehindthedetectedcharacterandtheencodingpropertyissettooneofthestringsUCS-2BE,UCS-2LE,UCS4-BE,UCS-4LE,orUTF-8.Ifthemarkercharacterisnotfound,itchecksforzerobytesatthecurrentlocationandmakesanassumptionaboutoneoftheaboveformats(exceptUTF-8).Ifeverythingfails,theencodingpropertyissettothesystemencoding.IMPORTANT:Becarefulaboutopeningafilemorethanonce.Theoperatingsystemusuallypermitsyoutodoso,butifyoustartwritingtothefileusingtwodifferentFileobjects,youcandestroyyourdata.Parameter Type Description

mode string Theread-writemode,asingle-characterstring.Oneofthesecharacters:•r(read)Opensforreading.Ifthefiledoesnotexistorcannotbefound,thecallfails.•w(write)Opensafileforwriting.Ifthefileexists,itscontentsaredestroyed.Ifthefiledoesnotexist,createsanew,emptyfile.•e(edit)Opensanexistingfileforreadingandwriting.•a(append)Opensanexistingfileforreadingandwriting,andmovesthe

currentpositiontotheendofthefile.

type string InMacOS,thetypeofanewlycreatedfile,a4-characterstring.IgnoredinWindowsandUNIX.(Optional)

creator string InMacOS,thecreatorofanewlycreatedfile,a4-characterstring.IgnoredinWindowsandUNIX.(Optional)

Example aFile.open(mode,type,creator)

FileopenDlg(prompt:string[,filter:any=null][,multiSelect:bool=false])Opensthebuilt-inplatform-specificfile-browsingdialog,inwhichtheusercanselectanexistingfileorfiles,andcreatesnewFileobjectstorepresenttheselectedfiles.DiffersfromtheclassmethodopenDialog()inthatitpresetsthecurrentfoldertothisFileobject'sparentfolderandthecurrentfiletothisobject'sassociatedfile.•IftheuserclicksOK,returnsaFileorFolderobjectfortheselectedfileorfolder,oranarrayofobjects.•Iftheusercancels,returnsnull.Parameter Type Description

prompt string Astringcontainingtheprompttext,ifthedialogallowsaprompt.

filter any Afilterthatlimitsthetypesoffilesdisplayedinthedialog.(default:null)

•InWindows,afilterexpressionsuchas"Javascriptfiles:*.jsx;Allfiles:*.*".•InMacOS,afilterfunctionthattakesaFileinstanceandreturnstrueifthefileshouldbeincludedinthedisplay,falseifitshouldnot.(Optional)

multiSelect bool Whentrue,theusercanselectmultiplefilesandthereturnvalueisanarray.(default:false)(Optional)

stringread([chars:number])Readsthecontentsofthefile,startingatthecurrentposition.Returnsastringthatcontainsuptothespecifiednumberofcharacters.Ifanumberofcharactersisnotsupplied,readsfromthecurrentpositiontotheendofthefile.Ifthefileisencoded,multiplebytesmightbereadtocreatesingleUnicodecharacters.Parameter Type Description

chars number Anintegerspecifyingthenumberofcharacterstoread.(Optional)

Example aFile.read(chars)

stringreadch()Readsasingletextcharacterfromthefileatthecurrentposition.LinefeedsarerecognizedasCR,LF,CRLForLFCRpairs.Ifthefileisencoded,multiplebytesmightbereadtocreateasingleUnicodecharacter.Returnsastringthatcontainsthecharacter.

Example aFile.readch()

stringreadln()Readsasinglelineoftextfromthefileatthecurrentposition.LinefeedsarerecognizedasCR,LF,CRLForLFCRpairs..Ifthefileisencoded,multiplebytesmightbereadtocreatesingleUnicodecharacters.Returnsastringthatcontainsthetext.

Example aFile.readln()

boolremove()Deletesthefileassociatedwiththisobjectfromdiskimmediately,withoutmovingittothesystemtrash.Doesnotresolvealiases;instead,deletesthereferencedaliasorshortcutfileitself.Returnstrueifthefilewassuccessfullyremoved.•IMPORTANT:Cannotbeundone.Itisrecommendedthatyouprompttheuserforpermissionbeforedeleting.

boolrename(newName:string)Renamestheassociatedfile.Doesnotresolvealiases,butrenamesthereferencedaliasorshortcutfileitself.Returnstrueifthefilewassuccessfullyrenamed.Parameter Type Description

newName string Thenewfilename,withnopathinformation.

Example aFile.rename(newName)

Fileresolve()Attemptstoresolvethefile-systemaliasorshortcutthatthisobjectrefersto.Ifsuccessful,createsandreturnsanewFileobjectthatpointstotheresolvedfilesystemelement.Returnsnullifthisobjectdoesnotrefertoanalias,orifthealiascouldnotberesolved.

FilesaveDlg(prompt:string[,filter:any=null])Opensthebuilt-inplatform-specificfile-browsingdialog,inwhichtheusercanselectanexistingfilelocationtowhichtosaveinformation,andcreatesanewFileobjecttorepresenttheselectedfile.DiffersfromtheclassmethodsaveDialog()inthatitpresetsthecurrentfoldertothisFileobject'sparentfolderandthefiletothisobject'sassociatedfile.•IftheuserclicksOK,returnsaFileobjectfortheselectedfile.•Iftheusercancels,returnsnull.Parameter Type Description

prompt string Astringcontainingtheprompttext,ifthedialogallowsaprompt.

filter any InWindowsonly,afilterthatlimitsthetypesoffilesdisplayedinthedialog.(default:null)InWindowsonly,afilterexpressionsuchas"Javascriptfiles:*.jsx;Allfiles:*.*".NotusedInMacOS.

(Optional)

boolseek(pos:number[,mode:number=0])Seekstoagivenpositioninthefile.Thenewpositioncannotbelessthan0orgreaterthanthecurrentfilesize.Returnstrueifthepositionwaschanged.Parameter Type Description

pos number Thenewcurrentpositioninthefileasanoffsetinbytesfromthestart,currentposition,orend,dependingonthemode.

mode number(range:0-2)

Theseekmode.(default:0)Oneof:•0:Seektoabsoluteposition,wherepos=0isthefirstbyteofthefile.Thisisthedefault.•1:Seekrelativetothecurrentposition.•2.Seekbackwardfromtheendofthefile.(Optional)

Example aFile.seek(pos,mode)

numbertell()Retrievesthecurrentpositionasabyteoffsetfromthestartofthefile.Returnsanumber,thepositionindex.

Example aFile.tell()

stringtoSource()Createsandreturnsaserializedstringrepresentationofthisobject.Passtheresultingstringtoeval()torecreatetheobject.


boolwrite(text:string)Writesthespecifiedtexttothefileatthecurrentposition.

Youcansupplymultipletextvalues;thestringsareconcatenatedtoformasinglestring.Forencodedfiles,writingasingleUnicodecharactermaywritemultiplebytes.Returnstrueifthewritewassuccessful.IMPORTANT:Becarefulnottowritetoafilethatisopeninanotherapplicationorobject,asthiscanoverwriteexistingdata.Parameter Type Description

text string Atextstringtobewritten.

Example aFile.write(text,...)

boolwriteln(text:string)Writesastringtothefileatthecurrentpositionandappendsaline-feedsequence.Youcansupplymultipletextvalues.Thestringsareconcatenatedintoasinglestring,whichiswritteninthefilefollowedbyoneline-feedsequence,ofthestylespecifiedbythisobject'slinefeedproperty.Forencodedfiles,writingasingleUnicodecharactermaywritemultiplebytes.Returnstrueifthewritewassuccessful.IMPORTANT:Becarefulnottowritetoafilethatisopeninanotherapplicationorobject,asthiscanoverwriteexistingdata.Parameter Type Description

text string Atextstringtobewritten.

Example aFile.writeln(text,...)

Elementof Application.colorSettingsListApplication.defaultColorSettingsApplication.pathDocument.fullNameDocument.pathPPDFileInfo.PPDFilePathPlacedItem.filePrintJobOptions.file

RasterItem.fileReflection.sampleFileReflectionInfo.sampleFile

Usedin: any$.evalFile(file:File[,timeout:number=10000])voidApplication.aATExecuteSessionFromFile(file:File)boolApplication.dumpPGFFile(file:File[,

documentColorSpace:DocumentColorSpace],pGFFile:File)

voidApplication.loadAction(actionFilePath:File)voidApplication.loadColorSettings(fileSpec:File)DocumentApplication.open(file:File[,documentColorSpace:

DocumentColorSpace][,options:any])voidApplication.reflectCSAW(outputFolder:File)arrayofstringApplication.showPresets(fileSpec:File)voidDocument.exportFile(exportFile:File,exportFormat:

ExportType[,options:any])voidDocument.exportPDFPreset(file:File)voidDocument.exportPerspectiveGridPreset(file:File)voidDocument.exportPrintPreset(file:File)voidDocument.exportVariables(file:File)voidDocument.imageCapture(imageFile:File[,clipBounds:

Rectangle][,options:ImageCaptureOptions])voidDocument.importCharacterStyles(fileSpec:File)voidDocument.importPDFPreset(fileSpec:File[,

replacingPreset:bool=false])voidDocument.importParagraphStyles(fileSpec:File)voidDocument.importPerspectiveGridPreset(fileSpec:File[,

perspectivePreset:string])voidDocument.importPrintPreset(printPreset:string,

fileSpec:File)voidDocument.importVariables(fileSpec:File)voidDocument.saveAs(saveIn:File[,options:any])voidDocument.windowCapture(imageFile:File,

windowSize:Point)boolFile.copy(target:string|File)voidFlashPlayer.loadMovie(file:File)GroupItemGroupItems.createFromFile(imageFile:File)voidPlacedItem.relink(fileSpec:File)

Return FileApplication.aATGetEditorDialogFile()FileApplication.aATGetErrorDialogFile()FileApplication.getPresetFileOfType(presetType:

DocumentPresetType)FileFile.File([path:string])FileFile.openDialog(prompt:string[,filter:any=null][,

multiSelect:bool=false])FileFile.openDlg(prompt:string[,filter:any=null][,

multiSelect:bool=false])FileFile.resolve()FileFile.saveDialog(prompt:string[,filter:any=null])FileFile.saveDlg(prompt:string[,filter:any=null])


Contents::Index

Class

Folder Representsafile-systemfolderordirectoryinaplatform-

independentmanner.

QuickLinks Folder,changePath,create,decode,encode,execute,getFiles,getRelativeURI,isEncodingAvailable,remove,rename,resolve,selectDialog,selectDlg,toSource,toString

Hierarchy Folder

Folder

File|Folder


absoluteURI string readonly ThefullpathnameforthereferencedfolderinURInotation.

alias bool readonly Whentrue,theobjectreferstoafilesystemaliasorshortcut.

created Date readonly Thecreationdateofthereferencedfolder,ornulliftheobjectdoesnotrefertoafolderondisk.

displayName string readonly ThelocalizednameportionoftheabsoluteURIforthereferencedfolder,withoutthepathspecification.

error string r/w Amessagedescribingthemostrecentfilesystemerror.Typicallysetbythefilesystem,butascriptcansetit.Settingthisvalueclearsanyerrormessageandresetstheerrorbitforopenedfiles.Containstheemptystringif

thereisnoerror.

exists bool readonly Whentrue,thisobjectreferstoafolderthatcurrentlyexistsinthefilesystem.

fsName string readonly Theplatform-specificnameofthereferencedfolderasafullpathname.

fullName string readonly ThefullpathnameforthereferencedfolderinURInotation..

modified Date readonly Thedateofthereferencedfolder'slastmodification,ornulliftheobjectdoesnotrefertoafolderondisk.

name string readonly ThefoldernameportionoftheabsoluteURIforthereferencedfile,withoutthepathspecification.

parent Folder readonly TTheFolderobjectforthefolderthatcontainsthisfolder,ornullifthisobjectreferstotherootfolderofavolume.

path string readonly ThepathportionoftheobjectabsoluteURIforthereferencedfile,withoutthefoldername.

relativeURI string readonly ThepathnameforthereferencedfolderinURInotation,relativetothecurrentfolder.


appData Folder readonly Thefoldercontainingtheapplicationdataforallusers.

•InWindows,thevalueof%APPDATA%(bydefault,C:\\DocumentsandSettings\\AllUsers\\ApplicationData)•InMacOS,/Library/ApplicationSupport

appPackage Folder readonly InMacOS,aFolderobjectforthefoldercontainingthebundleoftherunningapplication.

commonFiles Folder readonly AFolderobjectforthefoldercontainingcommonfilesforallprogramsinstalledbytheuser.

•InWindows,thevalueof%CommonProgramFiles%(bydefault,C:\\ProgramFiles\\CommonFiles)•InMacOS,/Library/ApplicationSupport

current Folder r/w AFolderobjectforthecurrentfolder.AssignaFolderobjectorastringcontainingthenewpathnametosetthecurrentfolder.ThisisaclasspropertyaccessedthroughtheFolderconstructor.

desktop Folder readonly AFolderobjectforthefolderthatcontainstheuser'sdesktop.

•InWindows,C:\\DocumentsandSettings\\username\\Desktop•InMacOS,~/Desktop

fs string readonly Thenameofthecurrentfile

system.Oneof"Windows","Macintosh",or"Unix".

myDocuments Folder readonly Afolderpointingtotheuser'sMyDocumentsfolder.

•InWindows,C:\\DocumentsandSettings\\username\\MyDocuments•InMacOS,~/Documents

startup Folder readonly AFolderobjectforthefoldercontainingtheexecutableimageoftherunningapplication.

system Folder readonly AFolderobjectforthefoldercontainingtheoperatingsystemfiles.

•InWindows,thevalueof%windir%(bydefault,C:\\Windows)•InMacOS,/System

temp Folder readonly AFolderobjectforthedefaultfolderfortemporaryfiles.

trash Folder readonly AFolderobjectforthefoldercontainingdeleteditems.OnWindows,thetrashfolderisavirtualfoldercontainingadatabase;therefore,thepropertyvalueisnullonWindows.

userData Folder readonly AFolderobjectforthefoldercontainingtheuser'sapplicationdata.

•InWindows,thevalueof%USERDATA%(bydefault,

C:\\DocumentsandSettings\\username\\ApplicationData)•InMacOS,~/Library/ApplicationSupport.

Methods ConstructorFolderFolder([path:string])CreatesandreturnsanewFolderobjectreferringtoagivenfile-systemlocation.Ifthepathnamereferstoanalreadyexistingdiskfile,aFileobjectisreturnedinstead.ReturnsthenewFolderobject.Parameter Type Description

path string Theabsoluteorrelativepathtothefolderassociatedwiththisobject,specifiedinURIformat.Thevaluestoredintheobjectistheabsolutepath.Thepathneednotrefertoanexistingfolder.Ifthepathreferstoanexistingfile,ratherthanafolder:•TheFolder()functionreturnsaFileobjectinsteadofaFolderobject.•ThenewoperatorreturnsaFolderobjectforanonexistingfolderwiththesamename.(Optional)

Example newFolder(path)

Classstringdecode(uri:string)DecodesaUTF-8encodedstringasrequiredbyRFC2396,andreturnsthedecodedstring.SeealsoString.decodeURI().Parameter Type Description

uri string TheUTF-8stringtodecode.

stringencode(name:string)

EncodesastringasrequiredbyRFC2396,andreturnstheencodedstring.AllspecialcharactersareencodedinUTF-8andstoredasescapedcharactersstartingwiththepercentsignfollowedbytwohexadecimaldigits.Forexample,thestring"myfile"isencodedas"my%20file".Specialcharactersarethosewithanumericvaluegreaterthan127,exceptthefollowing:/-_.!~*'()SeealsoencodeURI().Parameter Type Description

name string Thestringtoencode.

boolisEncodingAvailable(name:string)Reportswhetheragivenencodingisavailable.Parameter Type Description

name string Theencodingname.Typicalvaluesare"ASCII","binary",or"UTF-8".Foracompletelistofsupportedencodings,seetheJavaScriptToolsGuide.

FolderselectDialog(prompt:string)Opensthebuilt-inplatform-specificfile-browsingdialog,andcreatesanewFileorFolderobjectfortheselectedfileorfolder.DiffersfromtheobjectmethodselectDlg()inthatitdoesnotpreselectafolder.•IftheuserclicksOK,returnsaFileorFolderobjectfortheselectedfileorfolder.•Iftheusercancels,returnsnull.Parameter Type Description

prompt string Theprompttext,ifthedialogallowsaprompt.

InstancesboolchangePath(path:string)Changesthepathspecificationofthereferencedfolder.Parameter Type Description

path string Astringcontainingthenewpath,absoluteorrelativetothecurrentfolder.

Example folder.changePath("..");

boolcreate()Createsafolderatthelocationgivenbythisobject'spathproperty.Returnstrueifthefolderwascreated.

Example aFolder.create()

boolexecute()Opensthisfolderintheplatform-specificfilebrowser(asifithadbeendouble-clickedinthefilebrowser).Returnstrueimmediatelyifthefolderwasopenedsuccessfully.

ArraygetFiles(mask:any)Retrievesthecontentsofthisfolder,filteredbythesuppliedmask.ReturnsanarrayofFileandFolderobjects,ornullifthisobject'sreferencedfolderdoesnotexist.Parameter Type Description

mask any Asearchmaskforfilenames,specifiedasastringorafunction.Amaskstringcancontainquestionmark(?)andasterisk(*)wildcards.Defaultis"*",whichmatchesallfilenames.CanalsobethenameofafunctionthattakesaFileorFolderobjectasitsargument.Itiscalledforeachfileorfolderfoundinthesearch;ifitreturnstrue,theobjectisaddedtothereturnarray.•NOTE:InWindows,allaliasesendwiththeextension.lnk.ExtendScriptstripsthisfromthefilenamewhenfound,inordertopreservecompatibilitywithotheroperatingsystems.Youcansearchforallaliasesbysupplyingthesearchmask"*.lnk",butnotethatsuchcodeisnotportable.

stringgetRelativeURI([basePath:string=.])

Retrievesandreturnsthepathforthisfile,relativetothespecifiedbasepath,inURInotation.Ifnobasepathissupplied,theURIisrelativetothepathofthecurrentfolder.ReturnsastringcontainingtherelativeURI.Parameter Type Description

basePath string AbasepathinURInotation.(default:.)(Optional)

Example aFile.getRelativeURI(basePath)

boolremove()Deletesthefolderassociatedwiththisobjectfromdiskimmediately,withoutmovingittothesystemtrash.Foldersmustbeemptybeforetheycanbedeleted.Doesnotresolvealiases;instead,deletesthereferencedaliasorshortcutfileitself.Returnstrueifthefilewassuccessfullyremoved.•IMPORTANT:Cannotbeundone.Itisrecommendedthatyouprompttheuserforpermissionbeforedeleting.

boolrename(newName:string)Renamestheassociatedfolder.Doesnotresolvealiases,butrenamesthereferencedaliasorshortcutfileitself.Returnstrueifthefolderwassuccessfullyrenamed.Parameter Type Description

newName string Thenewfoldername,withnopathinformation.

Example aFolder.rename(newName)

Folderresolve()Attemptstoresolvethefile-systemaliasorshortcutthatthisobjectrefersto.Ifsuccessful,createsandreturnsanewFolderobjectthatpointstotheresolvedfilesystemelement.Returnsnullifthisobjectdoesnotrefertoanalias,orifthealiascouldnotberesolved.

Example aFolder.resolve()

FolderselectDlg(prompt:string)Opensthebuilt-inplatform-specificfile-browsingdialog,and

createsanewFileorFolderobjectfortheselectedfileorfolder.DiffersfromtheclassmethodselectDialog()inthatitpreselectsthisfolder.•IftheuserclicksOK,returnsaFileorFolderobjectfortheselectedfileorfolder.•Iftheusercancels,returnsnull.Parameter Type Description

prompt string Theprompttext,ifthedialogallowsaprompt.

stringtoSource()Createsandreturnsaserializedstringrepresentationofthisobject.Passtheresultingstringtoeval()torecreatetheobject.


Elementof File.parentFolder.appDataFolder.appPackageFolder.commonFilesFolder.currentFolder.desktopFolder.myDocumentsFolder.parentFolder.startupFolder.systemFolder.tempFolder.trashFolder.userData

Return FolderFolder.Folder([path:string])FolderFolder.resolve()FolderFolder.selectDialog(prompt:string)FolderFolder.selectDlg(prompt:string)


Contents::Index

Class

Function Wrapsabuilt-inorJavaScriptfunction.

QuickLinks Function,apply,call,toSource,toString


arguments Object r/w Thefunctionarguments,packedintoanarray.Thispropertyisdeprecated;usetheargumentspropertywithinthefunctionbody.

arity number readonly Thenumberofformalarguments.Thispropertyisdeprecated;usethelengthpropertyinstead.

length number readonly Thenumberofformalarguments.

name string readonly Thefunctionname.

Methods ConstructorFunctionFunction(arguments:string,body:string)TheFunctionconstructorparsestheargumentlistandcreatesaFunctionobject.Parameter Type Description

arguments string Thelistofformalarguments,separatedbycommas.Theformalargumentscanalsobesuppliedonebyone;inthiscase,thelastargumenttotheFunctionconstructorisconsideredtobethefunctionbody.

body string Thebodyofthefunctiontocreate.

Instancesanyapply(thisObj:Object,args:Array)Applyathisobjectandanargumentlisttoafunction.Thisfunctionisdifferentfromcall();here,theargumentsaresuppliedasanArrayobject.Parameter Type Description

thisObj Object Theobjecttobeusedasthis.

args Array Anarrayofarguments.

anycall(thisObj:Object,argument:any)Applyathisobjectandargumentstoafunction.Thisfunctionisdifferentfromapply();here,theargumentsaresuppliedonebyone.Parameter Type Description

thisObj Object Theobjecttobeusedasthis.

argument any Thefirstagumenttothefunction.Addasmanyasneeded.

stringtoSource()Createsastringrepresentationofthisobjectthatcanbefedbacktoeval()tore-createanobject.WorksonlywithJavaScriptfunctions.

stringtoString()Returnsthefunctiondefinitionasastring.

Elementof Object.constructor

Usedin: voidArray.sort(userFunction:Function)BooleanButton.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])BooleanButton.removeEventListener(eventName:


BooleanCheckbox.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanCheckbox.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])






BooleanFlashPlayer.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])





BooleanListBox.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanListBox.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

voidObject.watch(name:string,func:Function)BooleanPanel.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])BooleanPanel.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])BooleanProgressbar.addEventListener(eventName:




BooleanRadioButton.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])




BooleanSlider.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanStaticText.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

BooleanStaticText.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])




BooleanWindow.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

Return FunctionFunction.Function(arguments:string,body:string)


Contents::Index

Class

global TheglobalmethodsandpropertiesforExtendScript.

QuickLinks alert,confirm,decodeURI,decodeURIComponent,encodeURI,encodeURIComponent,escape,eval,isFinite,isNaN,isXMLName,localize,parseFloat,parseInt,prompt,setDefaultXMLNamespace,unescape,uneval


Infinity number r/w TheInfinityglobalpropertyisapredefinedvariablewiththevalueforinfinity.(default:+Infinity)

NaN number r/w TheNaNglobalpropertyisapredefinedvariablewiththevalueNaN(Not-a-Number),asspecifiedbytheIEEE-754standard.(default:NaN)

undefined Undefined r/w Thisglobalpropertyisapredefinedvariablewiththevalueforanundefinedvalue.(default:undefined)

Methods Instancesvoidalert(message:string[,title:string][,errorIcon:bool=false])DisplaysanalertboxParameter Type Description

message string Thetexttodisplay

title string Thetitleofthealert;ignoredontheMacintosh(Optional)

errorIcon bool DisplayanErroricon;ignoredontheMacintosh(default:false)

boolconfirm(message:string[,noAsDefault:bool=false][,title:string])DisplaysanalertboxwithYesandNobuttons;returnstrueforYesParameter Type Description

message string Thetexttodisplay

noAsDefault bool SettotruetosettheNobuttonasthedefaultbutton(default:false)

title string Thetitleofthealert;ignoredontheMacintosh(Optional)

stringdecodeURI(uri:string)DecodesastringcreatedwithencodeURI().Parameter Type Description

uri string Thetexttodecode.

stringdecodeURIComponent(uri:string)DecodesastringcreatedwithencodeURIComponent().Parameter Type Description

uri string Thetexttodecode.

stringencodeURI(text:string)EncodesastringafterRFC2396.CreateanUTF-8ASCIIencodedversionofthisstring.ThestringisconvertedintoUTF-8.Everynon-alphanumericcharacterisencodedasapercentescapecharacteroftheform%xx,wherexxisthehexvalueofthecharacter.AftertheconversiontoUTF-8encodingandescaping,itisguaranteedthatthestringdoesnotcontaincharacterscodesgreaterthan127.Thelistofcharactersnottobeencodedis-_.!~*'();/?:@&=+$,#.Themethodreturnsfalseonerrors.Parameter Type Description

text string Thetexttoencode.

stringencodeURIComponent(text:string)EncodesastringafterRFC2396.CreateanUTF-8ASCIIencodedversionofthisstring.ThestringisconvertedintoUTF-8.Everynon-alphanumericcharacterisencodedasapercentescapecharacteroftheform%xx,wherexxisthehexvalueofthecharacter.AftertheconversiontoUTF-8encodingandescaping,itisguaranteedthatthestringdoesnotcontaincharacterscodesgreaterthan127.Thelistofcharactersnottobeencodedis-_.!~*'().Themethodreturnsfalseonerrors.Parameter Type Description

text string Thetexttoencode.

stringescape(aString:string)CreatesaURL-encodedstringfromaString.Inthenewstring,charactersofaStringthatrequireURLencodingarereplacedwiththeformat%xx,wherexxisthehexadecimalvalueofthecharactercodeintheUnicodecharacterset.ThisformatisusedtotransmitinformationappendedtoaURLduring,forexample,executionoftheGETmethod.Usetheunescape()globalfunctiontotranslatethestringbackintoitsoriginalformat.ReturnsastringwhichisaStringURL-encoded.Parameter Type Description

aString string Thestringtobeencoded.

Example escape(aString)

anyeval(stringExpression:string)EvaluatesitsargumentasaJavaScriptscript,andreturnstheresultofevaluation.Youcanpasstheresultofanobject'stoSource()methodtoreconstructthatobject.Parameter Type Description

stringExpression string Thestringtoevaluate.

Example eval(stringExpression)

boolisFinite(expression:number)Evaluatesanexpressionandreportswhethertheresultisafinitenumber.Returnstrueiftheexpressionisafinitenumber,falseotherwise.Falseifthevalueisinfinityornegativeinfinity.Parameter Type Description

expression number AnyvalidJavaScriptexpression.

Example isFinite(expression)

boolisNaN(expression:number)Evaluatesanexpressionandreportswhethertheresultis"Not-a-Number"(NaN).Returnstrueiftheresultofevaluationisnotanumber(NaN),falseifthevalueisanumber.Parameter Type Description

expression number AnyvalidJavaScriptexpression.

Example isNaN(expression)

boolisXMLName(name:string)ReturnstrueifthesuppliedstringisavalidXMLname.Parameter Type Description

name string TheXMLnametotest.

stringlocalize(what:string[,argument:any])LocalizesaZString-encodedstringandmergesadditionalargumentsintothestring.Parameter Type Description

what string Thestringtolocalize.AZString-encodedstringthatcancontainplaceholderforadditionalargumentsintheform%1to%n.

argument any Optionalargument(s)tobemergedintothestring.Theremaybemorethanone

argument.(Optional)

numberparseFloat(text:string)Extractsafloating-pointnumberfromastring.Parsesastringtofindthefirstsetofcharactersthatcanbeconvertedtoafloatingpointnumber,andreturnsthatnumber,orNaNifitdoesnotencountercharactersthatitcanconvertedtoanumber.Thefunctionsupportsexponentialnotation.Parameter Type Description

text string Thestringfromwhichtoextractafloatingpointnumber.

Example parseFloat(aString)

numberparseInt(text:string[,base:number])Extractsanintegerfromastring.Parsesastringtofindthefirstsetofcharacters,inaspecifiedbase,thatcanbeconvertedtoaninteger,andreturnsthatinteger,orNaNifitdoesnotencountercharactersthatitcanconverttoanumber.Parameter Type Description

text string Thestringfromwhichtoextractaninteger.

base number(range:2-36)

Thebaseofthestringtoparse(frombase2tobase36).Ifnotsupplied,baseisdeterminedbytheformatofstring.(Optional)

Example parseInt(aString,base)

stringprompt(prompt:string[,default:string][,title:string])DisplaysadialogallowingtheusertoentertextReturnsnulliftheusercancelledthedialog,thetextotherwiseParameter Type Description

prompt string Thetexttodisplay

default string Thedefaulttexttopresettheeditfield

with(Optional)

title string Thetitleofthedialog;(Optional)

voidsetDefaultXMLNamespace(namespace:Namespace)DefinesthedefaultXMLnamespace.ThisisareplacementfunctionforthestandardJavaScriptstatementsetdefaultxmlnamespace.Parameter Type Description

namespace Namespace Thenamespacetouse.Omitthisparametertoreturntotheemptynamespace.ThisiseitheraNamespaceobjectorastring.

stringunescape(stringExpression:string)TranslatesURL-encodedstringintoaregularstring,andreturnsthatstring.Usetheescape()globalfunctiontoURL-encodestrings.Parameter Type Description

stringExpression string TheURL-encodedstringtoconvert.

Example unescape(stringExpression)

stringuneval(what:any)Createsasourcecoderepresentationofthesuppliedargument,andreturnsitasastring.Parameter Type Description

what any Theobjecttouneval.


Contents::Index

Class

Math Aglobalobjectcontainingasetofmathfunctionsand

constants.

QuickLinks abs,acos,asin,atan,atan2,ceil,cos,exp,floor,log,max,min,pow,random,round,sin,sqrt,tan


E number readonly Euler'sconstantandthebaseofnaturallogarithms.(default:2.7182818284590452354)

LN10 number readonly Thenaturallogarithmof10.(default:2.302585092994046)

LN2 number readonly Thenaturallogarithmof2.(default:0.6931471805599453)

LOG10E number readonly Thebase10logarithmofe.(default:0.4342944819032518)

LOG2E number readonly Thebase2logarithmofe.(default:1.4426950408886934)

PI number readonly Theratioofthecircumferenceofacircletoitsdiameter.(default:3.14159265358979323846)

SQRT1_2 number readonly Thereciprocalofthesquarerootof1/2.(default:0.7071067811865476)

SQRT2 number readonly Thesquarerootof2.(default:1.4142135623730951)

Methods numberabs(x:number)Returnstheabsolutevalueofanumber.Parameter Type Description

x number Anumber.

Example Math.abs(x)

numberacos(x:number)Returnsthearccosine(inradians)ofanumber.Parameter Type Description

x number Anumber.

Example Math.acos(x)

numberasin(x:number)Returnsthearcsin(inradians)ofanumber.Parameter Type Description

x number Anumber.

Example Math.asin(x)

numberatan(x:number)Returnsthearctangent(inradians)ofanumber.Parameter Type Description

x number Anumber.

Example Math.atan(x)

numberatan2(y:number,x:number)Returnsthearctangentofthequotientofitsarguments(y/x).Parameter Type Description

y number Anumber.

x number Anumber.

Example Math.atan2(y,x)

numberceil(x:number)Roundsthenumberuptothenearestinteger.Parameter Type Description

x number Anumber.

Example Math.ceil(x)

numbercos(x:number)Returnsthecosineofanangleprovidedinradians.Parameter Type Description

x number Anangle,inradians.

Example Math.cos(x)

numberexp(x:number)ReturnsMath.Eraisedtothepowerofanumber.Parameter Type Description

x number Anumber.

Example Math.exp(x)

numberfloor(x:number)Roundsanumberdowntothenearestinteger.Parameter Type Description

x number Anumber.

Example Math.floor(x)

numberlog(x:number)Returnsthenaturallogarithmofanumber.Parameter Type Description

x number Anumber.

Example Math.log(x)

numbermax(x:number,y:number)Returnsthemaximumoftwonumbers.Parameter Type Description

x number

y number

Example Math.max(x,y)

numbermin(x:number,y:number)Returnstheminimumoftwonumbers.Parameter Type Description

x number Numbers.

y number

Example Math.min(x,y)

numberpow(x:number,y:number)Returnsxraisedtothepowerofy.Parameter Type Description

x number Numbers.

y number

Example Math.pow(x,y)

numberrandom()Returnsapseudo-randomnumberfrom0.0uptobutnotincluding1.0.Range:0.0-0.999999999999999

Example Math.random()

numberround(x:number)Roundsanumbertothenearestinteger.Parameter Type Description

x number Anumber.

Example Math.round(x)

numbersin(x:number)Returnsthesineofanangleprovidedinradians.Parameter Type Description


Example Math.sin(x)

numbersqrt(x:number)Returnsthesquarerootofanumber.Parameter Type Description

x number Anumber.

Example Math.sqrt(x)

numbertan(x:number)Returnsthetangentofanangleprovidedinradians.Parameter Type Description


Example Math.tan(x)


Contents::Index

Class

Namespace AXMLnamespaceobject.

QuickLinks Namespace


prefix string readonly Thenamedprefix.

uri string readonly TheURI.

Methods ConstructorNamespaceNamespace(prefix:any[,uri:string])CreatesaNamespaceobject.Parameter Type Description

prefix any TheURIprefix,specifiedasanexistingNamespaceobject,QNameobject,orstring.

•IfthisisaNamespaceoraQNameobject,theURIandprefixaresettothatoftheobject.•Ifthisisastring,theprefixissettothatstring,andtheURImustbespecified.

uri string TheURIiftheprefixisspecifiedasastring.(Optional)

Example newNamespace("adobe","http:/www.adobe.com")

Usedin: XMLXML.addNamespace(namespace:Namespace)

XMLXML.removeNamespace(namespace:Namespace)

voidXML.setNamespace(namespace:Namespace)

voidglobal.setDefaultXMLNamespace(namespace:Namespace)

Return NamespaceNamespace.Namespace(prefix:any[,uri:string])

NamespaceXML.namespace()


Contents::Index

Class

Number Wrapsanumericvalue.

QuickLinks Number,toExponential,toFixed,toLocaleString,toPrecision,toString,valueOf


MAX_VALUE number readonly Aconstantrepresentingthelargestrepresentablenumber.(default:1.7976931348623158e+308

MIN_VALUE number readonly Aconstantrepresentingthesmallestrepresentablenumber.(default:2.2250738585072014e-308

NEGATIVE_INFINITY number readonly Aconstantrepresentingnegativeinfinity.

NaN number readonly Aconstantrepresentingthespecial"NotaNumber"value.(default:

POSITIVE_INFINITY number readonly Aconstantrepresentingpositiveinfinity.

Methods ConstructorNumberNumber(value:any)ReturnsanewNumberobjectsettothevalueoftheargumentconvertedtoanumber.Parameter Type Description

value any Thevalueoftheobjectbeingcreated.

Example newNumber(value)

Instances

numbertoExponential(decimals:number)ConvertstheNumberobjecttoastringinscientificnotation.Parameter Type Description

decimals number Thenumberofdecimals.

numbertoFixed(decimals:number)ConvertstheNumberobjecttoastringwithfixeddecimals.Parameter Type Description


numbertoLocaleString()ReturnsthevalueofaNumberobjectconvertedtoastring,usinglocalizedconventions.

numbertoPrecision(decimals:number)ConvertstheNumberobjecttoastringineitherscientificorfixednotation,ependingonitsvalue.Parameter Type Description


numbertoSource()Createsastringrepresentationofthisobjectthatcanbefedbacktore-createanobject.Worksonlywithbuilt-inclasses.

numbertoString([radix:number])ReturnsthevalueofaNumberobjectconvertedtoastring.Parameter Type Description

radix number Theoptionalconversionradix.(Optional)

Example num.toString(16)

numbervalueOf()ReturnsthevalueofaNumberobjectasaprimitivenumber.

Example num.valueOf()

Elementof Bounds.bottomBounds.height

Bounds.leftBounds.lengthBounds.rightBounds.topBounds.widthBounds.xBounds.yButton.charactersButton.indentCheckbox.charactersCheckbox.indentDimension.heightDimension.lengthDimension.widthDropDownList.indentEditText.charactersEditText.indentFlashPlayer.indentGroup.indentGroup.marginsGroup.spacingIconButton.indentListBox.indentListItem.indexPanel.charactersPanel.indentPanel.marginsPanel.spacingPoint.leftPoint.lengthPoint.topPoint.xPoint.yProgressbar.indentProgressbar.maxvalueProgressbar.minvalueProgressbar.valueRadioButton.charactersRadioButton.indent

ScriptUIBrush.colorScriptUIBrush.typeScriptUIFont.sizeScriptUIPen.colorScriptUIPen.lineWidthScrollbar.indentScrollbar.jumpdeltaScrollbar.maxvalueScrollbar.minvalueScrollbar.stepdeltaScrollbar.valueSlider.indentSlider.maxvalueSlider.minvalueSlider.valueStaticText.charactersStaticText.indentTreeView.indentWindow.charactersWindow.indentWindow.marginsWindow.opacityWindow.spacing

Usedin: ScriptUIFontScriptUI.newFont(name:String,style:String|Number)

voidScriptUIGraphics.drawFocusRing(left:Number,top:NumberNumber,height:Number)

voidScriptUIGraphics.drawImage(image:ScriptUIImage,lefttop:Number[,width:Number][,height:Number])

voidScriptUIGraphics.drawString(text:String,pen:ScriptUIPenNumber,y:Number[,font:ScriptUIFont])

PointScriptUIGraphics.ellipsePath(left:Number,top:NumberNumber,height:Number)

PointScriptUIGraphics.lineTo(x:Number,y:Number)DimensionScriptUIGraphics.measureString(text:String[,font

ScriptUIFont][,boundingWidth:Number])PointScriptUIGraphics.moveTo(x:Number,y:Number)ScriptUIBrushScriptUIGraphics.newBrush(type:Number,color

Number|String)ScriptUIPenScriptUIGraphics.newPen(type:Number,color

Number|String,width:Number)PointScriptUIGraphics.rectPath(left:Number,top:Number

Number,height:Number)UIEventUIEvent.UIEvent(type:String[,captures:Boolean=

bubbles:Boolean=false][,view:Object][,detail:NumbervoidUIEvent.initUIEvent(type:String[,captures:Boolean=false

Boolean=false][,view:Object][,detail:Number])

Return NumberNumber.Number(value:any)


Contents::Index

Class

Object ThebaseclassofallJavaScriptobjects.

QuickLinks Object,hasOwnProperty,isPrototypeOf,isValid,propertyIsEnumerable,toLocaleString,toSource,toString,unwatch,valueOf,watch


constructor Function readonly Pointstotheconstructorfunctionthatcreatedthisobject.NotethatthispropertyistreatedasanXMLelementintheXMLclass.

prototype Object readonly Pointstotheprototypeobjectforthisobject.NotethatthispropertyistreatedasanXMLelementintheXMLclass.

reflect Reflection readonly RetrievesandreturnstheReflectionobjectassociatedwiththismethodoraproperty.NotethatthispropertyistreatedasanXMLelementintheXMLclass.

Methods ConstructorObjectObject(what:any)Createsandreturnsanewobjectofagiventype.Parameter Type Description

what any Theobjecttype.

Example newObject()

ClassboolisValid(what:Object)Reportswhetheranobjectisstillvalid.Parameter Type Description

what Object Theobjecttocheck.

InstancesboolhasOwnProperty(name:string)Reportswhetheragivenpropertyisdefinedwithaninstanceorwithintheprototypechain.Parameter Type Description

name string Thenameofthepropertytocheck.

boolisPrototypeOf(what:Object)Checkswhetherthegivenobjectisaprototypeofthisobject.Parameter Type Description

what Object Theobjecttocheck.

boolpropertyIsEnumerable(name:string)Reportswhetheragivenpropertyisenumerable.Parameter Type Description

name string Thenameofthepropertytocheck.

stringtoLocaleString()Createsandreturnsastringrepresentingthisobject,localizedforthecurrentlocale.SeetoString().

stringtoSource()Createsandreturnsastringrepresentationofthisobject.Thisfunctionserializestheobject,sothatitcan,forexample,bepassedbetweenengines.Passthereturnedstringbacktoeval()torecreatetheobject.Worksonlywithbuilt-inclasses.

stringtoString()Createsandreturnsastringrepresentingthisobject.Manyobjects(suchasDate)overridethismethodinfavoroftheirownimplementation.Ifanobjecthasnostringvalueandnouser-definedtoString()method,thedefaultmethodreturns[objecttype],wheretypeistheobjecttypeorthenameoftheconstructorfunctionthatcreatedtheobject.

Example obj.toString()

voidunwatch(name:string)Removesthewatchfunctionofaproperty.Parameter Type Description

name string Thenameofthepropertytounwatch.

ObjectvalueOf()Retrievesandreturnstheprimitivevalueofthisobject.Iftheobjecthasnoprimitivevalue,returnstheobjectitself.Notethatyourarelyneedtocallthismethodyourself.TheJavaScriptinterpreterautomaticallyinvokesitwhenencounteringanobjectwhereaprimitivevalueisexpected.

Example obj.valueOf()

voidwatch(name:string,func:Function)Addsawatchfunctiontoaproperty,whichiscalledwhenthevaluechanges.Thisfunctioncanaccept,modify,orrejectanewvaluethattheuser,application,orascripthasattemptedtoplaceinaproperty.Parameter Type Description

name string Thenameofthepropertytowatch.

func Function Thefunctiontobecalledwhenthevalueofthispropertychanges.Thisfunctionmustthreearguments,andreturnasitsresultthevaluetobestoredintheproperty.Theargumentsare:•name:thenameofthepropertythat

changes.•oldValue:Theoldpropertyvalue.•newValue:Thenewpropertyvaluethatwasspecified.

Elementof $.global$.screensApplication.parentArtStyle.parentArtStyles.parentArtboard.parentArtboards.parentBrush.parentBrushes.parentButton.childrenButton.parentButton.propertiesCharacterAttributes.parentCharacterStyle.parentCharacterStyles.parentCharacters.parentCheckbox.childrenCheckbox.parentCheckbox.propertiesCompoundPathItem.parentCompoundPathItems.parentDataSet.parentDataSets.parentDocument.parentDocuments.parentDropDownList.childrenDropDownList.parentDropDownList.propertiesEditText.childrenEditText.parentEditText.propertiesEvent.targetFlashPlayer.parent

FlashPlayer.propertiesFunction.argumentsGradient.parentGradientStop.parentGradientStops.parentGradients.parentGraphItem.parentGraphItems.parentGroup.childrenGroup.parentGroup.propertiesGroupItem.parentGroupItems.parentIconButton.childrenIconButton.parentIconButton.propertiesInsertionPoint.parentInsertionPoints.parentLayer.parentLayers.parentLegacyTextItem.parentLegacyTextItems.parentLines.parentListBox.childrenListBox.columnsListBox.parentListBox.propertiesListItem.parentListItem.propertiesMeshItem.parentMeshItems.parentNonNativeItem.parentNonNativeItems.parentObject.prototypeOpenOptionsAutoCAD.parentOpenOptionsPDF.parentOpenOptionsPhotoshop.parentPageItem.parentPageItems.parent

Panel.childrenPanel.parentPanel.propertiesParagraphAttributes.parentParagraphStyle.parentParagraphStyles.parentParagraphs.parentPathItem.parentPathItems.parentPathPoint.parentPathPoints.parentPattern.parentPatterns.parentPlacedItem.parentPlacedItems.parentPluginItem.parentPluginItems.parentPreferences.parentProgressbar.childrenProgressbar.parentProgressbar.propertiesRadioButton.childrenRadioButton.parentRadioButton.propertiesRasterItem.parentRasterItems.parentScriptUI.FontStyleScriptUI.applicationFontsScriptUI.compatibilityScriptUIFont.styleScriptUIGraphics.BrushTypeScriptUIGraphics.PenTypeScrollbar.childrenScrollbar.parentScrollbar.propertiesSlider.childrenSlider.parentSlider.propertiesSpot.parent

Spots.parentStaticText.childrenStaticText.parentStaticText.propertiesStories.parentStory.parentSwatch.parentSwatchGroup.parentSwatchGroups.parentSwatches.parentSymbol.parentSymbolItem.parentSymbolItems.parentSymbols.parentTag.parentTags.parentTextFont.parentTextFonts.parentTextFrameItem.parentTextFrameItems.parentTextPath.parentTextRange.parentTextRanges.parentTracingObject.parentTracingOptions.parentTreeView.childrenTreeView.parentTreeView.propertiesUIEvent.targetVariable.parentVariables.parentView.parentViews.parentWindow.cancelElementWindow.childrenWindow.defaultElementWindow.parentWindow.propertiesWords.parent

Usedin: CompoundPathItemCompoundPathItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

CompoundPathItemCompoundPathItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

anyFunction.apply(thisObj:Object,args:Array)anyFunction.call(thisObj:Object,argument:any)GraphItemGraphItem.duplicate(relativeObject:Object,

insertionLocation:ElementPlacement)GraphItemGraphItem.move(relativeObject:Object,

insertionLocation:ElementPlacement)ObjectGroup.add(type:String[,bounds:Bounds][,text:

String][,properties:Object])GroupItemGroupItem.duplicate(relativeObject:Object,

insertionLocation:ElementPlacement)GroupItemGroupItem.move(relativeObject:Object,

insertionLocation:ElementPlacement)LayerLayer.move(relativeObject:Object,insertionLocation:

ElementPlacement)LegacyTextItemLegacyTextItem.move(relativeObject:

Object,insertionLocation:ElementPlacement)MeshItemMeshItem.duplicate(relativeObject:Object,

insertionLocation:ElementPlacement)MeshItemMeshItem.move(relativeObject:Object,

insertionLocation:ElementPlacement)NonNativeItemNonNativeItem.duplicate(relativeObject:

Object,insertionLocation:ElementPlacement)NonNativeItemNonNativeItem.move(relativeObject:Object,

insertionLocation:ElementPlacement)boolObject.isPrototypeOf(what:Object)boolObject.isValid(what:Object)PageItemPageItem.duplicate(relativeObject:Object,

insertionLocation:ElementPlacement)PageItemPageItem.move(relativeObject:Object,

insertionLocation:ElementPlacement)ObjectPanel.add(type:String[,bounds:Bounds][,text:

String][,properties:Object])

PathItemPathItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

PathItemPathItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

PlacedItemPlacedItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

PlacedItemPlacedItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

PluginItemPluginItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

PluginItemPluginItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

RasterItemRasterItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

RasterItemRasterItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

SymbolSymbol.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

SymbolItemSymbolItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

SymbolItemSymbolItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

TextFrameItemTextFrameItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

TextFrameItemTextFrameItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

TextRangeTextRange.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

TextRangeTextRange.move(relativeObject:Object,insertionLocation:ElementPlacement)

UIEventUIEvent.UIEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,view:Object][,detail:Number])


voidWindow.Window(type:String[,title:String][,bounds:Bounds][,properties:Object])

ObjectWindow.add(type:String[,bounds:Bounds][,text:

String][,properties:Object])voidXML.setSettings(obj:Object)

Return ObjectGroup(SUI).add(type:String[,bounds:Bounds][,text:String][,properties:Object])

ObjectObject.Object(what:any)ObjectObject.valueOf()ObjectPanel(SUI).add(type:String[,bounds:Bounds][,text:

String][,properties:Object])ObjectWindow(SUI).add(type:String[,bounds:Bounds][,

text:String][,properties:Object])ObjectXML.defaultSettings()ObjectXML.settings()


Contents::Index

Class

QName AqualifiedXMLname,containingtheURIandthelocal

name.

QuickLinks QName


localName string readonly Thelocalnamepartofthequalifiedname.

uri string readonly TheURIpartofthequalifiedname.

Methods ConstructorQNameQName(uri:any[,name:string])CreatesaQNameobject.Parameter Type Description

uri any TheURI,specifiedasaNamespaceobject,anexistingQNameobject,orstring.

•IfthisisaNamespaceobject,theURIissettothenamespaceURI,andthereisnolocalname.•IfthisisaQNameobject,theURIandlocalNameissettothoseofthatobject.•Ifthisisastring,theURIissettothatstring.

name string Thelocalname.UsedonlyifURIisgivenasastring.(Optional)

Example newQName("http:/www.adobe.com","name")

voidXML.setName(name:QName)

Usedin:

Return QNameQName.QName(uri:any[,name:string])QNameXML.name()


Contents::Index

Class

Reflection Providesinformationaboutaclass.

QuickLinks find,toXML


description string readonly Thelongdescriptiontext.

help string readonly Theshortdescriptiontext.

methods ArrayofReflectionInfo

readonly Anarrayofmethoddescriptions.

name string readonly Theclassname.

properties ArrayofReflectionInfo

readonly Anarrayofpropertydescriptions.

sampleCode string readonly Samplecode,ifpresent.

sampleFile File readonly Afilecontainingsamplecode.Maybenull.

staticMethods ArrayofReflectionInfo

readonly Anarrayofclassmethoddescriptions.

staticProperties ArrayofReflectionInfo

readonly Anarrayofclasspropertydescriptions.

Methods InstancesReflectionInfofind(name:string)Findsanelementdescriptionbyname.Parameter Type Description

name string Thenameoftheelementtofind.

XMLtoXML()ReturnsthisclassinformationasXMLinOMVformat.

Elementof Object.reflectReflectionInfo.parent


Contents::Index

Class

ReflectionInfo Providesinformationaboutamethod,apropertyora

methodparameters.

Hierarchy Reflection

ReflectionInfo


arguments ArrayofReflectionInfo

readonly Thedescriptionofmethodorfunctionarguments.

dataType string readonly Thedatatype.

defaultValue any readonly Thedefaultvalue.

description string readonly Thelongdescriptiontext.

help string readonly Theshortdescriptiontext.

isCollection bool readonly Containstrueiftheclassdescribesacollectionclass.

max number readonly Themaximumvalue.

min number readonly Theminimumvalue.

name string readonly Theelementname.

parent Reflection readonly Theclassobjectthatthiselementbelongsto.

sampleCode string readonly Samplecode,ifpresent.

sampleFile File readonly Afilecontainingsamplecode.Maybenull.

type string readonly Theelementtype.Oneofunknown,readonly,readwrite,createonly,methodorparameter.

Elementof Reflection.methodsReflection.propertiesReflection.staticMethodsReflection.staticPropertiesReflectionInfo.arguments

Return ReflectionInfoReflection.find(name:string)


Contents::Index

Class

RegExp Wrapsaregularexpression.

QuickLinks RegExp,compile,exec,test,toString


$1 string readonly Thematchedsubexpression#1.









global bool r/w Indicateswhetherthematchisaglobalmatch.

ignoreCase bool r/w Indicateswhetherthematchisnotcasesensitive.

input string r/w Theoriginalinputstring.

lastMatch string readonly Thelastmatch.

lastParen string readonly Thevalueofthelastmatchedsubexpression.

leftContext string readonly Thestringbeforethematch.

multiline bool r/w Indicateswhetherthematchmatchesmultiplelines.

rightContext string readonly Thestringafterthematch.

Methods ConstructorRegExpRegExp(pattern:string[,flags:string])CreatesandreturnsanewRegExpobjectsettothevalueoftheargumentconvertedtoaregularexpression.Parameter Type Description

pattern string Thepatterntoconvert.

flags string Flagsthatcontrolhowtheconversionisperformed.Astringcontaininganycombinationofthelettersi,m,g:•"i"--ignorecaseinpatternmatching•"m"--treatthestringasmultiplelines•"g"--doglobalpatternmatching(Optional)

Instancesboolcompile(pattern:string)Compilesastringtoaregularexpression.Returnstrueifthecompilationwassuccessful.Parameter Type Description

pattern string Thepatterntocompile.

Arrayexec(text:string)Executearegularexpression.Thereturnvalueisanarrayofmatches,withthefirstelementcontainingthematch,andsuccessiveelementscontainingtheresultsofanymatchingsubexpressionintheirorderofappearance.Ifthereisnomatch,theresultisnull.Parameter Type Description

text string Thestringtomatch.

booltest(text:string)Executearegularexpression,andreturntrueifthereisamatch.Parameter Type Description

text string Thestringtomatch.

stringtoString()ConvertsthisRegExpobjecttoastring.

Usedin: ArrayString.match(regexp:RegExp)numberString.search(search:RegExp)

Return RegExpRegExp.RegExp(pattern:string[,flags:string])


Contents::Index

Class

Socket CreatesaTCP/IPconnection,orestablishesaTCP/IPserver.

QuickLinks Socket,close,listen,open,poll,read,readln,write,writeln


connected bool readonly Whentrue,theconnectionisactive.

encoding string r/w Setsorretrievesthenameoftheencodingusedtotransmitdata.Typicalvaluesare"ASCII","BINARY",or"UTF-8".

eof bool readonly Whentrue,thereceivebufferisempty.

error string r/w Amessagedescribingthemostrecenterror.Settingthisvalueclearsanyerrormessage.

host string readonly Thenameoftheremotecomputerwhenaconnectionisestablished.Iftheconnectionisshutdownordoesnotexist,thepropertycontainstheemptystring.

timeout number r/w Thetimeoutinsecondstobeappliedtoreadorwriteoperations.(default:10)

Methods ConstructorSocketSocket()CreatesanewSocketobject.

Instancesboolclose()Terminatestheopenconnection.Returnstrueiftheconnectionwasclosed,falseonI/Oerrors.Deletingtheobjectalsoclosestheconnection,butnotuntilJavaScriptgarbage-collectstheobject.Theconnectionmightstayopenlongerthanyouwishifyoudonotcloseitexplicitly.

boollisten(port:number[,encoding:string=ASCII])Instructstheobjecttostartlisteningforanincomingconnection.Thecalltoopen()andthecalltolisten()aremutuallyexclusive.Callonefunctionortheother,notboth.Parameter Type Description

port number(range:1-65535)

TheTCP/IPportnumbertolistenon.Validportnumbersare1to65535.Typicalvaluesare80foraWebserver,23foraTelnetserverandsoon.

encoding string Theencodingtobeusedfortheconnection(default:ASCII)Typicalvaluesare"ASCII","BINARY",or"UTF-8".(Optional)

boolopen(host:string[,encoding:string=ASCII])Openstheconnectionforsubsequentread/writeoperations.Thecalltoopen()andthecalltolisten()aremutuallyexclusive.Callonefunctionortheother,notboth.Parameter Type Description

host string Theservertoconnectto.ThiscanbeaDNSname,anIPv4address,oranIPv6address,followedbyacolonandaportnumber.

encoding string Theencodingtobeusedfortheconnection(default:ASCII)Typicalvaluesare"ASCII","binary",or

"UTF-8".(Optional)

Socketpoll()Checksalisteningobjectforanewincomingconnection.Ifaconnectionrequestwasdetected,themethodreturnsanewSocketobjectthatwrapsthenewconnection.Usethisconnectionobjecttocommunicatewiththeremotecomputer.Afteruse,closetheconnectionanddeletetheJavaScriptobject.Ifnonewconnectionrequestwasdetected,themethodreturnsnull.

stringread([count:number])Readsuptothespecifiednumberofcharactersfromtheconnection.CRcharactersareignoredunlesstheencodingissetto"BINARY".Returnsastringthatcontainsuptothenumberofcharactersthatweresupposedtoberead,orthenumberofcharactersreadbeforetheconnectionclosedortimedout.Parameter Type Description

count number Thenumberofcharacterstoread.Ifnotsupplied,theconnectionattemptstoreadasmanycharactersitcangetandreturnsimmediately.(Optional)

stringreadln()Readsonelineoftextuptothenextlinefeed.LinefeedsarerecognizedasLForCRLFpairs.CRcharactersareignored.Returnsastringcontainingthecharacters.

boolwrite(text:string)Concatenatesallargumentsintoasinglestringandwritesthatstringtotheconnection.Parameter Type Description

text string Anynumberofstringvalues.Allargumentsareconcatenatedtoformthestringtobewritten.CRLFsequencesareconvertedtoLFsunlesstheencodingissetto"BINARY".

boolwriteln(text:string)Concatenatesallargumentsintoasinglestring,appendsaLFcharacter,andwritesthatstringtotheconnection.Parameter Type Description

text string Anynumberofstringvalues.Allargumentsareconcatenatedtoformthestringtobewritten.CRLFsequencesareconvertedtoLFsunlesstheencodingissetto"BINARY".

Example Seefile Socket.jsx

Return SocketSocket.Socket()SocketSocket.poll()


Contents::Index

Class

String Acharacterstring.Eachcharacterisadressablebyindex.

QuickLinks String,anchor,big,blink,bold,charAt,charCodeAt,concat,fixed,fontcolor,fontsize,fromCharCode,indexOf,italics,lastIndexOf,link,localeCompare,match,replace,search,slice,small,split,strike,sub,substr,substring,sup,toLocaleLowerCase,toLocaleUpperCase,toLowerCase,toSource,toString,toUpperCase,valueOf


length number readonly Thelengthofthestring.

Methods ConstructorStringString(value:any)Returnsastringrepresentationofthevaluegivenasanargument.Parameter Type Description

value any Anumber,variable,orobjecttoconverttoastring.

Example newString(value)

ClassStringfromCharCode(value1:number)ReturnsastringcreatedbyconcatenationoneormorecharactersspecifiedasASCIIvalues.Parameter Type Description

value1 number OneormoreASCIIvalues.

Example String.fromCharCode(value1,...valueN)

Instancesstringanchor(name:string)

Returnsastringconsistingofthisstringenclosedina<a>tag.Parameter Type Description

name string Thetexttobestoredintheanchors'nameattribute.

stringbig()Returnsastringconsistingofthisstringenclosedina<big>tag.

stringblink()Returnsastringconsistingofthisstringenclosedina<blink>tag.

stringbold()Returnsastringconsistingofthisstringenclosedinatag.

stringcharAt(index:number)Returnsthecharacteratthespecifiedindex.Parameter Type Description

index number Anintegerbetween0andstring.length-1,specifyingthecharactertoreturn.

Example string.charAt(index)

numbercharCodeAt(index:number)ReturnstheUnicodevalueofthecharacteratthegivenindex.Parameter Type Description

index number Anintegerbetween0andstring.length-1,specifyingthecharacter.

Example string.charCodeAt(index)

stringconcat(value:string)Ifnecessary,convertstheoneormoregivenvaluestostrings.Thosevaluesareconcatenatedwiththeoriginalstring,theresultisreturned.Theoriginalstringisnoteffected.Returnstheconcatenatedstring.Parameter Type Description

value string Thevaluestobeconcatenatedwiththe

givenstring.

Example string.concat(value1,...valueN)

stringfixed()Returnsastringconsistingofthisstringenclosedina<tt>tag.

stringfontcolor(color:string)Returnsastringconsistingofthisstringenclosedinatag.Parameter Type Description

color string Thevaluetobestoredinthetag'scolorattribute.

stringfontsize(size:number)Returnsastringconsistingofthisstringenclosedinatag.Parameter Type Description

size number Thevaluetobestoredinthetag'ssizeattribute.

numberindexOf(searchValue:string[,offset:number])Returnstheindexwithinthestringofthefirstoccurrenceofthespecifiedstring,startingthesearchatfromIndexifprovided.Parameter Type Description

searchValue string Thestringforwhichtosearch.

offset number Thestartingoffsetofthesearch.(Optional)

Example string.indexOf(searchValue,fromIndex)

stringitalics()Returnsastringconsistingofthisstringenclosedinatag.

numberlastIndexOf(searchValue:string[,offset:number])Returnstheindexwithinthestringofthelastoccurrenceofthespecifiedvalue.Thestringissearchedbackward,startingatfromIndex.

ReturnstheindexwithinthestringwherethelastoccurrenceofsearchValuewasfound,or-1ifitwasnotfound.Parameter Type Description

searchValue string Thestringforwhichtosearch.

offset number Thestartingoffsetofthesearch.(Optional)

Example string.lastIndexOf(searchValue,fromIndex)

stringlink(href:string)Returnsastringconsistingofthisstringenclosedina<a>tag.Parameter Type Description

href string Thevaluetobestoredinthetag'shrefattribute.

numberlocaleCompare(what:string)Performsalocalizedcomparisonoftwostrings.Parameter Type Description

what string Thestringtocomparewith.

Arraymatch(regexp:RegExp)Matchesastringagainstaregularexpression.Parameter Type Description

regexp RegExp Theregularexpressiontouse.

stringreplace(what:any,with:string)Parameter Type Description

what any

with string

numbersearch(search:RegExp)Parameter Type Description

search RegExp

stringslice(startSlice:number[,endSlice:number])Extractsasubstringofthegivenstringandreturnsitasanewstring.ThesubstringbeginsatstartSlice,andincludesallcharactersupto,butnotincludingthecharacterattheindexendSlice.Anegativevalueindexesfromtheendofthestring.Forexample,anegativevalueforstartSliceisresolvedas:string.length+startSlice.Theoriginalstringisunchanged.Returnsasubstringofcharactersfromthegivenstring,startingatstartSliceandendingwithendSlice-1.Parameter Type Description

startSlice number Theindexatwhichtobeginextraction.

endSlice number Theindexatwhichtoendextraction.Ifomitted,sliceextractstotheendofthestring.(Optional)

Example string.slice(startSlice,endSlice)

stringsmall()Returnsastringconsistingofthisstringenclosedinatag.

stringsplit(delimiter:string,limit:number)Splitsastringintoagroupofsubstrings,placesthosestringsinanarray,andreturnsthearray.Thesubstringsarecreatedbybreakingtheoriginalstringatplacesthatmatchdelimiter,thedelimitercharactersareremoved.Returnsanarraywhoseelementsarethesubstrings.Parameter Type Description

delimiter string Specifiesthestringtousefordelimiting.Ifdelimiterisomitted,thearrayreturnedcontainsoneelement,consistingoftheentirestring.

limit number

Example string.split(delimiter)

stringstrike()Returnsastringconsistingofthisstringenclosedina<strike>tag.

stringsub()Returnsastringconsistingofthisstringenclosedinatag.

stringsubstr(start:number,length:number)Returnsastringcontainingthecharactersbeginningatthespecifiedindex,start,throughthespecifiednumberofcharacters.Theoriginalstringisunchanged.Returnsastringcontainingtheextractedcharacters.Parameter Type Description

start number Locationatwhichtobeginextractingcharacters.

length number (OptIonal)Thenumberofcharacterstoextract.

Example string.substr(start,length)

stringsubstring(indexA:number[,indexB:number])ReturnsasubstringofthegivenstringbyextractingcharactersfromindexAuptobutnotincludingindexB.Theoriginalstringisunchanged.Returnsasubstringofcharactersfromthegivenstring,startingatindexAandendingwithindexB-1.Parameter Type Description

indexA number Theindextobeginextracting.

indexB number (Optional)Theindexatwhichtoendextraction.Ifomitted,sliceextractstotheendofthestring.

Example string.substring(indexA,indexB)

stringsup()Returnsastringconsistingofthisstringenclosedinatag.

stringtoLocaleLowerCase()Returnsanewstringwhichcontainsallthecharactersoftheoriginalstringconvertedtolowercase(localized).Theoriginalstringisunchanged.

stringtoLocaleUpperCase()Returnsanewstringwhichcontainsallthecharactersoftheoriginalstringconvertedtouppercase(localized).Theoriginalstringisunchanged.

stringtoLowerCase()Returnsanewstringwhichcontainsallthecharactersoftheoriginalstringconvertedtolowercase.Theoriginalstringisunchanged.

Example string.toLowerCase()


stringtoString()Returnsitself.

stringtoUpperCase()Returnsanewstringwhichcontainsallthecharactersoftheoriginalstringconvertedtouppercase.Theoriginalstringisunchanged.

Example string.toUpperCase()

stringvalueOf()Returnsitself.

Elementof Button.alignmentButton.helpTipButton.justifyButton.shortcutKeyButton.text

Button.typeCheckbox.alignmentCheckbox.helpTipCheckbox.justifyCheckbox.shortcutKeyCheckbox.textCheckbox.typeDropDownList.alignmentDropDownList.helpTipDropDownList.shortcutKeyDropDownList.typeEditText.alignmentEditText.helpTipEditText.justifyEditText.shortcutKeyEditText.textEditText.textselectionEditText.typeEvent.eventPhaseEvent.typeFlashPlayer.alignmentFlashPlayer.helpTipFlashPlayer.typeGroup.alignChildrenGroup.alignmentGroup.helpTipGroup.orientationGroup.typeIconButton.alignmentIconButton.helpTipIconButton.shortcutKeyIconButton.typeKeyboardState.keyNameListBox.alignmentListBox.helpTipListBox.shortcutKeyListBox.typeListItem.textListItem.type

Panel.alignChildrenPanel.alignmentPanel.helpTipPanel.justifyPanel.orientationPanel.textPanel.typeProgressbar.alignmentProgressbar.helpTipProgressbar.typeRadioButton.alignmentRadioButton.helpTipRadioButton.justifyRadioButton.shortcutKeyRadioButton.textRadioButton.typeScriptUI.AlignmentScriptUI.coreVersionScriptUI.frameworkNameScriptUIBrush.themeScriptUIFont.familyScriptUIFont.nameScriptUIFont.substituteScriptUIImage.formatScriptUIImage.nameScriptUIImage.pathnameScriptUIPen.themeScriptUIPen.typeScrollbar.alignmentScrollbar.helpTipScrollbar.shortcutKeyScrollbar.typeSlider.alignmentSlider.helpTipSlider.shortcutKeySlider.typeStaticText.alignmentStaticText.helpTipStaticText.justify

StaticText.shortcutKeyStaticText.textStaticText.typeTreeView.alignmentTreeView.helpTipTreeView.shortcutKeyTreeView.typeUIEvent.eventPhaseUIEvent.typeWindow.alignChildrenWindow.alignmentWindow.frameworkNameWindow.helpTipWindow.justifyWindow.orientationWindow.shortcutKeyWindow.textWindow.type

Usedin: BooleanButton.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])

voidButton.notify([eventName:String])BooleanButton.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])BooleanCheckbox.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])voidCheckbox.notify([eventName:String])BooleanCheckbox.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])ListItemDropDownList.add(type:String[,text:String])BooleanDropDownList.addEventListener(eventName:


ListItemDropDownList.find(text:String)voidDropDownList.notify([eventName:String])BooleanDropDownList.removeEventListener(eventName:



voidEditText.notify([eventName:String])BooleanEditText.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])Event(SUI)Events.createEvent(eventType:String)BooleanFlashPlayer.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])AnyFlashPlayer.invokePlayerFunction(name:String[,

argument:Any])voidFlashPlayer.notify([eventName:String])BooleanFlashPlayer.removeEventListener(eventName:


ObjectGroup.add(type:String[,bounds:Bounds][,text:String][,properties:Object])




voidIconButton.notify([eventName:String])BooleanIconButton.removeEventListener(eventName:


ListItemListBox.add(type:String[,text:String])BooleanListBox.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])ListItemListBox.find(text:String)voidListBox.notify([eventName:String])BooleanListBox.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])ObjectPanel.add(type:String[,bounds:Bounds][,text:

String][,properties:Object])BooleanPanel.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])BooleanPanel.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])




voidRadioButton.notify([eventName:String])BooleanRadioButton.removeEventListener(eventName:


StringScriptUI.getResourceText(text:String)ScriptUIFontScriptUI.newFont(name:String,style:String|

Number,size:Number)ScriptUIImageScriptUI.newImage(normal:String[,disabled:

String][,pressed:String][,rollover:String])voidScriptUIGraphics.drawString(text:String,pen:

ScriptUIPen,x:Number,y:Number[,font:ScriptUIFont])

DimensionScriptUIGraphics.measureString(text:String[,font:ScriptUIFont][,boundingWidth:Number])

ScriptUIBrushScriptUIGraphics.newBrush(type:Number,color:ArrayofNumber|String)

ScriptUIPenScriptUIGraphics.newPen(type:Number,color:ArrayofNumber|String,width:Number)


voidScrollbar.notify([eventName:String])BooleanScrollbar.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])BooleanSlider.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])voidSlider.notify([eventName:String])BooleanSlider.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])BooleanStaticText.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])voidStaticText.notify([eventName:String])BooleanStaticText.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])ListItemTreeView.add(type:String[,text:String])BooleanTreeView.addEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])ListItemTreeView.find(text:String)voidTreeView.notify([eventName:String])BooleanTreeView.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])UIEventUIEvent.UIEvent(type:String[,captures:

Boolean=false][,bubbles:Boolean=false][,view:Object][,detail:Number])

voidUIEvent.initEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,cancelable:Boolean=false])



ObjectWindow.add(type:String[,bounds:Bounds][,text:String][,properties:Object])


voidWindow.alert(message:String[,title:String][,errorIcon:Boolean=false])

BooleanWindow.confirm(message:String[,noAsDefault:Boolean=false][,title:String])

WindowWindow.find(type:String,title:String)voidWindow.notify([eventName:String])StringWindow.prompt(prompt:String[,default:String][,

title:String])BooleanWindow.removeEventListener(eventName:String,

handler:Function[,capturePhase:Boolean=false])

Return StringScriptUI.getResourceText(text:String)StringString.String(value:any)StringString.fromCharCode(value1:number)StringWindow(SUI).prompt(prompt:String[,default:

String][,title:String])


Contents::Index

Class

UnitValue Representsameasurementasacombinationofvalues

andunit.Notethatthisobjectisnotavailableinallapplications.

QuickLinks as,convert


baseUnit UnitValue r/w Thebaseunit.

type string readonly Theunitname.

value number r/w Thenumericvalue.


baseUnit UnitValue r/w Thebaseunitforallconversions.

Methods InstancesUnitValueas(unitName:string)Returnsthisinstanceasadifferentunit.Parameter Type Description

unitName string Theunitname.

anyconvert(unitName:string)Convertsthisinstancetoadifferentunit.Parameter Type Description

unitName string Theunitname.

Elementof UnitValue.baseUnitUnitValue.baseUnit

Return UnitValueUnitValue.as(unitName:string)


Contents::Index

Class

XML WrapsXMLintoanobject.

QuickLinks XML,addNamespace,appendChild,attribute,attributes,child,childIndex,children,comments,contains,copy,defaultSettings,descendants,elements,hasComplexContent,hasSimpleContent,inScopeNamespaces,insertChildAfter,insertChildBefore,length,localName,name,namespace,namespaceDeclarations,nodeKind,normalize,parent,prependChild,processingInstructions,removeNamespace,replace,setChildren,setLocalName,setName,setNamespace,setSettings,settings,text,toString,toXMLString,xpath


ignoreComments bool r/w ControlswhetherXMLcommentsshouldbeparsed(false)orignored(true).(default:true)

ignoreProcessingInstructions bool r/w ControlswhetherXMLpreprocessinginstructionsshouldbeparsed(false)orignored(true).(default:true)

ignoreWhitespace bool r/w Controls

whetherwhitespaceshouldbeparsed(false)orignored(true).(default:true)

prettyIndent number r/w Thenumberofspacesusedtoindentpretty-printedXML.(default:2)

prettyPrinting bool r/w Whentrue,XMLispretty-printedwhenconvertingtoastring.(default:true)

Methods ConstructorXMLXML(text:string)ParsesanXMLstring.ThrowsanerroriftheXMLisincorrect.Parameter Type Description

text string Thetexttoparse.

ClassObjectdefaultSettings()ReturnsanobjectcontainingthedefaultparsingandprintsettingsforXML.

voidsetSettings(obj:Object)SetstheparsingandprintsettingforXMLusinganobject

returnedbythesettings()method.Parameter Type Description

obj Object Theobjectcontainingthesettingstoset.

Objectsettings()ReturnsanobjectcontainingthecurrentparsingandprintsettingsforXML.

InstancesXMLaddNamespace(namespace:Namespace)Addsanamespacedeclarationtothenode.ReturnstheXMLobjectitself.Parameter Type Description

namespace Namespace Thenamespacetoadd.

XMLappendChild(child:XML)AppendsthegivenXMLtothisXMLasachild.ReturnstheXMLobjectitself.IftheargumentisnotXML,createsanewXMLelementcontainingtheargumentastext.TheelementnameofthatnewXMListhesameasthelastelementintheoriginalXML.Parameter Type Description

child XML ThechildXMLtoadd.

XMLattribute(name:string)Returnsalistcontainingallattributeelementsmatchingthegivenname.Parameter Type Description

name string Theattributenametolookfor.

XMLattributes()Returnsalistcontainingallattributeelements.

XMLchild(name:string)ReturnsalistcontainingallchildrenofthisXMLmatchingthegivenelementname.Iftheargumentisanumber,usesthenumberasindexintothe

arrayofchildren.Parameter Type Description

name string Thenameortheindexofthechildelement.

numberchildIndex()ReturnsanumberrepresentingtheordinalpositionofthisXMLobjectwithinthecontextofitsparent.

XMLchildren()ReturnsanXMLobjectcontainingallthepropertiesofthisXMLobjectinorder.

XMLcomments()ReturnsanXMLobjectcontainingthepropertiesofthisXMLobjectthatrepresentXMLcomments.

boolcontains(xml:XML)ChecksifthisXMLobjectcontainsthegivenXMLobject.Parameter Type Description

xml XML TheXMLtosearchfor.

XMLcopy()CreatesacopyofthisXMLobject.

XMLdescendants([name:string])ReturnsalltheXML-valueddescendantsofthisXMLobjectwiththegivenname.Ifthenameparameterisomitted,returnsalldescendantsofthisXMLobject.Parameter Type Description

name string Thenameofthedescendanttofind.(Optional)

XMLelements([name:string])ReturnsalistofXMLchildrenthatareelementswithagivenname,orallchildrenthatareXMLelements.Parameter Type Description

name string Theelementname.Ifnotsupplied,getsallchildrenthatareXMLelements.(Optional)

boolhasComplexContent()ReportswhetherthisXMLobjectcontainscomplexcontent.AnXMLobjectisconsideredtocontaincomplexcontentifitrepresentsanXMLelementthathaschildelements.XMLobjectsrepresentingattributes,comments,processinginstructionsandtextnodesdonothavecomplexcontent.Theexistenceofattributes,comments,processinginstructionsandtextnodeswithinanXMLobjectisnotsignificantindeterminingifithascomplexcontent.

boolhasSimpleContent()ReportswhetherthisXMLobjectcontainssimplecontent.AnXMLobjectisconsideredtocontainsimplecontentifitrepresentsatextnode,representsanattributenodeorifitrepresentsanXMLelementthathasnochildelements.XMLobjectsrepresentingcommentsandprocessinginstructionsdonothavesimplecontent.Theexistenceofattributes,comments,processinginstructionsandtextnodeswithinanXMLobjectisnotsignificantindeterminingifithassimplecontent.

ArrayinScopeNamespaces()ReturnsanarrayofNamespaceobjectsmirroringthecurrentlistofvalidnamespacesatthiselement.Thelastelementofthereturnedarrayisthedefaultnamespace.

voidinsertChildAfter(child1:XML,child2:XML)Insertsthegivenchild2afterthegivenchild1inthisXMLobjectandreturnsthisXMLobject.Ifchild1isnull,themethodinsertschild2beforeallchildrenofthisXMLobject(thatis,afternoneofthem).Ifchild1doesnotexistinthisXMLobject,themethodreturnswithoutmodifyingthisXMLobject.Parameter Type Description

child1 XML Thechildtoinserttheotherchildafter.Ifnull,themethodinsertschild2beforeallchildrenofthisXMLobject.

child2 XML TheXMLtoinsert.

voidinsertChildBefore(child1:XML,child2:XML)Insertsthegivenchild2beforethegivenchild1inthisXMLobjectandreturnsthisXMLobject.Ifchild1isnull,themethodinsertschild2afterallchildrenofthisXMLobject(thatis,beforenoneofthem).Ifchild1doesnotexistinthisXMLobject,themethodreturnswithoutmodifyingthisXMLobject.Parameter Type Description

child1 XML Thechildtosearchfor.Ifnull,themethodinsertschild2afterallchildrenofthisXMLobject.

child2 XML TheXMLtoinsert.

numberlength()ReturnsthenumberofelementscontainedinanXMLlist.IfthisXMLobjectisnotalist,returns1.

stringlocalName()ReturnsthelocalnameofthisXMLobject.Thisvaluecorrespondstotheelementnameunlessthenamehasanamespaceprefix.Forexample,iftheelementhasthename"ns:tag",thereturnvalueis"tag".

QNamename()ReturnsaQNameobjectcontainingtheURIandthelocalnameoftheelement.

Namespacenamespace()ReturnsaNamespaceobjectcontainingthenamespaceURIofthecurrentelement.

ArraynamespaceDeclarations()ReturnsanarraycontainingallnamespacedeclarationsofthisXMLobject.

stringnodeKind()ReturnsthetypeofthisXMLobjectasoneofthestrings"element","attribute","comment","processing-instruction",or

"text".

XMLnormalize()PutsalltextnodesinthisandalldescendantXMLobjectsintoanormalformbymergingadjacenttextnodesandeliminatingemptytextnodes.ReturnsthisXMLobject.

XMLparent()ReturnstheparentobjectofthisXMLobject.Therootobject,asreturnedbytheXMLconstructor,doesnothaveaparentandreturnsnull.NotethattheE4XstandarddoesnotdefinewhathappensifthisXMLobjectisalistcontainingelementswithmultipleparents.

XMLprependChild(child:XML)InsertsagivenchildintothisobjectbeforeitsexistingXMLproperties,andreturnsthisXMLobject.Parameter Type Description

child XML TheXMLtoinsert.

XMLprocessingInstructions([name:string])Returnsalistofpreprocessinginstructions.Collectsprocessing-instructionswiththegivenname,ifsupplied.Otherwise,returnsanXMLlistcontainingallthechildrenofthisXMLobjectthatareprocessing-instructionsregardlessoftheirname.Parameter Type Description

name string Thenameofthepreprocessinginstructiontoreturn.(Optional)

XMLremoveNamespace(namespace:Namespace)RemovesthegivennamespacefromthisXML,andreturnsthisXML.Parameter Type Description

namespace Namespace Thenamespacetoremove.

XMLreplace(name:string,value:XML)ReplacesthevalueofspecifiedXMLpropertiesofthisXMLobjectreturnsthisXMLobject.

Thismethodactsliketheassignmentoperator.Parameter Type Description

name string Thepropertyname.Canbeanumericpropertyname,anameforasetofXMLelements,orthepropertieswildcard"*".IfthisXMLobjectcontainsnopropertiesthatmatchthename,themethodreturnswithoutmodifyingthisXMLobject.

value XML TheXMLwithwhichtoreplacethevalueofthematchingproperty.CanbeanXMLobject,XMLlistoranyvaluethatcanbeconvertedtoaStringwithtoString().

XMLsetChildren(value:XML)ReplacesalloftheXML-valuedpropertiesinthisobjectwithanewvalue,andreturnsthisXMLobject.Parameter Type Description

value XML Thenewvalue,whichcanbeasingleXMLobjectoranXMLlist.

voidsetLocalName(name:string)ReplacesthelocalnameofthisXMLobjectwithastringconstructedfromthegivennameThelocalnameisanypartbehindacoloncharacter.Ifthereisnocolon,itistheentirename.Parameter Type Description

name string Thenametoset.

voidsetName(name:QName)ReplacesthenameofthisXMLobjectwiththegivenQNameobject.Parameter Type Description

name QName Thefullyqualifiedname.

voidsetNamespace(namespace:Namespace)SetsthenamespaceforthisXMLelement.Ifthenamespacehasnotbeendeclaredinthetreeabovethiselement,addsanamespacedeclaration.Parameter Type Description

namespace Namespace Thenamespacetoset.

XMLtext()ReturnsanXMLlistcontainingallXMLpropertiesofthisXMLobjectthatrepresentXMLtextnodes.

stringtoString()Returnsthestringrepresentationofthisobject.Fortextandattributenodes,thisisthetextualvalueofthenode;forotherelements,thisistheresultofcallingthetoXMLString()method.IfthisXMLobjectisalist,concatenatestheresultofcallingtoString()oneachelement.

stringtoXMLString()ReturnsanXML-encodedstringrepresentationofthisXMLobject.Alwaysincludesthestarttag,attributesandendtagoftheXMLobjectregardlessofitscontent.ItisprovidedforcaseswhenthedefaultXMLtostringconversionrulesarenotdesired.InterpretstheglobalsettingsXML.prettyPrintandXML.prettyIndent.

XMLxpath(expr:string)EvaluatesthegivenXPathexpressioninaccordancewiththeW3CXPathrecommendation,usingthisXMLobjectasthecontextnode.Parameter Type Description

expr string TheXPathexpressiontouse.

Usedin: XMLXML.appendChild(child:XML)boolXML.contains(xml:XML)voidXML.insertChildAfter(child1:XML,child2:XML)voidXML.insertChildBefore(child1:XML,child2:XML)XMLXML.prependChild(child:XML)

XMLXML.replace(name:string,value:XML)XMLXML.setChildren(value:XML)

Return XMLReflection.toXML()XMLXML.XML(text:string)XMLXML.addNamespace(namespace:Namespace)XMLXML.appendChild(child:XML)XMLXML.attribute(name:string)XMLXML.attributes()XMLXML.child(name:string)XMLXML.children()XMLXML.comments()XMLXML.copy()XMLXML.descendants([name:string])XMLXML.elements([name:string])XMLXML.normalize()XMLXML.parent()XMLXML.prependChild(child:XML)XMLXML.processingInstructions([name:string])XMLXML.removeNamespace(namespace:Namespace)XMLXML.replace(name:string,value:XML)XMLXML.setChildren(value:XML)XMLXML.text()XMLXML.xpath(expr:string)


Contents::Index

Class

XMLList AnXMLlistobject.

Inthisimplementation,anXMLListobjectissynonymoustotheXMLobject.TheconstructoracceptsanXMLlist,buteverythingelseworksliketheXMLobject.


Contents::Index

Class

Application TheAdobeIllustratorapplication.

QuickLinks aATAddItem,aATClear,aATDuplicateItem,aATEditItemaATExecuteSessionFromFile,aATFileRelativeChangedaATGetErrorDialogFile,aATGetListOfRelativePaths,aATLoadModel,aATLoadSessionFile,aATLoadUIExtensionaATReplaceItem,aATSaveAsSession,aATSaveSessionbeep,concatenateMatrix,concatenateRotationMatrix,concatenateTranslationMatrix,convertSampleColor,copyexecuteMenuCommand,getExecutionOutput,getIdentityMatrixgetPresetSettings,getRotationMatrix,getScaleMatrix,getVersionString,invertMatrix,isEqualMatrix,isSingularMatrixpaste,quit,redo,redraw,reflectCSAW,runAPITest,sendScriptMessagetranslatePlaceholderText,translateString,undo,unloadAction

Hierarchy Object

Application

Properties Property Type

PDFPresetsList Arrayofstring

PPDFileList ArrayofPPDFile

activeDocument Document

browserAvailable bool

buildNumber string

colorSettingsList ArrayofFile

coordinateSystem CoordinateSystem:CoordinateSystem.DOCUMENTCOORDINATESYSTEMCoordinateSystem.ARTBOARDCOORDINATESYSTEM

defaultColorSettings File

documents Documents Document

flattenerPresetsList Arrayofstring

freeMemory Int32

locale string

name string

parent Object

path File

preferences Preferences

printPresetsList Arrayofstring

printerList ArrayofPrinter

scriptingVersion string

selection any

startupPresetsList Arrayofstring

textFonts TextFonts TextFont

tracingPresetsList Arrayofstring

typename string

userInteractionLevel UserInteractionLevel:UserInteractionLevel.DONTDISPLAYALERTSUserInteractionLevel.DISPLAYALERTS

version string

visible bool

Methods InstancesstringaATAddItem(sessionIndex:Int32,destinationSequenceIDsrcItemIDData:string,type:string)Addthespecifiedtothesequencer.Parameter Type Description

sessionIndex Int32 Theindexinthesessionofthetop-mostsequencefortheitemtoadd.

destinationSequenceID Int32 TheUIDfortheowningsequence.

destinationIndex Int32 TheitemUIDwheretoinsert.

srcItemIDData string TheitemIDoftheitemtoconstruct.

type string Thesourceoftheitemtoconstruct.

stringaATClear()Clearthesequencer.

stringaATDuplicateItem(sessionIndex:Int32,item:Duplicatesthespecifieditem(s)fromthesequencer.Parameter Type Description


item string TheitemUID(s)

stringaATEditItem(sessionIndex:Int32,item:stringOpensthespecifieditemfromthesequencerintheitemeditor.Parameter Type Description


item string TheitemUID.

boolaATErrorsExist()Retrievesabooleanindicatingthepresenceoferrorsinthelastscripttoexecute.

voidaATExecuteSession()Executestheactivesessioninthesequencer.

voidaATExecuteSessionFromFile(file:File)Executestheactivesessioninthesequencer.Parameter Type Description

file File Executeasessionfile.

stringaATFileRelativeChanged(path:string,relativeSwitchesafilesrelativetokenandpath.Parameter Type Description

path string ThepathrelativetothefolderspecifiedbyRelative.

relative string Thecurrentrelativepathtoken.

newRelative string Thenewrelativepathtoken.

stringaATFileSaveDialog(path:string,relative:stringPromptstheusertosaveafileorchooseafileordirectoryandreturnsarelativepathstringtothefile.Parameter Type Description

path string ThepathrelativetothefolderspecifiedbyRelative.

relative string Thecurrentrelativepathtoken.

type string Thetypeofdialogtoshowinstringformat.

FileaATGetEditorDialogFile()RetrievesafilepathtotheAATeditorswf.

FileaATGetErrorDialogFile()

RetrievesafilepathtotheAATerrordialogswf.

stringaATGetListOfRelativePaths()GetsanXMLstringlistingtherelativepathsandtheUIstringstodisplaythem.

stringaATGetSession()Gettheactivesessionforthesequncer.

stringaATLoadLibExtension()Loadsasessionfileasanextensiontotheeditor.

stringaATLoadModel()Loadstheaatmodeltotheeditor.

stringaATLoadSessionFile()Loadsasessionintothesequencer.

stringaATLoadUIExtension()LoadsaUIdescriptionasanextensiontotheeditor.

stringaATMoveItem(sessionIndex:Int32,moveThisIDdestinationSequenceID:string,destinationIndex:Int32Movesthespecifiedinthesequencer.Parameter Type Description

sessionIndex Int32 Theindexinthesessionofthetop-mostsequencefortheitemtomove.

moveThisID string TheUIDoftheitemtoreplace.

newSessionIndex Int32 Theindexinthesessionofthedestinationtop-mostsequence.

destinationSequenceID string TheUIDfortheowningsequence.

destinationIndex Int32 Theindexwheretoinsert.

stringaATRemoveItem(sessionIndex:Int32,item:stringRemovesthespecifieditemfromthesequencer.Parameter Type Description



stringaATReplaceItem(sessionIndex:Int32,replaceThisIDReplacesthespecifiedtothesequencer.



replaceThisID Int32 TheUIDoftheitemtoreplace.

srcItemIDData string TheitemIDoftheitemtoconstruct.

type string Thesourceoftheitemtoconstruct.

stringaATSaveAsSession()Savestheactivesessioninthesequencertoanewfile.

stringaATSaveSession()Savestheactivesessioninthesequencertoafile.

stringapplyDataToItem(sessionIndex:Int32,item:stringAppliesthedatausedintheitemeditortotheitem.Parameter Type Description

sessionIndex Int32 Theindexinthesessionofthetop-mostsequencefortheitemtoedit.


data string ThedatatoapplyinXMLformat.

boolapplySingleDataPointToItem(sessionIndex:Int32Appliesdatatothespecifieditemfromthesequencerintheitemeditor.Parameter Type Description



dataID string ThedatatoapplyinXMLformat.

data string ThedatatoapplyinXMLformat.

voidbeep()

MatrixconcatenateMatrix(matrix:Matrix,secondMatrixConcatenatetwotransformationmatrices.Parameter Type Description

matrix Matrix Thematrixthatistobeaddedto.

secondMatrix Matrix Secondtransformationmatrix.

MatrixconcatenateRotationMatrix(matrix:Matrix,Concatenatearotationmatrixtoatransformationmatrix.Parameter Type Description


angle number Angleofrotation(indegrees)

MatrixconcatenateScaleMatrix(matrix:Matrix[,scaleXConcatenateascalematrixtoatransformationmatrix.Parameter Type Description


scaleX number Horizontalscalingfactorexpressedasapercentage(100=100%)(default:(Optional)

scaleY number Verticalscalingfactorexpressedasapercentage(100=100%)(default:(Optional)

MatrixconcatenateTranslationMatrix(matrix:MatrixConcatenateatranslationtoatransformationmatrix.Parameter Type Description


deltaX number Horizontaltransformation.(default:

deltaY number Verticaltransformation.(default:

ArrayofnumberconvertSampleColor(sourceColorSpacenumber,destColorSpace:ImageColorSpace,colorConvertPurposesourceHasAlpha:bool=false][,destHasAlpha:bool=falseConvertsasample-componentcolorfromonecolorspacetoanother.Parameter Type

sourceColorSpace ImageColorSpace:ImageColorSpace.GrayScaleImageColorSpace.RGBImageColorSpace.CMYKImageColorSpace.LAB

ImageColorSpace.SeparationImageColorSpace.DeviceNImageColorSpace.Indexed

sourceColor Arrayofnumber

destColorSpace ImageColorSpace:ImageColorSpace.GrayScaleImageColorSpace.RGBImageColorSpace.CMYKImageColorSpace.LABImageColorSpace.SeparationImageColorSpace.DeviceNImageColorSpace.Indexed

colorConvertPurpose ColorConvertPurpose:ColorConvertPurpose.defaultpurposeColorConvertPurpose.previewpurposeColorConvertPurpose.exportpurposeColorConvertPurpose.dummypurpose

sourceHasAlpha bool

destHasAlpha bool

voidcopy()Copycurrentselectiontotheclipboard.

voidcut()Cutcurrentselectiontotheclipboard.

voiddoScript(action:string,from:string[,dialogs:boolPlayanactionfromtheActionsPalette.Parameter Type Description

action string Thenameoftheactiontoplay(notethatthecaseoflettersintheActionnameisimportantandmustmatchthecaseofthenameintheActionspalette)

from string Thenameoftheactionsetcontainingtheactionbeingplayed(notethatthecaseoflettersintheActionSetnameisimportantandmustmatchthecaseofthenameintheActionspalette)

dialogs bool Aredialogboxesassociatedwiththeactiontobepresented?(default:(Optional)

booldumpPGFFile(file:File[,documentColorSpaceDumpthePGFportionofaifiletotxtfile.Parameter Type

file File

documentColorSpace DocumentColorSpace:DocumentColorSpace.RGBDocumentColorSpace.CMYK

pGFFile File

voidexecuteMenuCommand(menuCommandStringExecutesamenucommandusingthemenushortcutstring.Parameter Type

menuCommandString string

stringgetExecutionOutput()Retrievesastringcontainingtheresultsofthelastscripttoexecute.

MatrixgetIdentityMatrix()Returnsanidentitymatrix.

PPDFileInfogetPPDFileInfo(name:string)GetdetailedinfofromthespecifiedPPDfile.Parameter Type Description

name string ThemodelnameofthePPDfile.

FilegetPresetFileOfType(presetType:DocumentPresetTypeGivenapresettype,returnsthefullpathtotheapplication'sdefaultdocumentprofileforthetype.Parameter Type

presetType DocumentPresetType:

DocumentPresetType.PrintDocumentPresetType.WebDocumentPresetType.MobileDocumentPresetType.VideoDocumentPresetType.BasicCMYKDocumentPresetType.BasicRGB

DocumentPresetgetPresetSettings(preset:string)Givenapresetname,triesandretrievesthesettingsfromthepresettemplate.Parameter Type Description

preset string Thenameofthepreset.

MatrixgetRotationMatrix([angle:number=0.0])Returnsarotationtransformationmatrix.Parameter Type Description

angle number Angleofrotation(indegrees)(default:

MatrixgetScaleMatrix([scaleX:number=100.0][,scaleYReturnsascaletransformationmatrix.Parameter Type Description

scaleX number Horizontalscalingfactorexpressedasapercentage(100=100%)(default:(Optional)

scaleY number Verticalscalingfactorexpressedasapercentage(100=100%)(default:(Optional)

anygetScriptableHelpGroup()Getthescriptablehelpgroupobjectthatrepresentsthesearchwidgetintheappbar.

MatrixgetTranslationMatrix([deltaX:number=0.0][,Returnsatranslationmatrix.Parameter Type Description



stringgetVersionString()RetrievesastringrepresentingtheAATversion.

MatrixinvertMatrix(matrix:Matrix)Invertamatrix.Parameter Type Description

matrix Matrix Thematrixtoinvert.

boolisEqualMatrix(matrix:Matrix,secondMatrix:MatrixComparestwomatricesforequality.Parameter Type Description

matrix Matrix Firsttransformationmatrixtocompare.

secondMatrix Matrix Secondtransformationmatrix.

boolisSingularMatrix(matrix:Matrix)Testsifamatrixissingular(cannotbeinverted)Parameter Type Description

matrix Matrix Thematrixtocheck.

voidloadAction(actionFilePath:File)Loadanactionintoactionpalette.Parameter Type Description

actionFilePath File Thepathonthesystemoftheactionfiletobeloaded.

voidloadColorSettings(fileSpec:File)Loadthecolorsettingsfromthefile.Ifthefileisanemptyfilespec,thecolormanagementwillbeturnedoff.Parameter Type Description

fileSpec File Filespecforthecolorsettings.

Documentopen(file:File[,documentColorSpace:DocumentColorSpaceOpenthespecifieddocumentfile.Parameter Type

file File


options any

voidpaste()Pasteclipboardintothecurrentdocument.

voidquit()Quittheapplication.

voidredo()Redothelasttransaction.

voidredraw()ForceIllustratortoredrawitswindow(s)

voidreflectCSAW(outputFolder:File)GenerateCreativeSuiteActionScriptWrappersinspecifieddirectory.Parameter Type Description

outputFolder File Locationfortheoutputfiles.

voidrunAPITest(testName:string)RunsAPITestsfromtheTestAPIPlug-in.Parameter Type Description

testName string ArgumentsforRunningTests-eg.NameofTest/Suite.

stringsendScriptMessage(pluginName:string,messageSelectorSendsthescriptmessagetotherequiredplugin.Parameter Type Description

pluginName string Plugintowhichmessageneedstobesent.

messageSelector string Functionalitythatistobeexecuted.

inputString string Passanydataencodedinastring.

ArrayofstringshowPresets(fileSpec:File)Getpresetsfromthefile.Parameter Type Description

fileSpec File Filespectoimportfrom.

stringtranslatePlaceholderText(text:string)Translatetheplaceholdertexttoregulartext.Amethodtoenterunicodepointsinhexvalues.Parameter Type Description

text string Theplaceholdertexttobetranslated.

stringtranslateString(key:string,source:string)Returnsastringtranslatedfromthekeyandsourcedatapassedin.Parameter Type Description

key string Thestringtotranslate.

source string Thepluginnamefromthesourceofthekey.

voidundo()Undothelasttransaction.

voidunloadAction(setName:string,actionName:stringUnloadsanactionintoactionpalette.Parameter Type Description

setName string Nameofthesettobeunloaded.

actionName string Nameoftheactiontobeunloaded.


Contents::Index

Class

Document Adocument.

QuickLinks activate,close,convertCoordinate,exportFile,exportPDFPresetexportVariables,fitArtboardToSelectedArt,getPerspectiveActivePlaneimportCharacterStyles,importPDFPreset,importParagraphStylesimportPrintPreset,importVariables,print,rasterize,rearrangeArtboardsselectObjectsOnActiveArtboard,selectPerspectivePreset,windowCapture

Hierarchy Object

Document


XMPString string

activeDataSet DataSet

activeLayer Layer

activeView View

artboards Artboards Artboard

brushes Brushes

characterStyles CharacterStyles CharacterStyle

compoundPathItems CompoundPathItemsCompoundPathItem

cropBox Rectangle

cropStyle CropOptions:CropOptions.StandardCropOptions.Japanese

dataSets DataSets DataSet

defaultFillColor Color

defaultFillOverprint bool

defaultFilled bool

defaultStrokeCap StrokeCap:StrokeCap.BUTTENDCAPStrokeCap.ROUNDENDCAPStrokeCap.PROJECTINGENDCAP

defaultStrokeColor Color

defaultStrokeDashOffset number

defaultStrokeDashes Arrayofnumber

defaultStrokeJoin StrokeJoin:StrokeJoin.MITERENDJOINStrokeJoin.ROUNDENDJOINStrokeJoin.BEVELENDJOIN

defaultStrokeMiterLimit number

defaultStrokeOverprint bool

defaultStrokeWidth number

defaultStroked bool


fullName File

geometricBounds Rectangle

gradients Gradients Gradient

graphItems GraphItems GraphItem

graphicStyles ArtStyles ArtStyle

groupItems GroupItems GroupItem

height number

inkList ArrayofInk

kinsokuSet Arrayofstring

layers Layers Layer

legacyTextItems LegacyTextItems LegacyTextItem

meshItems MeshItemsMeshItem

mojikumiSet Arrayofstring

name string

nonNativeItems NonNativeItems NonNativeItem

outputResolution number

pageItems PageItems PageItem

pageOrigin Point

paragraphStyles ParagraphStyles ParagraphStyle

parent Object

path File

pathItems PathItems PathItem

patterns Patterns Pattern

placedItems PlacedItems PlacedItem

pluginItems PluginItems PluginItem

printTiles bool

rasterEffectSettings RasterEffectOptions

rasterItems RasterItems RasterItem

rulerOrigin Point

rulerUnits RulerUnits:RulerUnits.UnknownRulerUnits.InchesRulerUnits.CentimetersRulerUnits.PointsRulerUnits.PicasRulerUnits.MillimetersRulerUnits.QsRulerUnits.Pixels

saved bool

selection any

showPlacedImages bool

splitLongPaths bool

spots Spots Spot

stationery bool

stories Stories Story

swatchGroups SwatchGroups SwatchGroup

swatches Swatches

symbolItems SymbolItems SymbolItem

symbols Symbols Symbol

tags Tags Tag

textFrames TextFrameItems TextFrameItem

tileFullPages bool

typename string

useDefaultScreen bool

variables Variables Variable

variablesLocked bool

views Views View

visibleBounds Rectangle

width number

Methods Instancesvoidactivate()Activatethefirstwindowassociatedwiththedocument.

voidclose([saving:SaveOptions])Closethespecifieddocument(s)Parameter Type

saving SaveOptions:SaveOptions.SAVECHANGESSaveOptions.DONOTSAVECHANGESSaveOptions.PROMPTTOSAVECHANGES

PointconvertCoordinate(coordinate:Point,source:CoordinateSystemConvertsthecoordinatesystemofasinglepointfromonecoordinatesystemtoanother.Parameter Type

coordinate Point

source CoordinateSystem:CoordinateSystem.DOCUMENTCOORDINATESYSTEMCoordinateSystem.ARTBOARDCOORDINATESYSTEM

destination CoordinateSystem:CoordinateSystem.DOCUMENTCOORDINATESYSTEMCoordinateSystem.ARTBOARDCOORDINATESYSTEM

voidexportFile(exportFile:File,exportFormat:ExportTypeExportthespecifieddocument(s)Parameter Type Description

exportFile File Thefiletoexportthedocumentto.

exportFormat ExportType:ExportType.JPEGExportType.PHOTOSHOPExportType.SVGExportType.PNG8ExportType.PNG24ExportType.GIFExportType.FLASHExportType.AUTOCADExportType.TIFF

Thefiletypetoexportthedocumentas.

options any Optionsforthefiletypespecified.(Optional)

voidexportPDFPreset(file:File)SaveallPDFpresetstoafile.Parameter Type

file File

voidexportPerspectiveGridPreset(file:File)Savesallperspectivegridpresetstoafile.

Parameter Type

file File

voidexportPrintPreset(file:File)Exportthecurrentprintsettingtothepresetfile.Parameter Type

file File

voidexportVariables(file:File)SavedatasetsintoanXMLlibrary.Thedatasetscontainvariablesandtheirassociateddynamicdata.Parameter Type Description

file File Filespectoexportto.

boolfitArtboardToSelectedArt([index:Int32])Changetheartboardtoselectedartbounds.Parameter Type Description

index Int32 Theindexoftheartboardtoupdate.(Optional)

PerspectiveGridPlaneTypegetPerspectiveActivePlane()Getstheactiveplaneoftheactiveperspectivegridofthedocument.

boolhidePerspectiveGrid()Hidesthecurrentactiveperspectivegridforthedocument,ifthereisvisibleperspectivegrid.

voidimageCapture(imageFile:File[,clipBounds:RectangleCapturetheartworkcontentinsidetheclipboundasrasterimage,andwriteoutthecapturedimagedataintothetargetimagefile.Parameter Type Description

imageFile File Thefiletowhichthecapturedimageshouldbewritten.

clipBounds Rectangle Therectangularregionoftheartworkforimagecapture.Iftheparameterisomitted,theentireartworkboundiscaptured.(Optional)

options ImageCaptureOptions Describestheimagecaptureoptions.(Optional)

voidimportCharacterStyles(fileSpec:File)LoadthecharacterstylesfromtheIllustratorfile.Parameter Type Description


voidimportPDFPreset(fileSpec:File[,replacingPreset:LoadallPDFpresetsfromafile.Parameter Type Description

fileSpec File Filetoimportfrom.

replacingPreset bool Shouldexistingeditablepresetsbereplaced?(default:

voidimportParagraphStyles(fileSpec:File)LoadtheparagraphstylesfromtheIllustratorfile.Parameter Type Description


voidimportPerspectiveGridPreset(fileSpec:File[,perspectivePresetLoadsmentionedperspectivegridpreset,ifpresetnameisspecified,elseloadsall(ifnopresetnameisspecified)presets,fromthespecifiedfile.Parameter Type Description


perspectivePreset string Nameofperspectivegridpreset.(Optional)

voidimportPrintPreset(printPreset:string,fileSpec:FileApplythenamedprintpresetfromthefiletothecurrentprintsetting.Parameter Type Description

printPreset string Thenameofaprintpresettoimport.


voidimportVariables(fileSpec:File)Importalibrarycontainingdatasets,variablesandtheirassociateddynamicdata.Importingvariableswilloverwriteexistingvariablesanddatasets.Parameter Type Description


voidprint([options:PrintOptions])Printthedocument.

Parameter Type

options PrintOptions

PageItemrasterize(sourceArt:any[,clipBounds:RectangleRasterizethesourceart(s)withinthespecifiedclipbounds.Thesourceart(s)aredisposedasaresultoftherasterization.Parameter Type Description

sourceArt any Thepageitem(s)toberasterized.

clipBounds Rectangle Therectangularregionoftheartworkfortherasterization.Iftheparameterisomitted,theboundsofthesourceart(s)isusedinstead.(Optional)

options RasterizeOptions Describestherasterizationoptions.(Optional)

boolrearrangeArtboards([artboardLayout:DocumentArtboardLayout=DocumentArtboardLayout.GridByRowartboardSpacing:number=20.0][,artboardMoveArtwork:RearrangeArtboardsinthedocument.Parameter Type

artboardLayout DocumentArtboardLayout:DocumentArtboardLayout.GridByRowDocumentArtboardLayout.GridByColDocumentArtboardLayout.RowDocumentArtboardLayout.ColumnDocumentArtboardLayout.RLGridByRowDocumentArtboardLayout.RLGridByColDocumentArtboardLayout.RLRow

artboardRowsOrCols Int32

artboardSpacing number

artboardMoveArtwork bool

voidsave()Savethedocument.

voidsaveAs(saveIn:File[,options:any])Savethedocumentwithspecificsaveoptions.Parameter Type Description

saveIn File Thefiletosavethedocumentin.

options any Optionsforthefiletypespecified.(Optional)

boolselectObjectsOnActiveArtboard()Selectartobjectsinactiveartboard.

boolselectPerspectivePreset(perspectivePreset:string)Selectsapredefinedpresettodefinegridforthecurrentdocument.Parameter Type Description

perspectivePreset string Nameofperspectivegridpreset.

boolsetPerspectiveActivePlane(perspectiveGridPlane:Setstheactiveperspectiveplanefortheactivegridofthedocument.Parameter Type

perspectiveGridPlane PerspectiveGridPlaneType:PerspectiveGridPlaneType.NOPLANEPerspectiveGridPlaneType.LEFTPLANEPerspectiveGridPlaneType.RIGHTPLANEPerspectiveGridPlaneType.FLOORPLANE

boolshowPerspectiveGrid()Showsthecurrentactiveperspectivegridforthedocument,ifnoactiveperspectivegridthenshowsthedefaultperspectivegridforthedocument.

voidwindowCapture(imageFile:File,windowSize:PointCapturethecurrentdocumentwindowtothetargetTIFFimagefile.Parameter Type Description

imageFile File TheTIFFfiletowhichthecapturedimageshouldbewritten.

windowSize Point Thesizetomakethewindowbeforecapture.

Elementof Application.activeDocument

Return DocumentApplication.open(file:File[,documentColorSpaceDocumentDocuments.add([documentColorSpace:DocumentColorSpace

width:number=612.0][,height:number=792.0][,numArtboardsDocumentArtboardLayout=DocumentArtboardLayout.GridByRowartboardRowsOrCols:Int32=1])

DocumentDocuments.addDocument(startupPreset:stringDocumentDocuments.getByName(name:string)


Contents::Index

Enumeration

AntiAliasingMethod Controlsthetypeofantialiasingmethodusedinthe

rasterization.

Value Name

AntiAliasingMethod.ARTOPTIMIZED

AntiAliasingMethod.None

AntiAliasingMethod.TYPEOPTIMIZED

Usage AspropertyExportOptionsTIFF.antiAliasingRasterizeOptions.antiAliasingMethod


Contents::Index

Enumeration

ArtClippingOption Howtheartsshouldbeclipped.

Value Name

ArtClippingOption.OUTPUTARTBOARDBOUNDS

ArtClippingOption.OUTPUTARTBOUNDS

ArtClippingOption.OUTPUTCROPRECTBOUNDS

Usage AspropertyExportOptionsFlash.artClipping


Contents::Index

Class

ArtStyle Anartstyle.

QuickLinks applyTo,mergeTo,remove,removeAll

Hierarchy Object

ArtStyle


name string r/w Theartstyle'sname.

parent Object readonly Theobject'scontainer.

typename string readonly Theclassnameoftheobject.

Methods InstancesvoidapplyTo(artItem:any)Applyabrushorartstyletoobject(s)Parameter Type Description

artItem any Thepageitem(s)toapplyto.

voidmergeTo(artItem:any)Mergeanartstyletoobject(s)currentstyle(s)Parameter Type Description

artItem any Thepageitem(s)tomergeto.

voidremove()Deletesthisobject.

voidremoveAll()Deletesallelements.

Return ArtStyleArtStyles.getByName(name:string)


Contents::Index

Class

Artboard Anartboardobject.

QuickLinks remove,removeAll

Hierarchy Object

Artboard


artboardRect Rectangle r/w Sizeandpositionofartboard.

name string r/w Thenameoftheartboard.


rulerOrigin Point r/w Ruleroriginofartboard.Itisrelativetoleft-bottomcorneroftheArtboard.

rulerPAR number(range:0.1-10.0)

r/w Pixelaspectratio,usedinrulervisualizationiftheunitsarepixels.

showCenter bool r/w Showcentermark.

showCrossHairs bool r/w Showcrosshairs.

showSafeAreas bool r/w Showtitleandactionsafeareas(forvideo)


Methods Instancesvoidremove()Deletesthisobject.


Return ArtboardArtboards.add(artboardRect:Rectangle)ArtboardArtboards.getByName(name:string)ArtboardArtboards.getByName(artboardName:string)


Contents::Index

Enumeration

AutoCADColors

Value Name Description

AutoCADColors.Max16Colors



AutoCADColors.TrueColors

Usage AspropertyExportOptionsAutoCAD.colors


Contents::Index

Enumeration

AutoCADCompatibility

Value Name

AutoCADCompatibility.AutoCADRelease13




Usage AspropertyExportOptionsAutoCAD.version


Contents::Index

Enumeration

AutoCADExportFileFormat

Value Name

AutoCADExportFileFormat.DWG

AutoCADExportFileFormat.DXF

Usage AspropertyExportOptionsAutoCAD


Contents::Index

Enumeration

AutoCADExportOption

Value Name

AutoCADExportOption.MaximumEditability

AutoCADExportOption.PreserveAppearance

Usage AspropertyExportOptionsAutoCAD.exportOption


Contents::Index

Enumeration

AutoCADGlobalScaleOption

Value Name

AutoCADGlobalScaleOption.FitArtboard

AutoCADGlobalScaleOption.OriginalSize

AutoCADGlobalScaleOption.ScaleByValue

Usage AspropertyOpenOptionsAutoCAD


Contents::Index

Enumeration

AutoCADRasterFormat

Value Name

AutoCADRasterFormat.JPEG

AutoCADRasterFormat.PNG

Usage AspropertyExportOptionsAutoCAD.rasterFormat


Contents::Index

Enumeration

AutoCADUnit

Value Name Description Value

AutoCADUnit.Centimeters int4

AutoCADUnit.Inches int2

AutoCADUnit.Millimeters int3

AutoCADUnit.Picas int1

AutoCADUnit.Pixels int5

AutoCADUnit.Points int0

Usage AspropertyExportOptionsAutoCAD.unitOpenOptionsAutoCAD.unit


Contents::Index

Enumeration

BlendAnimationType

Value Name

BlendAnimationType.INBUILD

BlendAnimationType.INSEQUENCE

BlendAnimationType.NOBLENDANIMATION

Usage AspropertyExportOptionsFlash.blendAnimation


Contents::Index

Enumeration

BlendModes Blendmodesusedwhencompositinganobject.


BlendModes.COLORBLEND

BlendModes.COLORBURN

BlendModes.COLORDODGE

BlendModes.DARKEN

BlendModes.DIFFERENCE

BlendModes.EXCLUSION

BlendModes.HARDLIGHT

BlendModes.HUE

BlendModes.LIGHTEN

BlendModes.LUMINOSITY

BlendModes.MULTIPLY

BlendModes.NORMAL

BlendModes.OVERLAY

BlendModes.SATURATIONBLEND

BlendModes.SCREEN

BlendModes.SOFTLIGHT

Usage AspropertyLayer.blendingModePageItem.blendingModeTextPath.blendingMode

Jongware,25-Nov-2012 Contents::Index

v3.0.3i

Enumeration

BlendsExpandPolicy BlendsExpandpolicyusedbyFXGfileformat.

Value Name

BlendsExpandPolicy.AUTOMATICALLYCONVERTBLENDS

BlendsExpandPolicy.RASTERIZEBLENDS

Usage AspropertyFXGSaveOptions.blendsPolicy


Contents::Index

Class

Brush Abrush.

QuickLinks applyTo

Hierarchy Object

Brush


name string r/w Thebrush'sname.



Methods InstancesvoidapplyTo(artItem:any)Applyabrushorartstyletoobject(s)Parameter Type Description

artItem any Thepageitem(s)toapplyto.

Return BrushBrushes.getByName(name:string)


Contents::Index

Enumeration

ColorConversion PDFcolorconversionpolicy.

Value Name

ColorConversion.COLORCONVERSIONREPURPOSE

ColorConversion.COLORCONVERSIONTODEST

ColorConversion.None

Usage AspropertyPDFSaveOptions.colorConversionID


Contents::Index

Enumeration

ColorDestination PDFdestinationprofile.

Value Name

ColorDestination.COLORDESTINATIONDOCCMYK

ColorDestination.COLORDESTINATIONDOCRGB

ColorDestination.COLORDESTINATIONPROFILE

ColorDestination.COLORDESTINATIONWORKINGCMYK

ColorDestination.COLORDESTINATIONWORKINGRGB

ColorDestination.None

Usage AspropertyPDFSaveOptions.colorDestinationID


Contents::Index

Enumeration

ColorModel Colormodelofthecustomcolor.


ColorModel.PROCESS Processcolor(mixedink)

int1

ColorModel.REGISTRATION Registrationcolor(printsoninallseparations)

int0

ColorModel.SPOT Spotcolor(separateink)

int2

Usage AspropertySpot.colorType


Contents::Index

Enumeration

ColorProfile PDFICCprofileinclusion.


ColorProfile.INCLUDEALLPROFILE Everythinggetstagged(embedProfile==true)

ColorProfile.INCLUDEDESTPROFILE Everythingendsuptaggedwiththedestinationprofile.

ColorProfile.INCLUDERGBPROFILE TagallRGB,leaveCMYKunchanged.

ColorProfile.LEAVEPROFILEUNCHANGED Leavetaggeditemstagged,untaggeditemsuntagged.

ColorProfile.None Allprofilesremoved(embedProfile==false)

Usage AspropertyPDFSaveOptions.colorProfileID


Contents::Index

Enumeration

Compatibility Thecompatibilitytype.


Compatibility.ILLUSTRATOR10










Compatibility.JAPANESEVERSION3

Usage AspropertyEPSSaveOptions.compatibilityIllustratorSaveOptions.compatibility


Contents::Index

Class

CompoundPathItem Compoundpathartworkitem.BaseClass:

QuickLinks duplicate,move,remove,removeAll

Hierarchy Object

PageItem

CompoundPathItem



pathItems PathItemsPathItem

readonly Thepathartworkinthiscompoundpath.


Methods InstancesCompoundPathItemduplicate(relativeObjectObject,insertionLocation:ElementPlacementDuplicatethisobject.Parameter Type

relativeObject Object

insertionLocation ElementPlacement

CompoundPathItemmove(relativeObjectinsertionLocation:ElementPlacementMovetheobject.Parameter Type





Return CompoundPathItemCompoundPathItem.duplicateObject,insertionLocation:ElementPlacement

CompoundPathItemCompoundPathItem(relativeObject:Object,insertionLocationElementPlacement)

CompoundPathItemCompoundPathItems.addCompoundPathItem

CompoundPathItems.getByName


Contents::Index

Enumeration

CompressionQuality Thecompressiontype.

Value Name

CompressionQuality.AUTOMATICJPEG2000HIGH

CompressionQuality.AUTOMATICJPEG2000LOSSLESS

CompressionQuality.AUTOMATICJPEG2000LOW

CompressionQuality.AUTOMATICJPEG2000MAXIMUM

CompressionQuality.AUTOMATICJPEG2000MEDIUM

CompressionQuality.AUTOMATICJPEG2000MINIMUM

CompressionQuality.AUTOMATICJPEGHIGH

CompressionQuality.AUTOMATICJPEGLOW

CompressionQuality.AUTOMATICJPEGMAXIMUM

CompressionQuality.AUTOMATICJPEGMEDIUM

CompressionQuality.AUTOMATICJPEGMINIMUM

CompressionQuality.JPEG2000HIGH

CompressionQuality.JPEG2000LOSSLESS

CompressionQuality.JPEG2000LOW

CompressionQuality.JPEG2000MAXIMUM

CompressionQuality.JPEG2000MEDIUM

CompressionQuality.JPEG2000MINIMUM

CompressionQuality.JPEGHIGH

CompressionQuality.JPEGLOW

CompressionQuality.JPEGMAXIMUM

CompressionQuality.JPEGMEDIUM

CompressionQuality.JPEGMINIMUM

CompressionQuality.None

CompressionQuality.ZIP4BIT

CompressionQuality.ZIP8BIT

Usage AspropertyPDFSaveOptions.colorCompressionPDFSaveOptions.grayscaleCompression


Contents::Index

Enumeration

CoordinateSystem CoordinatesystemusedbyIllustrator.

Value Name

CoordinateSystem.ARTBOARDCOORDINATESYSTEM

CoordinateSystem.DOCUMENTCOORDINATESYSTEM

Usage InfunctionPointDocument.convertCoordinate(coordinate

CoordinateSystem,destination:CoordinateSystemAspropertyApplication.coordinateSystem


Contents::Index

Enumeration

CropOptions Thecropstyle.


CropOptions.Japanese Japanesecropstyle.

int2

CropOptions.Standard Standardcropstyle.

int1

Usage AspropertyDocument.cropStyle


Contents::Index

Enumeration

DocumentArtboardLayout Thelayoutofartboardsindocument.

Value Name

DocumentArtboardLayout.Column

DocumentArtboardLayout.GridByCol

DocumentArtboardLayout.GridByRow

DocumentArtboardLayout.RLGridByCol

DocumentArtboardLayout.RLGridByRow

DocumentArtboardLayout.RLRow

DocumentArtboardLayout.Row

Usage InfunctionboolDocument.rearrangeArtboards

DocumentArtboardLayout[,artboardRowsOrColsartboardMoveArtwork

DocumentDocuments.add

DocumentColorSpacenumber=612.0][,artboardLayout:DocumentArtboardLayout[,artboardSpacing

AspropertyDocumentPreset.artboardLayout


Contents::Index

Enumeration

DocumentColorSpace Thecolorspacesavailablefordocuments.

Value Name

DocumentColorSpace.CMYK

DocumentColorSpace.RGB

Usage InfunctionboolApplication.dumpPGFFile(

DocumentColorSpace],pGFFileDocumentApplication.open(file

DocumentColorSpace][,optionsDocumentDocuments.add([documentColorSpace

DocumentColorSpace=DocumentColorSpace.CMYKnumber=612.0][,height:numberartboardLayout:DocumentArtboardLayout=[,artboardSpacing:number

AspropertyDocument.documentColorSpaceDocumentPreset.colorMode


Contents::Index

Class

DocumentPreset Thenewdocumentpresettouseforcreatinganewdocument.

Class Property Type

artboardLayout DocumentArtboardLayoutDocumentArtboardLayout.GridByRowDocumentArtboardLayout.GridByColDocumentArtboardLayout.RowDocumentArtboardLayout.ColumnDocumentArtboardLayout.RLGridByRowDocumentArtboardLayout.RLGridByColDocumentArtboardLayout.RLRow



colorMode DocumentColorSpaceDocumentColorSpace.RGBDocumentColorSpace.CMYK

height number

numArtboards Int32

previewMode DocumentPreviewModeDocumentPreviewMode.DefaultPreviewDocumentPreviewMode.PixelPreviewDocumentPreviewMode.OverprintPreview

rasterResolution DocumentRasterResolutionDocumentRasterResolution.ScreenResolutionDocumentRasterResolution.MediumResolutionDocumentRasterResolution.HighResolution

title string

transparencyGrid DocumentTransparencyGridDocumentTransparencyGrid.TransparencyGridNoneDocumentTransparencyGrid.TransparencyGridLightDocumentTransparencyGrid.TransparencyGridMediumDocumentTransparencyGrid.TransparencyGridDarkDocumentTransparencyGrid.TransparencyGridRedDocumentTransparencyGrid.TransparencyGridOrangeDocumentTransparencyGrid.TransparencyGridGreenDocumentTransparencyGrid.TransparencyGridBlueDocumentTransparencyGrid.TransparencyGridPurple

units RulerUnits:RulerUnits.UnknownRulerUnits.InchesRulerUnits.CentimetersRulerUnits.PointsRulerUnits.PicasRulerUnits.MillimetersRulerUnits.QsRulerUnits.Pixels

width number

Usedin: DocumentDocuments.addDocument(startupPreset

Return DocumentPresetApplication.getPresetSettings


Contents::Index

Enumeration

DocumentPresetType Thepresettypesavailablefornewdocuments.

Value Name

DocumentPresetType.BasicCMYK

DocumentPresetType.BasicRGB

DocumentPresetType.Mobile

DocumentPresetType.Print

DocumentPresetType.Video

DocumentPresetType.Web

Usage InfunctionFileApplication.getPresetFileOfType

DocumentPresetType)


Contents::Index

Enumeration

DocumentPreviewMode Thepreviewmodesavailablewhencreatinganewdocument.

Value Name

DocumentPreviewMode.DefaultPreview

DocumentPreviewMode.OverprintPreview

DocumentPreviewMode.PixelPreview

Usage AspropertyDocumentPreset.previewMode


Contents::Index

Enumeration

DocumentRasterResolution Therasterresolutionsavailablewhencreatinganewdocument.

Value Name

DocumentRasterResolution.HighResolution

DocumentRasterResolution.MediumResolution

DocumentRasterResolution.ScreenResolution

Usage AspropertyDocumentPreset.rasterResolution


Contents::Index

Enumeration

DocumentTransparencyGrid Thetransparencygridforthenewdocument,invideopresets.

Value Name

DocumentTransparencyGrid.TransparencyGridBlue

DocumentTransparencyGrid.TransparencyGridDark

DocumentTransparencyGrid.TransparencyGridGreen

DocumentTransparencyGrid.TransparencyGridLight

DocumentTransparencyGrid.TransparencyGridMedium

DocumentTransparencyGrid.TransparencyGridNone

DocumentTransparencyGrid.TransparencyGridOrange

DocumentTransparencyGrid.TransparencyGridPurple

DocumentTransparencyGrid.TransparencyGridRed

Usage AspropertyDocumentPreset.transparencyGrid


Contents::Index

Enumeration

DownsampleMethod Theresampletype.

Value Name

DownsampleMethod.AVERAGEDOWNSAMPLE

DownsampleMethod.BICUBICDOWNSAMPLE

DownsampleMethod.NODOWNSAMPLE

DownsampleMethod.SUBSAMPLE

Usage AspropertyPDFSaveOptions.colorDownsamplingMethodPDFSaveOptions.grayscaleDownsamplingMethodPDFSaveOptions.monochromeDownsamplingMethod


Contents::Index

Enumeration

EPSPostScriptLevelEnum ThePostScriptlevelsavailablewhensavingEPSfiles.

Value Name

EPSPostScriptLevelEnum.LEVEL2

EPSPostScriptLevelEnum.LEVEL3

Usage AspropertyEPSSaveOptions.postScript


Contents::Index

Enumeration

EPSPreview Thepreviewtype.


EPSPreview.BWMACINTOSH BlackandwhiteMacintoshpreview.

EPSPreview.BWTIFF BlackandwhitePCpreview.

EPSPreview.COLORMACINTOSH ColorMacintoshpreview.

EPSPreview.COLORTIFF ColorPCpreview.

EPSPreview.None Nopreview.

EPSPreview.TRANSPARENTCOLORTIFF TransparentcolorPCpreview(8orlater)

Usage AspropertyEPSSaveOptions.preview


Contents::Index

Enumeration

FXGVersion TheFXGfileformatversion.


FXGVersion.VERSION1PT0 FXGversion1.0.

int1

FXGVersion.VERSION2PT0 FXGversion2.0.

int2

Usage AspropertyFXGSaveOptions.version


Contents::Index

Enumeration

FiltersPreservePolicy FilterspreservepolicyusedbyFXGfileformat.

Value Name

FiltersPreservePolicy.EXPANDFILTERS

FiltersPreservePolicy.KEEPFILTERSEDITABLE

FiltersPreservePolicy.RASTERIZEFILTERS

Usage AspropertyFXGSaveOptions.filtersPolicy


Contents::Index

Enumeration

FlashExportStyle

Value Name

FlashExportStyle.ARTBOARDSTOFILES

FlashExportStyle.ASFLASHFILE

FlashExportStyle.LAYERSASFILES

FlashExportStyle.LAYERSASFRAMES

FlashExportStyle.LAYERSASSYMBOLS

Usage AspropertyExportOptionsFlash.exportStyle


Contents::Index

Enumeration

FlashExportVersion VersionoftheSWFFiletobeexported.

Value Name

FlashExportVersion.FLASHVERSION1









Usage AspropertyExportOptionsFlash.exportVersion


Contents::Index

Enumeration

FlashImageFormat


FlashImageFormat.LOSSLESS

FlashImageFormat.LOSSY

Usage AspropertyExportOptionsFlash.imageFormat


Contents::Index

Enumeration

FlashJPEGMethod


FlashJPEGMethod.Optimized

FlashJPEGMethod.Standard

Usage AspropertyExportOptionsFlash.jpegMethod


Contents::Index

Enumeration

FlashPlaybackSecurity

Value Name

FlashPlaybackSecurity.PlaybackLocal

FlashPlaybackSecurity.PlaybackNetwork

Usage AspropertyExportOptionsFlash.playbackAccess


Contents::Index

Class

Gradient Agradient.


Hierarchy Object

Gradient


gradientStops GradientStopsGradientStop

readonly Thestopsinthisgradient.

name string r/w Thegradient'sname.


type GradientType:GradientType.LINEARGradientType.RADIAL

r/w Thegradienttype.




Elementof GradientColor.gradient

Return GradientGradients.add()GradientGradients.getByName(name:string)


Contents::Index

Class

GradientStop Agradientstop.


Hierarchy Object

GradientStop


color Color r/w Thecolorlinkedtothisgradientstop.

midPoint number(range:13-87)

r/w Midpointkeyvalueinpercent.

opacity number(range:0-100)

r/w Theopacity(between0.0and100.0)valueforthegradientstop.


rampPoint number(range:0-100)

r/w Locationofcolorintheblend(inpercent)


Methods Instances



Return GradientStopGradientStops.add()GradientStopGradientStops.getByName

(name:string)


Contents::Index

Enumeration

GradientType Thegradienttype.


GradientType.LINEAR Lineargradient.

int1

GradientType.RADIAL int2

Usage AspropertyGradient.type


Contents::Index

Enumeration

GradientsPreservePolicy GradientspreservepolicyusedbyFXGfileformat.

Value Name

GradientsPreservePolicy.AUTOMATICALLYCONVERTGRADIENTS

GradientsPreservePolicy.KEEPGRADIENTSEDITABLE

Usage AspropertyFXGSaveOptions.gradientsPolicy


Contents::Index

Class

GraphItem Graphartworkitem.BaseClass:PageItem


Hierarchy Object

PageItem

GraphItem


contentVariable any r/w Thecontentvariableboundtothisgraph.



Methods InstancesGraphItemduplicate(relativeObject:Object,insertionLocation:ElementPlacement)Duplicatethisobject.Parameter Type Description



GraphItemmove(relativeObject:Object,insertionLocation:ElementPlacement)Movetheobject.Parameter Type Description





Return GraphItemGraphItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

GraphItemGraphItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

GraphItemGraphItems.getByName(name:string)


Contents::Index

Class

GroupItem Anartworkgroupitem.BaseClass:PageItem


Hierarchy Object

PageItem

GroupItem

Properties Property Type Access

clipped bool r/w


readonly

graphItems GraphItems GraphItem readonly

groupItems GroupItemsGroupItem

readonly

legacyTextItems LegacyTextItemsLegacyTextItem

readonly

meshItems MeshItemsMeshItem readonly

nonNativeItems NonNativeItemsNonNativeItem

readonly

pageItems PageItems PageItem readonly

parent Object readonly

pathItems PathItems PathItem readonly

placedItems PlacedItemsPlacedItem

readonly

pluginItems PluginItemsPluginItem

readonly

rasterItems RasterItemsRasterItem

readonly

symbolItems SymbolItemsSymbolItem

readonly

textFrames TextFrameItemsTextFrameItem

readonly

typename string readonly

Methods InstancesGroupItemduplicate(relativeObject:Object,insertionLocationElementPlacement)Duplicatethisobject.Parameter Type Description



GroupItemmove(relativeObject:Object,insertionLocationElementPlacement)Movetheobject.Parameter Type Description





Return GroupItemGroupItem.duplicate(relativeObject:ObjectinsertionLocation:ElementPlacement)

GroupItemGroupItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

GroupItemGroupItems.add()GroupItemGroupItems.createFromFile(imageFile:FileGroupItemGroupItems.getByName(name:string)GroupItemLegacyTextItem.convertToNative()GroupItemTextFrameItem.createOutline()GroupItemTracingObject.expandTracing([viewed:bool


Contents::Index

Enumeration

ImageColorSpace Thecolorspace.


ImageColorSpace.CMYK CMYKcolorspace.

ImageColorSpace.DeviceN DeviceNcolorspace.

ImageColorSpace.GrayScale Graycolorspace.

ImageColorSpace.Indexed Indexedcolorspace.

ImageColorSpace.LAB LABcolorspace.

ImageColorSpace.RGB RGBcolorspace.

ImageColorSpace.Separation Separationcolorspace.

Usage InfunctionArrayofnumberApplication.convertSampleColor

(sourceColorSpace:ImageColorSpacesourceColor:Arrayofnumber,destColorSpace:ImageColorSpacecolorConvertPurpose:ColorConvertPurposesourceHasAlpha:bool=false][,destHasAlphabool=false])

AspropertyExportOptionsPhotoshop.imageColorSpaceExportOptionsTIFF.imageColorSpaceRasterItem.imageColorSpace


Contents::Index

Enumeration

JavaScriptExecutionMode WhenshouldaJavaScriptdebuggerbeshown.

Value Name

JavaScriptExecutionMode.BeforeRunning

JavaScriptExecutionMode.OnRuntimeError

JavaScriptExecutionMode.never

Usage


Contents::Index

Enumeration

Justification Theparagraphalignment.

Value Name

Justification.CENTER

Justification.FULLJUSTIFY

Justification.FULLJUSTIFYLASTLINECENTER

Justification.FULLJUSTIFYLASTLINELEFT

Justification.FULLJUSTIFYLASTLINERIGHT

Justification.LEFT

Justification.RIGHT

Usage AspropertyParagraphAttributes.justificationParagraphAttributes.singleWordJustification


Contents::Index

Enumeration

KnockoutState Knockoutstateofapageitem.


KnockoutState.DISABLED Knockoutoff.

KnockoutState.ENABLED Knockoutoff.

KnockoutState.INHERITED Knockoutstateinheritedfromgroup?

KnockoutState.Unknown Unknown/uninitializedknockoutstate.

Usage AspropertyLayer.artworkKnockoutPageItem.artworkKnockout


Contents::Index

Class

Layer Alayer.

QuickLinks move,remove,removeAll,zOrder

Hierarchy Object

Layer


artworkKnockout KnockoutState:KnockoutState.UnknownKnockoutState.DISABLEDKnockoutState.ENABLEDKnockoutState.INHERITED

r/w

blendingMode BlendModes:BlendModes.NORMALBlendModes.MULTIPLYBlendModes.SCREENBlendModes.OVERLAYBlendModes.SOFTLIGHTBlendModes.HARDLIGHTBlendModes.COLORDODGEBlendModes.COLORBURNBlendModes.DARKENBlendModes.LIGHTENBlendModes.DIFFERENCEBlendModes.EXCLUSIONBlendModes.HUEBlendModes.SATURATIONBLENDBlendModes.COLORBLENDBlendModes.LUMINOSITY

r/w

color RGBColor r/w


readonly

dimPlacedImages bool r/w

graphItems GraphItems GraphItem readonly

groupItems GroupItems GroupItem readonly

hasSelectedArtwork bool r/w

isIsolated bool r/w

layers Layers Layer readonly

legacyTextItems LegacyTextItems LegacyTextItem readonly

locked bool r/w

meshItems MeshItemsMeshItem readonly

name string r/w

nonNativeItems NonNativeItems NonNativeItem readonly

opacity number r/w

pageItems PageItems PageItem readonly


pathItems PathItems PathItem readonly

placedItems PlacedItems PlacedItem readonly

pluginItems PluginItems PluginItem readonly

preview bool r/w

printable bool r/w

rasterItems RasterItems RasterItem readonly

sliced bool r/w

symbolItems SymbolItems SymbolItem readonly

textFrames TextFrameItems TextFrameItem readonly


visible bool r/w

zOrderPosition Int32 readonly

Methods InstancesLayermove(relativeObject:Object,insertionLocation:ElementPlacementMovetheobject.Parameter Type Description





voidzOrder(zOrderCmd:ZOrderMethod)Arrangesthelayerrelativetootherlayers.Parameter Type Description

zOrderCmd ZOrderMethod:ZOrderMethod.BRINGTOFRONTZOrderMethod.BRINGFORWARDZOrderMethod.SENDBACKWARDZOrderMethod.SENDTOBACK

Howtoarrangethelayer.

Elementof Document.activeLayerExportOptionsFlash.backgroundLayersPageItem.layer

Return LayerLayer.move(relativeObject:Object,insertionLocation:ElementPlacementLayerLayers.add()LayerLayers.getByName(name:string)


Contents::Index

Enumeration

LayerOrderType


LayerOrderType.BOTTOMUP

LayerOrderType.TOPDOWN

Usage AspropertyExportOptionsFlash.layerOrder


Contents::Index

Class

LegacyTextItem Unconvertedlegacytextitemsfromdocumentsin

pre-version11formats.BaseClass:PageItem

QuickLinks convertToNative,move,remove,removeAll

Hierarchy Object

PageItem

LegacyTextItem


converted bool readonly Hasthelegacytextitembeenupdatedtoanativetextframeitem?



Methods InstancesGroupItemconvertToNative()Createanativetextframefromalegacytextitem.Theoriginallegacytextitemisdeleted.

LegacyTextItemmove(relativeObject:ObjectinsertionLocation:ElementPlacement)Movetheobject.Parameter Type Description





Return LegacyTextItemLegacyTextItem.move(relativeObject:Object,insertionLocationElementPlacement)

LegacyTextItemLegacyTextItems.getByName(name:string)


Contents::Index

Class

MeshItem Meshartworkitem.BaseClass:PageItem


Hierarchy Object

PageItem

MeshItem




Methods InstancesMeshItemduplicate(relativeObject:Object,insertionLocation:ElementPlacement)Duplicatethisobject.Parameter Type Description



MeshItemmove(relativeObject:Object,insertionLocation:ElementPlacement)Movetheobject.Parameter Type Description





Return MeshItemMeshItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

MeshItemMeshItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

MeshItemMeshItems.getByName(name:string)


Contents::Index

Enumeration

MonochromeCompression Themonochromecompressiontype.

Value Name

MonochromeCompression.CCIT3

MonochromeCompression.CCIT4

MonochromeCompression.MONOZIP

MonochromeCompression.None

MonochromeCompression.RUNLENGTH

Usage AspropertyPDFSaveOptions.monochromeCompression


Contents::Index

Class

NonNativeItem Non-nativeartworkitem.BaseClass:PageItem


Hierarchy Object

PageItem

NonNativeItem




Methods InstancesNonNativeItemduplicate(relativeObject:ObjectinsertionLocation:ElementPlacement)Duplicatethisobject.Parameter Type Description



NonNativeItemmove(relativeObject:Object,insertionLocation:ElementPlacement)Movetheobject.Parameter Type Description



voidremove()

Deletesthisobject.


Return NonNativeItemNonNativeItem.duplicate(relativeObject:Object,insertionLocationElementPlacement)

NonNativeItemNonNativeItem.move(relativeObject:Object,insertionLocationElementPlacement)

NonNativeItemNonNativeItems.getByName(name:string)


Contents::Index

Enumeration

OutputFlattening Howshouldtransparencybeflattenedforpre-AI9fileformats.

Value Name

OutputFlattening.PRESERVEAPPEARANCE

OutputFlattening.PRESERVEPATHS

Usage AspropertyEPSSaveOptions.flattenOutputIllustratorSaveOptions.flattenOutput


Contents::Index

Enumeration

PDFBoxType Cropbox.


PDFBoxType.PDFARTBOX CroptoArtBox.Theartboxdefinestheextentofthepage'smeaningfulcontent(includingpotentialwhitespace)asintendedbythepage'screator.

PDFBoxType.PDFBLEEDBOX CroptoBleedBox.Thebleedboxdefinestheregiontowhichthecontentsofthepageshouldbeclippedwhenoutputinaproductionenvironment.

PDFBoxType.PDFBOUNDINGBOX CroptoBoundingBox.The

boundingboxistherectanglethatenclosesalltext,graphics,andimagesonthepage.

PDFBoxType.PDFCROPBOX CroptoCropBox.Thecropboxistheregionofthepagetodisplayandtoprint.

PDFBoxType.PDFMEDIABOX CroptoMediaBox.Themediaboxisanaturalsizeofthepage.Forexample,thedimensionsofA4sheetofpaper.

PDFBoxType.PDFTRIMBOX CroptoTrimBox.Thetrimboxspecifiesthepositioningofthepage'scontentwithintheimposition.

Usage AspropertyOpenOptionsPDF.pDFCropToBox


Contents::Index

Enumeration

PDFChangesAllowedEnum Optionsavailableformakingchangestoapdfdocument.

Value Name

PDFChangesAllowedEnum.CHANGE128ANYCHANGES

PDFChangesAllowedEnum.CHANGE128COMMENTING

PDFChangesAllowedEnum.CHANGE128EDITPAGE

PDFChangesAllowedEnum.CHANGE128FILLFORM

PDFChangesAllowedEnum.CHANGE128NONE

PDFChangesAllowedEnum.CHANGE40ANYCHANGES

PDFChangesAllowedEnum.CHANGE40COMMENTING

PDFChangesAllowedEnum.CHANGE40NONE

PDFChangesAllowedEnum.CHANGE40PAGELAYOUT

Usage AspropertyPDFSaveOptions.pDFChangesAllowed


Contents::Index

Enumeration

PDFCompatibility ThePDFcompatibilitytype.


PDFCompatibility.ACROBAT4 Acrobatversion4.





Usage AspropertyPDFSaveOptions.compatibility


Contents::Index

Enumeration

PDFOverprint Pdfoverprintoptions.

Value Name

PDFOverprint.DISCARDPDFOVERPRINT

PDFOverprint.PRESERVEPDFOVERPRINT

Usage AspropertyEPSSaveOptions.overprintPrintFlattenerOptions.overprint


Contents::Index

Enumeration

PDFPrintAllowedEnum Pdfprintpermissions.

Value Name

PDFPrintAllowedEnum.PRINT128HIGHRESOLUTION

PDFPrintAllowedEnum.PRINT128LOWRESOLUTION

PDFPrintAllowedEnum.PRINT128NONE

PDFPrintAllowedEnum.PRINT40HIGHRESOLUTION

PDFPrintAllowedEnum.PRINT40NONE

Usage AspropertyPDFSaveOptions.pDFAllowPrinting


Contents::Index

Enumeration

PDFTrimMarkWeight Pdftrimmarkweightoptions.

Value Name

PDFTrimMarkWeight.TRIMMARKWEIGHT0125



Usage AspropertyPDFSaveOptions.trimMarkWeight


Contents::Index

Enumeration

PDFXStandard Thisprovidesameansformatchingthecolor

characteristicsofaPDFdocument.


PDFXStandard.PDFX1A2001 SupportsonlyaCMYKandspotcolorworkflow,targetedtoaspecificoutputdevice.

PDFXStandard.PDFX1A2003 SupportsonlyaCMYKandspotcolorworkflow,targetedtoaspecificoutputdevice.

PDFXStandard.PDFX32001 Supportsacolor-managedworkflow,allowingtheuseofdevice-independentcolorinadditiontoCMYKandspotcolors.




PDFXStandard.PDFXNONE Theuser

isn'tcomplyingwithanyPDFstandard.

Usage AspropertyPDFSaveOptions.pDFXStandard


Contents::Index

Class

PageItem Apageitemobject.

SuperclassofCompoundPathItem,GraphItem,GroupItem,NonNativeItem,PathItem,PlacedItem,PluginItem,RasterItemTextFrameItem

QuickLinks applyEffect,bringInPerspective,duplicate,move,remove,sendScriptMessage,transform,translate,zOrder

Hierarchy Object

PageItem

CompoundPathItem|GraphItem|GroupItem|LegacyTextItem|PathItem|PlacedItem|PluginItem|RasterItem|SymbolItem


URL string

artworkKnockout KnockoutState:KnockoutState.UnknownKnockoutState.DISABLEDKnockoutState.ENABLEDKnockoutState.INHERITED

blendingMode BlendModes:BlendModes.NORMALBlendModes.MULTIPLYBlendModes.SCREENBlendModes.OVERLAYBlendModes.SOFTLIGHTBlendModes.HARDLIGHTBlendModes.COLORDODGEBlendModes.COLORBURNBlendModes.DARKEN

BlendModes.LIGHTENBlendModes.DIFFERENCEBlendModes.EXCLUSIONBlendModes.HUEBlendModes.SATURATIONBLENDBlendModes.COLORBLENDBlendModes.LUMINOSITY

controlBounds Rectangle

editable bool

geometricBounds Rectangle

height number(range:0.0-16348.0)

hidden bool

isIsolated bool

layer Layer

left number

locked bool

name string

note string

opacity number(range:0.0-100.0)

parent Object

pixelAligned bool

position Point

selected bool

sliced bool

tags Tags Tag

top number

typename string

visibilityVariable any

visibleBounds Rectangle

width number(range:0.0-16348.0)

wrapInside bool

wrapOffset number

wrapped bool

zOrderPosition Int32

Methods InstancesvoidapplyEffect(liveEffectXML:string)ApplyeffecttoselectedartItem.Parameter Type

liveEffectXML string

voidbringInPerspective(positionX:number,positionY:numberPerspectiveGridPlaneType)Placeartobject(s)inperspectivegridatspedifiedperspectiveplaneandcoordinate.Parameter Type

positionX number

positionY number

perspectiveGridPlane PerspectiveGridPlaneType:PerspectiveGridPlaneType.NOPLANEPerspectiveGridPlaneType.LEFTPLANEPerspectiveGridPlaneType.RIGHTPLANEPerspectiveGridPlaneType.FLOORPLANE

PageItemduplicate(relativeObject:Object,insertionLocationDuplicatethisobject.Parameter Type



PageItemmove(relativeObject:Object,insertionLocation:Movetheobject.Parameter Type





voidresize(scaleX:number,scaleY:number[,changePositionschangeFillPatterns:bool=true][,changeFillGradients:boolbool=true][,changeLineWidths:number=100.0][,scaleAboutTransformation=Transformation.CENTER])Scaleartobject(s)Parameter Type

scaleX number

scaleY number

changePositions bool

changeFillPatterns bool

changeFillGradients bool

changeStrokePattern bool

changeLineWidths number

scaleAbout Transformation:Transformation.DOCUMENTORIGINTransformation.TOPLEFTTransformation.LEFTTransformation.BOTTOMLEFTTransformation.TOPTransformation.CENTERTransformation.BOTTOMTransformation.TOPRIGHTTransformation.RIGHTTransformation.BOTTOMRIGHT

voidrotate(angle:number[,changePositions:bool=true][,changeFillGradients:bool=true][,changeStrokePattern:boolTransformation=Transformation.CENTER])Rotateartobject(s)Parameter Type

angle number





rotateAbout Transformation:Transformation.DOCUMENTORIGINTransformation.TOPLEFTTransformation.LEFTTransformation.BOTTOMLEFTTransformation.TOPTransformation.CENTERTransformation.BOTTOMTransformation.TOPRIGHTTransformation.RIGHTTransformation.BOTTOMRIGHT

stringsendScriptMessage(pluginName:string,messageSelectorSendsthescriptmessagetotherequiredplugin.Parameter Type Description

pluginName string Plugintowhichmessageneedstobesent.

messageSelector string Functionalitythatistobeexecuted.

inputString string Passanydataencodedinastring.

voidtransform(transformationMatrix:Matrix[,changePositionschangeFillPatterns:bool=true][,changeFillGradients:boolbool=true][,changeLineWidths:number=100.0][,transformAboutTransformation=Transformation.CENTER])Transformartobject(s)usingatransformationmatrix.Parameter Type

transformationMatrix Matrix





changeLineWidths number

transformAbout Transformation:Transformation.DOCUMENTORIGINTransformation.TOPLEFTTransformation.LEFTTransformation.BOTTOMLEFTTransformation.TOPTransformation.CENTERTransformation.BOTTOMTransformation.TOPRIGHTTransformation.RIGHTTransformation.BOTTOMRIGHT

voidtranslate([deltaX:number=0.0][,deltaY:number=0.0transformFillPatterns:bool=true][,transformFillGradientstransformStrokePattern:bool=true])Repositionartobject(s)




transformObjects bool Areartobjectpositionsandorientationsaffected?(default:true)(Optional)

transformFillPatterns bool Arethefillpatternsassignedtopathstobetransformed?(default:true)(Optional)

transformFillGradients bool Arethefillgradientsassignedtopathstobetransformed?(default:true)(Optional)

transformStrokePattern bool Arethestrokepatternsassignedtopathstobetransformed?(default:true

voidzOrder(zOrderCmd:ZOrderMethod)Arrangestheartrelativetootherartinthegrouporlayer.Parameter Type

zOrderCmd ZOrderMethod:ZOrderMethod.BRINGTOFRONTZOrderMethod.BRINGFORWARDZOrderMethod.SENDBACKWARDZOrderMethod.SENDTOBACK

Elementof TracingObject.sourceArt

Usedin: SymbolSymbols.add(sourceArt:PageItem[,registrationPointSymbolRegistrationPoint=SymbolRegistrationPoint.SYMBOLCENTERPOINT

Return PageItemDocument.rasterize(sourceArt:any[,clipBoundsRasterizeOptions])

PageItemPageItem.duplicate(relativeObject:Object,insertionLocationPageItemPageItem.move(relativeObject:Object,insertionLocationPageItemPageItems.getByName(name:string)PageItemTracingObject.releaseTracing()


Contents::Index

Class

PathItem Anartworkpathitem.BaseClass:PageItem

QuickLinks duplicate,move,remove,removeAll,setEntirePath

Hierarchy Object

PageItem

PathItem


area number

clipping bool

closed bool

evenodd bool

fillColor Color

fillOverprint bool

filled bool

guides bool

length number

parent Object

pathPoints PathPoints PathPoint

polarity PolarityValues:PolarityValues.POSITIVEPolarityValues.NEGATIVE

resolution number

selectedPathPoints ObjectArray

strokeCap StrokeCap:StrokeCap.BUTTENDCAPStrokeCap.ROUNDENDCAPStrokeCap.PROJECTINGENDCAP

strokeColor Color

strokeDashOffset number

strokeDashes Arrayofnumber

strokeJoin StrokeJoin:StrokeJoin.MITERENDJOINStrokeJoin.ROUNDENDJOINStrokeJoin.BEVELENDJOIN

strokeMiterLimit number

strokeOverprint bool

strokeWidth number

stroked bool

typename string

Methods InstancesPathItemduplicate(relativeObject:Object,insertionLocation

ElementPlacement)Duplicatethisobject.Parameter Type



PathItemmove(relativeObject:Object,insertionLocation:Movetheobject.Parameter Type





voidsetEntirePath(pathPoints:Arrayofany)Setthepathusingtheprovidedarrayofpathpoint(x,y)coordinatepairs.Parameter Type Description

pathPoints Arrayofany Arrayof(x,y)coordinatepairsforthepathpoints.

Usedin: TextFrameItemTextFrameItems.areaText(textPath:PathItemTextOrientation=TextOrientation.HORIZONTAL][,TextFrameItem][,postFix:bool=true])

TextFrameItemTextFrameItems.pathText(textPath:PathItemnumber=0.0][,endTValue:number=0.0][,orientation:TextOrientation=TextOrientation.HORIZONTAL][,TextFrameItem][,postFix:bool=true])

Return PathItemPathItem.duplicate(relativeObject:Object,insertionLocationElementPlacement)

PathItemPathItem.move(relativeObject:Object,insertionLocationElementPlacement)

PathItemPathItems.add()PathItemPathItems.ellipse([top:number=100][,left:number

number=50][,height:number=100][,reversed:bool=falsebool=true])

PathItemPathItems.getByName(name:string)PathItemPathItems.polygon([centerX:number=200][,centerY

radius:number=50][,sides:Int32=8][,reversed:bool=PathItemPathItems.rectangle(top:number,left:number,width

number[,reversed:bool=false])PathItemPathItems.roundedRectangle(top:number,left:

number,height:number[,horizontalRadius:number=15number=20][,reversed:bool=false])

PathItemPathItems.star([centerX:number=200][,centerYradius:number=50][,innerRadius:number=20][,pointsbool=false])


Contents::Index

Class

PathPoint Apointonapath.


Hierarchy Object

PathPoint


anchor Point

leftDirection Point

parent Object

pointType PointType:PointType.SMOOTHPointType.CORNER

rightDirection Point

selected PathPointSelection:PathPointSelection.NOSELECTIONPathPointSelection.ANCHORPOINTPathPointSelection.LEFTDIRECTIONPathPointSelection.RIGHTDIRECTIONPathPointSelection.LEFTRIGHTPOINT

typename string



Return PathPointPathPoints.add()PathPointPathPoints.getByName(name:string)


Contents::Index

Enumeration

PathPointSelection Thepathpointselectionstate.

Value Name

PathPointSelection.ANCHORPOINT

PathPointSelection.LEFTDIRECTION

PathPointSelection.LEFTRIGHTPOINT

PathPointSelection.NOSELECTION

PathPointSelection.RIGHTDIRECTION

Usage AspropertyPathPoint.selected


Contents::Index

Enumeration

PerspectiveGridPlaneType Perspectivegridplanetypes.

Value Name

PerspectiveGridPlaneType.FLOORPLANE

PerspectiveGridPlaneType.LEFTPLANE

PerspectiveGridPlaneType.NOPLANE

PerspectiveGridPlaneType.RIGHTPLANE

Usage ReturnPerspectiveGridPlaneType()InfunctionboolDocument.setPerspectiveActivePlane

PerspectiveGridPlaneTypevoidPageItem.bringInPerspective

number,perspectiveGridPlane


Contents::Index

Enumeration

PhotoshopCompatibility ThePhotoshopcompatibilitytype.

Value Name

PhotoshopCompatibility.PHOTOSHOP6

PhotoshopCompatibility.PHOTOSHOP8

Usage


Contents::Index

Class

PlacedItem Placedartworkitem.BaseClass:PageItem

QuickLinks duplicate,embed,move,relink,remove,removeAll,trace

Hierarchy Object

PageItem

PlacedItem


boundingBox Rectangle readonly Dimensionsofplacedartobject,regardlessoftransformations.

contentVariable any r/w Thecontentvariableboundtothisplacedartobject.

file File r/w Thefilecontainingtheplacedartwork.

matrix Matrix r/w Thetransformationmatrixoftheplacedartobject.



Methods InstancesPlacedItemduplicate(relativeObject:Object,insertionLocation:ElementPlacement)Duplicatethisobject.Parameter Type Description



voidembed()Embedtheplacedartwithintheillustration.

PlacedItemmove(relativeObject:Object,insertionLocation:ElementPlacement)Movetheobject.Parameter Type Description



voidrelink(fileSpec:File)Relinktheplacedartwithsuppliedartfromfile.Parameter Type Description

fileSpec File Filespectorelinkfrom.



PluginItemtrace()Tracethisrasterobjectusingdefaultoptions.Reordersthisplacedtothesourceart.

Return PlacedItemPlacedItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

PlacedItemPlacedItem.move(relativeObject:Object,

insertionLocation:ElementPlacement)PlacedItemPlacedItems.add()PlacedItemPlacedItems.getByName(name:string)


Contents::Index

Class

PluginItem Pluginartworkitem.BaseClass:PageItem


Hierarchy Object

PageItem

PluginItem


isTracing bool readonly Istheplugingroupatracing?


tracing TracingObject readonly Thetracingobjectassociatedwiththispluginitem.


Methods InstancesPluginItemduplicate(relativeObject:Object,insertionLocation:ElementPlacement)Duplicatethisobject.Parameter Type Description



PluginItemmove(relativeObject:Object,insertionLocation:ElementPlacement)Movetheobject.Parameter Type Description





Return PluginItemPlacedItem.trace()PluginItemPluginItem.duplicate(relativeObject:

Object,insertionLocation:ElementPlacement)PluginItemPluginItem.move(relativeObject:

Object,insertionLocation:ElementPlacement)PluginItemPluginItems.getByName(name:string)PluginItemRasterItem.trace()


Contents::Index

Enumeration

PointType Thepathpointtype:smooth/corner.


PointType.CORNER Cornerpoint. int2

PointType.SMOOTH Smoothpathpoint. int1

Usage AspropertyPathPoint.pointType


Contents::Index

Enumeration

PolarityValues


PolarityValues.NEGATIVE int-1

PolarityValues.POSITIVE int1

Usage AspropertyPathItem.polarityTextPath.polarity


Contents::Index

Class

Preferences PreferencesforIllustrator.

QuickLinks getBooleanPreference,getIntegerPreference,getRealPreferencegetStringPreference,removePreference,setBooleanPreferencesetIntegerPreference,setRealPreference,setStringPreference

Hierarchy Object

Preferences


AutoCADFileOptions OpenOptionsAutoCAD readonly

PDFFileOptions OpenOptionsPDF readonly


photoshopFileOptions OpenOptionsPhotoshop readonly


Methods InstancesboolgetBooleanPreference(key:string)Retrievethevalueoftheapplicationpreferencekeyasboolean.Parameter Type Description

key string Thepreferencekey.

Int32getIntegerPreference(key:string)Retrievethevalueoftheapplicationpreferencekeyasinteger.Parameter Type Description


numbergetRealPreference(key:string)Retrievethevalueoftheapplicationpreferencekeyasrealnumber.Parameter Type Description


stringgetStringPreference(key:string)Retrievethevalueoftheapplicationpreferencekeyasstringtype.Parameter Type Description


voidremovePreference(key:string)Deletetheapplicationpreferencekey.Parameter Type Description


voidsetBooleanPreference(key:string,value:bool)Setthevalueoftheapplicationpreferencekeyasboolean.Parameter Type Description


value bool Thebooleanvalueofthepreferencekey.

voidsetIntegerPreference(key:string,value:Int32)

Setthevalueoftheapplicationpreferencekeyasinteger.Parameter Type Description


value Int32 Thebooleanvalueofthepreferencekey.

voidsetRealPreference(key:string,value:number)Setthevalueoftheapplicationpreferencekeyasrealnumber.Parameter Type Description


value number Therealvalueofthepreferencekey.

voidsetStringPreference(key:string,value:string)Setthevalueoftheapplicationpreferencekeyasstringtype.Parameter Type Description


value string Thestringvalueofthepreferencekey.

Elementof Application.preferences


Contents::Index

Enumeration

PrinterPostScriptLevelEnum ThePostScriptlevelssupportedbyvariousprinters.

Value Name

PrinterPostScriptLevelEnum.PSLEVEL1



Usage AspropertyPrintPostScriptOptionsPrinterInfo.postScriptLevel


Contents::Index

Class

RasterEffectOptions Thedocumentrastereffectssettings.

Class Property Type

antiAliasing bool

clippingMask bool

colorModel RasterizationColorModelRasterizationColorModel.DEFAULTCOLORMODELRasterizationColorModel.GRAYSCALERasterizationColorModel.BITMAP

convertSpotColors bool

padding number

resolution number(range:72.0-2400.0)

transparency bool

Elementof Document.rasterEffectSettings


Contents::Index

Class

RasterItem Rasterartworkitem.BaseClass:PageItem

QuickLinks colorize,duplicate,move,remove,removeAll,trace

Hierarchy Object

PageItem

RasterItem


bitsPerChannel Int32

boundingBox Rectangle

channels Int32

colorants Arrayofstring

colorizedGrayscale bool

contentVariable any

embedded bool

file File

imageColorSpace ImageColorSpace:ImageColorSpace.GrayScaleImageColorSpace.RGBImageColorSpace.CMYKImageColorSpace.LABImageColorSpace.SeparationImageColorSpace.DeviceNImageColorSpace.Indexed

matrix Matrix

overprint bool

parent Object

status RasterLinkState:RasterLinkState.NODATARasterLinkState.DATAFROMFILERasterLinkState.DATAMODIFIED

transparent bool

typename string

Methods Instancesvoidcolorize(rasterColor:Color)ColorizetheRasterItemwithaCMYKorRGBColor.


rasterColor Color ThecolortouseforcoloringtheTIFFimage.

RasterItemduplicate(relativeObject:Object,insertionLocationDuplicatethisobject.Parameter Type



RasterItemmove(relativeObject:Object,insertionLocationMovetheobject.Parameter Type





PluginItemtrace()Tracethisrasterobjectusingdefaultoptions.Reordersthisrastertothesourceart.

Return RasterItemRasterItem.duplicate(relativeObject:ObjectElementPlacement)

RasterItemRasterItem.move(relativeObject:Object,ElementPlacement)

RasterItemRasterItems.getByName(name:string)


Contents::Index

Enumeration

RasterLinkState Therasterlinkstate.


RasterLinkState.DATAFROMFILE Imagedataisfromthelinkedfile.

RasterLinkState.DATAMODIFIED Imagedatahasbeenmodified.

RasterLinkState.NODATA Imagedataisnotset.

Usage AspropertyRasterItem.status


Contents::Index

Enumeration

RasterizationColorModel Controlsthecolormodelfortherasterization.

Value Name

RasterizationColorModel.BITMAP

RasterizationColorModel.DEFAULTCOLORMODEL

RasterizationColorModel.GRAYSCALE

Usage AspropertyRasterEffectOptions.colorModelRasterizeOptions.colorModel


Contents::Index

Class

RasterizeOptions Optionswhichmaybesuppliedwhenrasterizingtheartwork.

Class Property Type

antiAliasingMethod AntiAliasingMethodAntiAliasingMethod.NoneAntiAliasingMethod.ARTOPTIMIZEDAntiAliasingMethod.TYPEOPTIMIZED

backgroundBlack bool

clippingMask bool

colorModel RasterizationColorModelRasterizationColorModel.DEFAULTCOLORMODELRasterizationColorModel.GRAYSCALERasterizationColorModel.BITMAP

convertSpotColors bool

convertTextToOutlines bool

includeLayers bool

padding number


transparency bool

Usedin: PageItemDocument.rasterize(sourceArt:


Contents::Index

Enumeration

RulerUnits


RulerUnits.Centimeters Rulerunitsaremeasuredincentimeters.

int3

RulerUnits.Inches Rulerunitsareunknown.

int2

RulerUnits.Millimeters Rulerunitsaremeasuredinmillimeters.

int6

RulerUnits.Picas Rulerunitsaremeasuredinpicas.

int5

RulerUnits.Pixels Rulerunitsaremeasuredinpixels.

int8

RulerUnits.Points Rulerunitsaremeasuredinpoints.

int4

RulerUnits.Qs RulerunitsaremeasuredinQs.

int7

RulerUnits.Unknown Rulerunitsareunknown.

int1

Usage AspropertyDocument.rulerUnitsDocumentPreset.units


Contents::Index

Enumeration

SVGCSSPropertyLocation

Value Name

SVGCSSPropertyLocation.ENTITIES

SVGCSSPropertyLocation.PRESENTATIONATTRIBUTES

SVGCSSPropertyLocation.STYLEATTRIBUTES

SVGCSSPropertyLocation.STYLEELEMENTS

Usage AspropertyExportOptionsSVG.cssProperties


Contents::Index

Enumeration

SVGDTDVersion TheversionoftheSVGDTD.

Value Name

SVGDTDVersion.SVG1_0 SVG1.0.

SVGDTDVersion.SVG1_1 SVG1.1.

SVGDTDVersion.SVGBASIC1_1 SVGBasic1.1.

SVGDTDVersion.SVGTINY1_1 SVGTiny1.1.

SVGDTDVersion.SVGTINY1_1PLUS SVGTiny1.1Plus.

SVGDTDVersion.SVGTINY1_2 SVGTiny1.2.

Usage AspropertyExportOptionsSVG.DTD


Contents::Index

Enumeration

SVGDocumentEncoding

Value Name

SVGDocumentEncoding.ASCII

SVGDocumentEncoding.UTF16

SVGDocumentEncoding.UTF8

Usage AspropertyExportOptionsSVG.documentEncoding


Contents::Index

Enumeration

SVGFontSubsetting Whatfontstoincludewiththefile?

Value Name

SVGFontSubsetting.ALLGLYPHS

SVGFontSubsetting.COMMONENGLISH

SVGFontSubsetting.COMMONROMAN

SVGFontSubsetting.GLYPHSUSED

SVGFontSubsetting.GLYPHSUSEDPLUSENGLISH

SVGFontSubsetting.GLYPHSUSEDPLUSROMAN

SVGFontSubsetting.None

Usage AspropertyExportOptionsSVG.fontSubsetting


Contents::Index

Enumeration

SVGFontType Whatfonttypetoincludewiththefile?


SVGFontType.CEFFONT AdobeCompactEmbeddedFont(CEF)

SVGFontType.OUTLINEFONT

SVGFontType.SVGFONT

Usage AspropertyExportOptionsSVG.fontType


Contents::Index

Enumeration

SaveOptions Theoptionsthatmaybeappliedwhensavingafile.


SaveOptions.DONOTSAVECHANGES Donotsavechanges.

SaveOptions.PROMPTTOSAVECHANGES Asktheuserwhethertosave.

SaveOptions.SAVECHANGES Savechanges.

Usage InfunctionvoidDocument.close([saving:SaveOptions])AspropertyExportOptionsFlash.replacing


Contents::Index

Enumeration

ScreenMode Thescreenmode.


ScreenMode.DESKTOP Fullscreenwithmenubar.

int2

ScreenMode.FULLSCREEN Fullscreenwithoutmenubar.

int3

ScreenMode.MULTIWINDOW Displaymultiplewindows.

int1

Usage AspropertyView.screenMode


Contents::Index

Enumeration

SpotColorKind Customcolorkindofthespotcolor.


SpotColorKind.SPOTCMYK Solidink,expressedinfourCMYKvalues.

SpotColorKind.SPOTLAB Labcolor.Onlyvalidforspotcolors.

SpotColorKind.SPOTRGB Solidcolor,expressedasthreeRGBvalues.

Usage AspropertySpot.spotKind


Contents::Index

Enumeration

StrokeCap Thestrokecap.


StrokeCap.BUTTENDCAP Buttedcap. int

StrokeCap.PROJECTINGENDCAP Projectingcap.

int

StrokeCap.ROUNDENDCAP Roundedcap.

int

Usage AspropertyDocument.defaultStrokeCapPathItem.strokeCapTextPath.strokeCap


Contents::Index

Enumeration

StrokeJoin Thestrokejoint.


StrokeJoin.BEVELENDJOIN Beveledjoints.

int3

StrokeJoin.MITERENDJOIN Miteredjoints.

int1

StrokeJoin.ROUNDENDJOIN Roundedjoints.

int2

Usage AspropertyDocument.defaultStrokeJoinPathItem.strokeJoinTextPath.strokeJoin


Contents::Index

Class

Symbol Asymbol.

QuickLinks duplicate,remove,removeAll

Hierarchy Object

Symbol


name string r/w Thesymbol'sname.



Methods InstancesSymbolduplicate(relativeObject:Object,insertionLocation:ElementPlacementDuplicatethisobject.Parameter Type





Elementof SymbolItem.symbol

Usedin: SymbolItemSymbolItems.add(symbol:Symbol)

Return SymbolSymbol.duplicate(relativeObject:Object,insertionLocationSymbolSymbols.add(sourceArt:PageItem[,registrationPoint:

SymbolRegistrationPoint=SymbolRegistrationPoint.SYMBOLCENTERPOINTSymbolSymbols.getByName(name:string)


Contents::Index

Class

SymbolItem AninstanceofaSymbol.BaseClass:PageItem

QuickLinks breakLink,duplicate,move,remove,removeAll

Hierarchy Object

PageItem

SymbolItem



symbol Symbol r/w Thesymbolthatwasusedtocreatethissymbolitem.


Methods InstancesvoidbreakLink()Breaklinktothesymbol.

SymbolItemduplicate(relativeObject:Object,insertionLocation:ElementPlacement)Duplicatethisobject.Parameter Type Description



SymbolItemmove(relativeObject:Object,insertionLocation:ElementPlacement)Movetheobject.






Return SymbolItemSymbolItem.duplicate(relativeObject:Object,insertionLocation:ElementPlacement)

SymbolItemSymbolItem.move(relativeObject:Object,insertionLocation:ElementPlacement)

SymbolItemSymbolItems.add(symbol:Symbol)SymbolItemSymbolItems.getByName(name:

string)


Contents::Index

Enumeration

SymbolRegistrationPoint Thesymbolregistrationpoint.

Value Name

SymbolRegistrationPoint.SYMBOLBOTTOMLEFTPOINT

SymbolRegistrationPoint.SYMBOLBOTTOMMIDDLEPOINT

SymbolRegistrationPoint.SYMBOLBOTTOMRIGHTPOINT

SymbolRegistrationPoint.SYMBOLCENTERPOINT

SymbolRegistrationPoint.SYMBOLMIDDLELEFTPOINT

SymbolRegistrationPoint.SYMBOLMIDDLERIGHTPOINT

SymbolRegistrationPoint.SYMBOLTOPLEFTPOINT

SymbolRegistrationPoint.SYMBOLTOPMIDDLEPOINT

SymbolRegistrationPoint.SYMBOLTOPRIGHTPOINT

Usage InfunctionSymbolSymbols.add(sourceArt

SymbolRegistrationPoint


Contents::Index

Enumeration

TIFFByteOrder ByteOrderofTIFFfile.


TIFFByteOrder.IBMPC

TIFFByteOrder.MACINTOSH

Usage AspropertyExportOptionsTIFF.byteOrder


Contents::Index

Enumeration

TabStopAlignment Thetabalignment.


TabStopAlignment.Center

TabStopAlignment.Decimal

TabStopAlignment.Left

TabStopAlignment.Right

Usage AspropertyTabStopInfo.alignment


Contents::Index

Class

TabStopInfo Tabstopinformation(returnedbytabstopsfromaparagraphobject)

Class Property Type Access

alignment TabStopAlignment:TabStopAlignment.LeftTabStopAlignment.CenterTabStopAlignment.RightTabStopAlignment.Decimal

r/w

decimalCharacter string r/w

leader string r/w

position number r/w

Elementof ParagraphAttributes.tabStops


Contents::Index

Class

Tag Atagassociatedwithapieceofartwork.


Hierarchy Object

Tag


name string r/w Thetag'sname.



value string r/w Thedatastoredinthistag.



Return TagTags.add()TagTags.getByName(name:string)


Contents::Index

Enumeration

TextAntialias Thetypeoftextantialiasing.


TextAntialias.CRISP Textonapath.

int3

TextAntialias.NONE Textfromapoint.

int1

TextAntialias.SHARP Textwithinanarea.

int2

TextAntialias.STRONG Textonapath.

int4

Usage AspropertyTextFrameItem.antialias


Contents::Index

Class

TextFont Aninstalledfont.

Hierarchy Object

TextFont


family string readonly Thefont'sfamilyname.

name string readonly Thefont'sfullname.


style string readonly Thefont'sstylename.


Elementof CharacterAttributes.textFont

Return TextFontTextFonts.getByName(name:string)


Contents::Index

Class

TextFrameItem Textframeitem.BaseClass:PageItem

QuickLinks createOutline,duplicate,move,remove,removeAll

Hierarchy

TextFrameItem


anchor Point

antialias TextAntialias:TextAntialias.NONETextAntialias.SHARPTextAntialias.CRISPTextAntialias.STRONG

characters Characters

columnCount Int32

columnGutter number

contentVariable any

contents string

endTValue number

firstBaseline FirstBaselineType:FirstBaselineType.BASELINEASCENTFirstBaselineType.BASELINECAPHEIGHTFirstBaselineType.BASELINELEADINGFirstBaselineType.BASELINEXHEIGHTFirstBaselineType.BASELINEEMBOXHEIGHTFirstBaselineType.BASELINEFIXEDFirstBaselineType.BASELINELEGACY

firstBaselineMin number

flowLinksHorizontally bool

insertionPoints InsertionPoints InsertionPoint

kind TextType:TextType.POINTTEXTTextType.AREATEXTTextType.PATHTEXT

lines Lines

matrix Matrix

nextFrame TextFrameItem

opticalAlignment bool

orientation TextOrientation:TextOrientation.HORIZONTALTextOrientation.VERTICAL

paragraphs Paragraphs

parent Object

previousFrame TextFrameItem

rowCount Int32

rowGutter number

spacing number

startTValue number

story Story

textPath TextPath

textRange TextRange

textRanges TextRanges TextRange

textSelection ArrayofTextRange

typename string

words Words

Methods InstancesGroupItemcreateOutline()Converttextitemtopathitems.

TextFrameItemduplicate(relativeObject:ObjectDuplicatethisobject.Parameter Type



TextFrameItemmove(relativeObject:Object,Movetheobject.Parameter Type





Elementof TextFrameItem.nextFrameTextFrameItem.previousFrame

Usedin: TextFrameItemTextFrameItems.areaText(textPathTextOrientation=TextOrientation.HORIZONTALbool=true])

TextFrameItemTextFrameItems.pathText(textPathendTValue:number=0.0][,orientation:TextOrientationbaseFrame:TextFrameItem][,postFix:

Return TextFrameItemTextFrameItem.duplicate(relativeObjectElementPlacement)

TextFrameItemTextFrameItem.move(relativeObjectElementPlacement)

TextFrameItemTextFrameItems.add()TextFrameItemTextFrameItems.areaText(textPath

TextOrientation=TextOrientation.HORIZONTALbool=true])

TextFrameItemTextFrameItems.getByNameTextFrameItemTextFrameItems.pathText(textPath

endTValue:number=0.0][,orientation:TextOrientationbaseFrame:TextFrameItem][,postFix:

TextFrameItemTextFrameItems.pointText(anchorTextOrientation=TextOrientation.HORIZONTAL


Contents::Index

Enumeration

TextOrientation Theorientation.


TextOrientation.HORIZONTAL Horizontalorientation.

TextOrientation.VERTICAL Verticalorientation.

Usage InfunctionTextFrameItemTextFrameItems.areaText(textPath

PathItem[,orientation:TextOrientation=TextOrientation.HORIZONTAL[,baseFrame:TextFrameItem][,postFix

TextFrameItemTextFrameItems.pathText(textPathPathItem[,startTValue:number=0.0][,endTValuenumber=0.0][,orientation:TextOrientation=TextOrientation.HORIZONTAL[,baseFrame:TextFrameItem][,postFix

TextFrameItemTextFrameItems.pointText(anchororientation:TextOrientation=TextOrientation.HORIZONTAL

AspropertyTextFrameItem.orientation


Contents::Index

Enumeration

TextPreservePolicy TextpreservepolicyusedbyFXGfileformat.

Value Name

TextPreservePolicy.AUTOMATICALLYCONVERTTEXT

TextPreservePolicy.KEEPTEXTEDITABLE

TextPreservePolicy.OUTLINETEXT

TextPreservePolicy.RASTERIZETEXT

Usage AspropertyFXGSaveOptions.textPolicy


Contents::Index

Enumeration

TextType Thetypeoftextart.


TextType.AREATEXT Textwithinanarea. int1

TextType.PATHTEXT Textonapath. int2

TextType.POINTTEXT Textfromapoint. int0

Usage AspropertyTextFrameItem.kind


Contents::Index

Enumeration

Transformation Thetransformationtype.


Transformation.BOTTOM Transformrelativetotheobject'sbottomedge.

Transformation.BOTTOMLEFT Transformrelativetotheobject'sbottomleftcorner.

Transformation.BOTTOMRIGHT Transformrelativetotheobject'sbottomrightcorner.

Transformation.CENTER Transformrelativetotheobject'scenter.

Transformation.DOCUMENTORIGIN Transformrelativetotheillustration'spageorigin.

Transformation.LEFT Transformrelativetotheobject'sleftedge.

Transformation.RIGHT Transform

relativetotheobject'srightedge.

Transformation.TOP Transformrelativetotheobject'stopedge.

Transformation.TOPLEFT Transformrelativetotheobject'stopleftcorner.

Transformation.TOPRIGHT Transformrelativetotheobject'stoprightcorner.

Usage InfunctionvoidPageItem.resize(scaleX:number,scaleY

changePositions:bool=true][,changeFillPatternsbool=true][,changeFillGradients:bool=changeStrokePattern:bool=true][,changeLineWidthsnumber=100.0][,scaleAbout:Transformation=Transformation.CENTER

voidPageItem.rotate(angle:number[,changePositionsbool=true][,changeFillPatterns:bool=truechangeFillGradients:bool=true][,changeStrokePatternbool=true][,rotateAbout:Transformation=Transformation.CENTER

voidPageItem.transform(transformationMatrixchangePositions:bool=true][,changeFillPatternsbool=true][,changeFillGradients:bool=changeStrokePattern:bool=true][,changeLineWidthsnumber=100.0][,transformAbout:Transformation=Transformation.CENTER


Contents::Index

Enumeration

UserInteractionLevel COMuserinteractionenumeration.

Value Name

UserInteractionLevel.DISPLAYALERTS

UserInteractionLevel.DONTDISPLAYALERTS

Usage AspropertyApplication.userInteractionLevel


Contents::Index

Enumeration

VariableKind


VariableKind.GRAPH int5

VariableKind.IMAGE int4

VariableKind.TEXTUAL int3

VariableKind.Unknown int1

VariableKind.VISIBILITY int2

Usage AspropertyVariable.kind


Contents::Index

Class

View Aview.

Hierarchy Object

View


bounds Rectangle readonly Theboundingrectangleofthisview.

centerPoint Point r/w Thecenterpointofthisview.


screenMode ScreenMode:ScreenMode.MULTIWINDOWScreenMode.DESKTOPScreenMode.FULLSCREEN

r/w Themodeofdisplay.


zoom number r/w Thezoomfactorofthisview.

Elementof

Document.activeView

Return ViewViews.getByName(name:string)


Contents::Index

Enumeration

ZOrderMethod Howtore-arrangetheartitem.


ZOrderMethod.BRINGFORWARD Moveartonestepforwardinit'sgrouporlayer.

ZOrderMethod.BRINGTOFRONT Movearttofrontofit'sgrouporlayer.

ZOrderMethod.SENDBACKWARD Moveartonestepbackwardsinit'sgrouporlayer.

ZOrderMethod.SENDTOBACK Movearttobackofit'sgrouporlayer.

Usage InfunctionvoidLayer.zOrder(zOrderCmd:ZOrderMethodvoidPageItem.zOrder(zOrderCmd:ZOrderMethod


Contents::Index

Class

CMYKColor ACMYKcolorspecification.BaseClass:Color


black number(range:0.0-100.0)

r/w Theblackcolorvalue(between0.0and100.0)(default:0.0)

cyan number(range:0.0-100.0)

r/w Thecyancolorvalue(between0.0and100.0)(default:0.0)

magenta number(range:0.0-100.0)

r/w Themagentacolorvalue(between0.0and100.0)(default:0.0)

yellow number(range:0.0-100.0)

r/w Theyellowcolorvalue(between0.0and100.0)(default:0.0)


Contents::Index

Class

Color TheparentclassforallcolorvaluesusedinIllustrator.Seethe

specificcolorclassesformoreinformation.

SuperclassofCMYKColor,GradientColor,GrayColor,LabColor,NoColor,PatternColor,RGBColor,andSpotColor

Elementof

CharacterAttributes.fillColorCharacterAttributes.strokeColorDocument.defaultFillColorDocument.defaultStrokeColorGradientStop.colorInkInfo.customColorPathItem.fillColorPathItem.strokeColorSpot.colorSwatch.colorTextPath.fillColorTextPath.strokeColor

Usedin: voidRasterItem.colorize(rasterColor:Color)


Contents::Index

Enumeration

ColorConvertPurpose Denotesthepurposeofcolorconversionusing

ConvertSmapleColormethod.

Value Name

ColorConvertPurpose.defaultpurpose

ColorConvertPurpose.dummypurpose

ColorConvertPurpose.exportpurpose

ColorConvertPurpose.previewpurpose

Usage InfunctionArrayofnumberApplication.convertSampleColor

(sourceColorSpace:ImageColorSpaceArrayofnumber,destColorSpacecolorConvertPurpose:ColorConvertPurposesourceHasAlpha:bool=falsebool=false])


Contents::Index

Class

GradientColor AGradientcolorspecification.BaseClass:

Color


angle number r/w Thegradientvectorangle.(default:0)

gradient Gradient r/w Referencetotheobjectdefiningthegradient.

hiliteAngle number r/w Thegradienthilitevectorangle.(default:0)

hiliteLength number r/w Thegradienthilitevectorlength.(default:0)

length number r/w Thegradientvectorlength.(default:0)

matrix Matrix r/w Additionaltransformationarisingfrommanipulatingthepath.

origin Point r/w Thegradientvectororigin.


v3.0.3i

Class

GrayColor Agraycolorspecification.BaseClass:Color


gray number(range:0.0-100.0)

r/w Thegrayvalue(between0.0and100.0)(default:0.0)


Contents::Index

Class

LabColor AnLabcolorspecification.BaseClass:Color


a number(range:-128.0-127.0)

r/w Theacolorvalue(between-128.0and127.0)(default:0.0)

b number(range:-128.0-127.0)

r/w Thebcolorvalue(between-128.0and127.0)(default:0.0)

l number(range:0.0-100.0)

r/w TheLcolorvalue(between0.0and100.0)(default:0.0)


Contents::Index

Class

NoColor Representsthe'none'color.BaseClass:Color


Contents::Index

Class

Pattern Apattern.


Hierarchy Object

Pattern


name string r/w Thepattern'sname.





Elementof PatternColor.pattern

Return PatternPatterns.add()PatternPatterns.getByName(name:string)


Contents::Index

Class

PatternColor APatterncolorspecification.BaseClass:Color


matrix Matrix r/w Additionaltransformationarisingfrommanipulatingthepath.

pattern Pattern r/w

reflect bool r/w Whetherornottheprototypeisreflectedbeforefilling.(default:false)

reflectAngle number r/w Theaxisaroundwhichtoreflect.(default:0)

rotation number r/w Theangletorotatethebeforefilling.(default:0)

scaleFactor Point r/w Thefractiontoscaletheprototypebeforefilling.

shearAngle number r/w Theangletoslanttheshearby.(default:0)

shearAxis number r/w Theaxisto

shearwithrespectto.(default:0)

shiftAngle number r/w Theangletotranslatethe(unscaled)prototypebeforefilling.(default:0)

shiftDistance number r/w Thedistancetotranslatethe(unscaled)prototypebeforefilling.(default:0)


Contents::Index

Class

RGBColor AnRGBcolorspecification.BaseClass:Color


blue number(range:0.0-255.0)

r/w Thebluecolorvalue(between0.0and255.0)(default:0.0)

green number(range:0.0-255.0)

r/w Thegreencolorvalue(between0.0and255.0)(default:0.0)

red number(range:0.0-255.0)

r/w Theredcolorvalue(between0.0and255.0)(default:0.0)

Elementof ExportOptionsFlash.backgroundColorExportOptionsGIF.matteColorExportOptionsJPEG.matteColorExportOptionsPNG24.matteColorExportOptionsPNG8.matteColorImageCaptureOptions.matteColorLayer.color


Contents::Index

Class

Spot Acustomcolor.

QuickLinks getInternalColor,remove,removeAll

Hierarchy Object

Spot


color Color r/w

colorType ColorModel:ColorModel.REGISTRATIONColorModel.PROCESSColorModel.SPOT

r/w Typeofthecustomcolor.

name string r/w Thecustomcolor'sname.


spotKind SpotColorKind:SpotColorKind.SPOTCMYKSpotColorKind.SPOTRGBSpotColorKind.SPOTLAB

readonly Kindofthespotcolor(i.e.RGB,CMYKorLAB),itisthenameofcolorkindcontainedinspot.


Methods InstancesArrayofnumbergetInternalColor()Getstheinternalcolorofaspot.



Elementof SpotColor.spot

Usedin: voidSwatchGroup.addSpot(spot:Spot)

Return SpotSpots.add()SpotSpots.getByName(name:string)


Contents::Index

Class

SpotColor Informationaboutthespotcolor.BaseClass:Color


spot Spot r/w

tint number(range:0.0-100.0)

r/w Percentageleveloftinttobeappliedtothespotcolor.(default:100.0)


Contents::Index

Class

Swatch Acolorswatch.


Hierarchy Object

Swatch


color Color r/w Thecolorinformationoftheswatch.

name string r/w Theswatch'sname.





Usedin: voidSwatchGroup.addSwatch(swatch:Swatch)

Return ArrayofSwatchSwatchGroup.getAllSwatches()SwatchSwatches.add()SwatchSwatches.getByName(name:string)ArrayofSwatchSwatches.getSelected()


Contents::Index

Class

SwatchGroup ASwatchgroup.

QuickLinks addSpot,addSwatch,getAllSwatches,remove,removeAll

Hierarchy Object

SwatchGroup


name string r/w Nameoftheswatchgroup.



Methods InstancesvoidaddSpot(spot:Spot)Addaspotswatchtothegroup.Parameter Type Description

spot Spot Thespotswatchtobeaddedtothegroup.

voidaddSwatch(swatch:Swatch)Addaswatchtothegroup.Parameter Type Description

swatch Swatch Theswatchtobeaddedtothegroup.

ArrayofSwatchgetAllSwatches()Getallswatchesintheswatchgroup.



Return SwatchGroupSwatchGroups.add()SwatchGroupSwatchGroups.getByName

(name:string)


Contents::Index

Enumeration

AlternateGlyphsForm Thealternateglyphsformoftext.

Value Name

AlternateGlyphsForm.DEFAULTFORM

AlternateGlyphsForm.EXPERT

AlternateGlyphsForm.FULLWIDTH

AlternateGlyphsForm.HALFWIDTH

AlternateGlyphsForm.JIS04FORM




AlternateGlyphsForm.PROPORTIONALWIDTH

AlternateGlyphsForm.QUARTERWIDTH

AlternateGlyphsForm.THIRDWIDTH

AlternateGlyphsForm.TRADITIONAL

Usage AspropertyCharacterAttributes.alternateGlyphs


Contents::Index

Enumeration

AutoKernType Theautokerntype.


AutoKernType.AUTO Autokerning.

AutoKernType.METRICSROMANONLY Metricsromanonly.

AutoKernType.NOAUTOKERN Noautokerning.

AutoKernType.OPTICAL Opticalkerning.

Usage AspropertyCharacterAttributes.kerningMethod


Contents::Index

Enumeration

AutoLeadingType Theautoleadingtype.

Value Name

AutoLeadingType.BOTTOMTOBOTTOM

AutoLeadingType.TOPTOTOP

Usage AspropertyParagraphAttributes.leadingType


Contents::Index

Enumeration

BaselineDirectionType Thebaselinedirectiontype.

Value Name

BaselineDirectionType.Standard

BaselineDirectionType.TateChuYoko

BaselineDirectionType.VerticalRotated

Usage AspropertyCharacterAttributes.baselineDirection


Contents::Index

Enumeration

BurasagariTypeEnum TheBurasagaritype.

Value Name

BurasagariTypeEnum.Forced

BurasagariTypeEnum.None

BurasagariTypeEnum.Standard

Usage AspropertyParagraphAttributes.burasagariType


Contents::Index

Enumeration

CaseChangeType Thecasechangetype.


CaseChangeType.LOWERCASE Changetolowercase.

CaseChangeType.SENTENCECASE Changetosentencecase.

CaseChangeType.TITLECASE Changetotitlecase.

CaseChangeType.UPPERCASE Changetouppercase.

Usage InfunctionvoidTextRange.changeCaseTo(type:CaseChangeType


Contents::Index

Class

CharacterAttributes Propertiesofacharacter.

Hierarchy


Tsume number

akiLeft number

akiRight number

alignment StyleRunAlignmentTypeStyleRunAlignmentType.bottomStyleRunAlignmentType.icfBottomStyleRunAlignmentType.ROMANBASELINEStyleRunAlignmentType.centerStyleRunAlignmentType.icfTopStyleRunAlignmentType.top

alternateGlyphs AlternateGlyphsFormAlternateGlyphsForm.DEFAULTFORMAlternateGlyphsForm.TRADITIONAL

AlternateGlyphsForm.EXPERTAlternateGlyphsForm.JIS78FORMAlternateGlyphsForm.JIS83FORMAlternateGlyphsForm.HALFWIDTHAlternateGlyphsForm.THIRDWIDTHAlternateGlyphsForm.QUARTERWIDTHAlternateGlyphsForm.FULLWIDTHAlternateGlyphsForm.PROPORTIONALWIDTHAlternateGlyphsForm.JIS90FORMAlternateGlyphsForm.JIS04FORM

autoLeading bool

baselineDirection BaselineDirectionTypeBaselineDirectionType.StandardBaselineDirectionType.VerticalRotatedBaselineDirectionType.TateChuYoko

baselinePosition FontBaselineOptionFontBaselineOption.NORMALBASELINEFontBaselineOption.SUPERSCRIPTFontBaselineOption.SUBSCRIPT

baselineShift number

capitalization FontCapsOptionFontCapsOption.NORMALCAPSFontCapsOption.SMALLCAPSFontCapsOption.ALLCAPSFontCapsOption.ALLSMALLCAPS

connectionForms bool

contextualLigature bool

discretionaryLigature bool

figureStyle FigureStyleTypeFigureStyleType.DEFAULTFIGURESTYLEFigureStyleType.TABULARFigureStyleType.PROPORTIONALOLDSTYLEFigureStyleType.PROPORTIONALFigureStyleType.TABULAROLDSTYLE

fillColor Color

fractions bool

horizontalScale number

italics bool

kerningMethod AutoKernTypeAutoKernType.NOAUTOKERNAutoKernType.AUTOAutoKernType.OPTICALAutoKernType.METRICSROMANONLY

language LanguageTypeLanguageType.ENGLISHLanguageType.FINNISHLanguageType.STANDARDFRENCHLanguageType.CANADIANFRENCHLanguageType.STANDARDGERMANLanguageType.OLDGERMANLanguageType.SWISSGERMANLanguageType.ITALIANLanguageType.BOKMALNORWEGIANLanguageType.NYNORSKNORWEGIANLanguageType.STANDARDPORTUGUESELanguageType.BRAZILLIANPORTUGUESELanguageType.SPANISHLanguageType.SWEDISHLanguageType.UKENGLISHLanguageType.DUTCHLanguageType.DANISHLanguageType.CATALANLanguageType.RUSSIANLanguageType.UKRANIANLanguageType.BULGARIANLanguageType.SERBIANLanguageType.CZECHLanguageType.POLISHLanguageType.RUMANIANLanguageType.GREEKLanguageType.TURKISHLanguageType.ICELANDICLanguageType.HUNGARIAN

LanguageType.CHINESELanguageType.JAPANESELanguageType.GERMAN2006REFORMLanguageType.DUTCH2005REFORMLanguageType.SWISSGERMAN2006REFORM

leading number

ligature bool

noBreak bool

openTypePosition FontOpenTypePositionOptionFontOpenTypePositionOption.OPENTYPEDEFAULTFontOpenTypePositionOption.OPENTYPESUPERSCRIPTFontOpenTypePositionOption.OPENTYPESUBSCRIPTFontOpenTypePositionOption.NUMERATORFontOpenTypePositionOption.DENOMINATOR

ordinals bool

ornaments bool

overprintFill bool

overprintStroke bool

parent Object

proportionalMetrics bool

rotation number

size number

strikeThrough bool

strokeColor Color

strokeWeight number

stylisticAlternates bool

swash bool

tateChuYokoHorizontal Int32

tateChuYokoVertical Int32

textFont TextFont

titling bool

tracking Int32

typename string

underline bool

verticalScale number

wariChuCharactersAfterBreak Int32

wariChuCharactersBeforeBreak Int32

wariChuEnabled bool

wariChuJustification WariChuJustificationTypeWariChuJustificationType.LeftWariChuJustificationType.RightWariChuJustificationType.CenterWariChuJustificationType.WARICHUFULLJUSTIFYLASTLINELEFTWariChuJustificationType.WARICHUFULLJUSTIFYLASTLINERIGHTWariChuJustificationType.WARICHUFULLJUSTIFYLASTLINECENTERWariChuJustificationType.WARICHUFULLJUSTIFYWariChuJustificationType.WARICHUAUTOJUSTIFY

wariChuLineGap Int32

wariChuLines Int32

wariChuScale number

Elementof CharacterStyle.characterAttributesParagraphStyle.characterAttributesTextRange.characterAttributes


Contents::Index

Class

CharacterStyle Anamedstylethatrememberscharacterattributes.

QuickLinks add,applyTo,remove,removeAll

Hierarchy Object

CharacterStyle


characterAttributes CharacterAttributes readonly

name string r/w



Methods InstancesCharacterStyleadd()Addsanelement.

voidapplyTo(textItem:any[,clearingOverridesApplythecharacterstyletotextobject(s)Parameter Type Description

textItem any Thetextobject(s)toapplythestyle

to.

clearingOverrides bool Whethertoclearanytextattributesbeforeapplythestyle.(default:(Optional)



Return CharacterStyleCharacterStyle.add()CharacterStyleCharacterStyles.add(name:stringCharacterStyleCharacterStyles.getByName(


Contents::Index

Enumeration

FigureStyleType Thefigurestyletype.

Value Name

FigureStyleType.DEFAULTFIGURESTYLE

FigureStyleType.PROPORTIONAL

FigureStyleType.PROPORTIONALOLDSTYLE

FigureStyleType.TABULAR

FigureStyleType.TABULAROLDSTYLE

Usage AspropertyCharacterAttributes.figureStyle


Contents::Index

Enumeration

FirstBaselineType TextItemFirstbaselinetypes.

Value Name

FirstBaselineType.BASELINEASCENT

FirstBaselineType.BASELINECAPHEIGHT

FirstBaselineType.BASELINEEMBOXHEIGHT

FirstBaselineType.BASELINEFIXED

FirstBaselineType.BASELINELEADING

FirstBaselineType.BASELINELEGACY

FirstBaselineType.BASELINEXHEIGHT

Usage AspropertyTextFrameItem.firstBaseline


Contents::Index

Enumeration

FontBaselineOption Thefontbaselineoption.

Value Name

FontBaselineOption.NORMALBASELINE

FontBaselineOption.SUBSCRIPT

FontBaselineOption.SUPERSCRIPT

Usage AspropertyCharacterAttributes.baselinePosition


Contents::Index

Enumeration

FontCapsOption Thefontcapitalizationoption.


FontCapsOption.ALLCAPS Allcaps.

FontCapsOption.ALLSMALLCAPS Allsmallcaps.

FontCapsOption.NORMALCAPS Normalcaps.

FontCapsOption.SMALLCAPS Smallcaps.

Usage AspropertyCharacterAttributes.capitalization


Contents::Index

Enumeration

FontOpenTypePositionOption TheOpenTypefontpositionoption.

Value Name

FontOpenTypePositionOption.DENOMINATOR

FontOpenTypePositionOption.NUMERATOR

FontOpenTypePositionOption.OPENTYPEDEFAULT

FontOpenTypePositionOption.OPENTYPESUBSCRIPT

FontOpenTypePositionOption.OPENTYPESUPERSCRIPT

Usage AspropertyCharacterAttributes


Contents::Index

Class

InsertionPoint Alocationbetweencharacters,usedtoinsertnew

textobjects.

Hierarchy Object

InsertionPoint


characters Characters readonly Allthecharactersinthistextrange.

lines Lines readonly Allthelinesinthistextrange.

paragraphs Paragraphs readonly Alltheparagraphsinthistextrange.


story Story readonly Thestoryofthetextrange.

textRanges TextRangesTextRange

readonly Allthetextinthistextrange.


words Words readonly Allthe

wordsinthistextrange.

Return InsertionPointInsertionPoints.getByName(name:string)


Contents::Index

Enumeration

KinsokuOrderEnum ThepreferredKinsokuorder.

Value Name

KinsokuOrderEnum.PUSHIN

KinsokuOrderEnum.PUSHOUTFIRST

KinsokuOrderEnum.PUSHOUTONLY

Usage AspropertyParagraphAttributes.kinsokuOrder


Contents::Index

Enumeration

LanguageType Thelanguageoftext.

Value Name

LanguageType.BOKMALNORWEGIAN

LanguageType.BRAZILLIANPORTUGUESE

LanguageType.BULGARIAN

LanguageType.CANADIANFRENCH

LanguageType.CATALAN

LanguageType.CHINESE

LanguageType.CZECH

LanguageType.DANISH

LanguageType.DUTCH

LanguageType.DUTCH2005REFORM

LanguageType.ENGLISH

LanguageType.FINNISH

LanguageType.GERMAN2006REFORM

LanguageType.GREEK

LanguageType.HUNGARIAN

LanguageType.ICELANDIC

LanguageType.ITALIAN

LanguageType.JAPANESE

LanguageType.NYNORSKNORWEGIAN

LanguageType.OLDGERMAN

LanguageType.POLISH

LanguageType.RUMANIAN

LanguageType.RUSSIAN

LanguageType.SERBIAN

LanguageType.SPANISH

LanguageType.STANDARDFRENCH

LanguageType.STANDARDGERMAN

LanguageType.STANDARDPORTUGUESE

LanguageType.SWEDISH

LanguageType.SWISSGERMAN

LanguageType.SWISSGERMAN2006REFORM

LanguageType.TURKISH

LanguageType.UKENGLISH

LanguageType.UKRANIAN

Usage AspropertyCharacterAttributes.language


Contents::Index

Class

ParagraphAttributes Propertiesofaparagraph.

Hierarchy

Properties Property

autoLeadingAmount

bunriKinshi

burasagariType

desiredGlyphScaling

desiredLetterSpacing

desiredWordSpacing

everyLineComposer

firstLineIndent

hyphenateCapitalizedWords

hyphenation

hyphenationPreference

hyphenationZone

justification

kinsoku

kinsokuOrder

kurikaeshiMojiShori

leadingType

leftIndent

maximumConsecutiveHyphens

maximumGlyphScaling

maximumLetterSpacing

maximumWordSpacing

minimumAfterHyphen

minimumBeforeHyphen

minimumGlyphScaling

minimumHyphenatedWordSize

minimumLetterSpacing

minimumWordSpacing

mojikumi

parent

rightIndent

romanHanging

singleWordJustification

spaceAfter

spaceBefore

tabStops

typename

Elementof ParagraphStyle.paragraphAttributesTextRange.paragraphAttributes


Contents::Index

Class

ParagraphStyle Anamedstylethatremembersparagraphattributes.

QuickLinks add,applyTo,remove,removeAll

Hierarchy Object

ParagraphStyle


characterAttributes CharacterAttributes readonly

name string r/w

paragraphAttributes ParagraphAttributes readonly



Methods InstancesParagraphStyleadd()Addsanelement.

voidapplyTo(textItem:any[,clearingOverridesApplytheparagraphstyletotextobject(s)Parameter Type Description

textItem any Thetextobject(s)toapplythestyleto.

clearingOverrides bool Whethertoclearanytextattributesbeforeapplythestyle.(default:(Optional)



Return ParagraphStyleParagraphStyle.add()ParagraphStyleParagraphStyles.add(name:ParagraphStyleParagraphStyles.getByName


Contents::Index

Class

Story Acontiguousblockoftext.

Hierarchy Object

Story



insertionPoints InsertionPointsInsertionPoint

readonly Alltheinsertionpointsinthistextrange.

length Int32 readonly Thenumberofcharactersinthestory.




textFrames TextFrameItemsTextFrameItem

readonly Thetextframeitemsinthisstory.

textRange TextRange readonly Thetextrangeofthestory.




readonly Theselectedtext(ranges)inthestory.


words Words readonly Allthewordsinthistextrange.

Elementof

InsertionPoint.storyTextFrameItem.storyTextRange.story

Return StoryStories.getByName(name:string)


Contents::Index

Enumeration

StyleRunAlignmentType Thestylerunalignment.

Value Name

StyleRunAlignmentType.ROMANBASELINE

StyleRunAlignmentType.bottom

StyleRunAlignmentType.center

StyleRunAlignmentType.icfBottom

StyleRunAlignmentType.icfTop

StyleRunAlignmentType.top

Usage AspropertyCharacterAttributes.alignment


Contents::Index

Class

TextPath Atextpathitem.

QuickLinks setEntirePath

Hierarchy Object

TextPath


area number

blendingMode BlendModes:BlendModes.NORMALBlendModes.MULTIPLYBlendModes.SCREENBlendModes.OVERLAYBlendModes.SOFTLIGHTBlendModes.HARDLIGHTBlendModes.COLORDODGEBlendModes.COLORBURNBlendModes.DARKENBlendModes.LIGHTENBlendModes.DIFFERENCEBlendModes.EXCLUSIONBlendModes.HUEBlendModes.SATURATIONBLENDBlendModes.COLORBLENDBlendModes.LUMINOSITY

clipping bool

closed bool

editable bool

evenodd bool

fillColor Color

fillOverprint bool

filled bool

guides bool

height number(range:0.0-16348.0)

left number

note string

opacity number(range:0.0-100.0)

parent Object

pathPoints PathPoints PathPoint

polarity PolarityValues:PolarityValues.POSITIVEPolarityValues.NEGATIVE

position Point

resolution number

selectedPathPoints ObjectArray

strokeCap StrokeCap:StrokeCap.BUTTENDCAPStrokeCap.ROUNDENDCAPStrokeCap.PROJECTINGENDCAP

strokeColor Color

strokeDashOffset number

strokeDashes Arrayofnumber

strokeJoin StrokeJoin:StrokeJoin.MITERENDJOINStrokeJoin.ROUNDENDJOINStrokeJoin.BEVELENDJOIN

strokeMiterLimit number

strokeOverprint bool

strokeWidth number

stroked bool

top number

typename string

width number(range:0.0-16348.0)

Methods InstancesvoidsetEntirePath(pathPoints:Arrayofany)Setthepathusingtheprovidedarrayofanchorpoints.Parameter Type Description

pathPoints Arrayofany Arrayofanchorvaluesforthepathpoints.

Elementof TextFrameItem.textPath


Contents::Index

Class

TextRange Arangeofcharactersfromatextitem.

QuickLinks changeCaseTo,deSelect,duplicate,move,remove,removeAllselect

Hierarchy Object

TextRange


characterAttributes CharacterAttributes readonly Thecharacterpropertiesforthetextrange.

characterOffset Int32 r/w Offsetofthefirstcharacteroftherangefromthebeginningofthestory,incharacters.

characterStyles CharacterStylesCharacterStyle

readonly Listofreferencedcharacterstylesinthetextrange.


contents string r/w Thetextstring.

insertionPoints InsertionPointsInsertionPoint

readonly Alltheinsertionpointsinthistextrange.

kerning Int32 r/w Controlsthespacingbetweentwocharacters(inmilli-ems)

length Int32(min:0) r/w Lengthoftextrange.


paragraphAttributes ParagraphAttributes readonly Theparagraphpropertiesforthetextrange.

paragraphStyles ParagraphStylesParagraphStyle

readonly Listofreferencedparagraphstylesinthetextrange.


parent Object readonly Theobject's

container.

story Story readonly Thestoryofthetextrange.




readonly Theselectedtext(ranges)inthetextrange.


words Words readonly Allthewordsinthistextrange.

Methods InstancesvoidchangeCaseTo(type:CaseChangeType)Changethecapitalizationoftext.Parameter Type Description

type CaseChangeType:CaseChangeType.UPPERCASECaseChangeType.LOWERCASECaseChangeType.TITLECASECaseChangeType.SENTENCECASE

Thetypeofcase.

voiddeSelect()Deselectthetextrange.

TextRangeduplicate(relativeObject:Object,insertionLocationElementPlacement)

Duplicatethisobject.Parameter Type Description



TextRangemove(relativeObject:Object,insertionLocationElementPlacement)Movetheobject.Parameter Type Description





voidselect([addToDocument:bool=false])Selectthetextrange.Parameter Type Description

addToDocument bool Whethertoaddthetextrangetothedocumenttextselection.(default:(Optional)

Elementof Story.textRangeStory.textSelectionTextFrameItem.textRangeTextFrameItem.textSelectionTextRange.textSelection

Return TextRangeCharacters.add(contents:string)TextRangeCharacters.addBefore(contents:string)TextRangeCharacters.getByName(name:string)TextRangeLines.getByName(name:string)TextRangeParagraphs.add(contents:string)TextRangeParagraphs.addBefore(contents:string)

TextRangeParagraphs.getByName(name:string)TextRangeTextRange.duplicate(relativeObject:Object

insertionLocation:ElementPlacement)TextRangeTextRange.move(relativeObject:Object,

insertionLocation:ElementPlacement)TextRangeTextRanges.getByName(name:string)TextRangeWords.add(contents:string)TextRangeWords.addBefore(contents:string)TextRangeWords.getByName(name:string)


Contents::Index

Enumeration

WariChuJustificationType TheWari-Chualignmenttype.

Value Name

WariChuJustificationType.Center

WariChuJustificationType.Left

WariChuJustificationType.Right

WariChuJustificationType.WARICHUAUTOJUSTIFY

WariChuJustificationType.WARICHUFULLJUSTIFY

WariChuJustificationType.WARICHUFULLJUSTIFYLASTLINECENTER

WariChuJustificationType.WARICHUFULLJUSTIFYLASTLINELEFT

WariChuJustificationType.WARICHUFULLJUSTIFYLASTLINERIGHT

Usage AspropertyCharacterAttributes.wariChuJustification


Contents::Index

Class

Matrix


mValueA number r/w

mValueB number r/w

mValueC number r/w

mValueD number r/w

mValueTX number r/w

mValueTY number r/w

Elementof GradientColor.matrixPatternColor.matrixPlacedItem.matrixRasterItem.matrixTextFrameItem.matrix

Usedin: MatrixApplication.concatenateMatrix(matrix:Matrix,secondMatrix:Matrix)

MatrixApplication.concatenateRotationMatrix(matrix:Matrix,angle:number)

MatrixApplication.concatenateScaleMatrix(matrix:Matrix[,scaleX:number=100.0][,scaleY:number=100.0])

MatrixApplication.concatenateTranslationMatrix(matrix:Matrix[,deltaX:number=0.0][,deltaY:number=0.0])

MatrixApplication.invertMatrix(matrix:Matrix)boolApplication.isEqualMatrix(matrix:Matrix,

secondMatrix:Matrix)boolApplication.isSingularMatrix(matrix:Matrix)voidPageItem.transform(transformationMatrix:Matrix[,

changePositions:bool=true][,changeFillPatterns:bool=true][,changeFillGradients:bool=true][,changeStrokePattern:bool=true][,changeLineWidths:number=100.0][,transformAbout:

Transformation=Transformation.CENTER])

Return MatrixApplication.concatenateMatrix(matrix:Matrix,secondMatrix:Matrix)

MatrixApplication.concatenateRotationMatrix(matrix:Matrix,angle:number)

MatrixApplication.concatenateScaleMatrix(matrix:Matrix[,scaleX:number=100.0][,scaleY:number=100.0])

MatrixApplication.concatenateTranslationMatrix(matrix:Matrix[,deltaX:number=0.0][,deltaY:number=0.0])

MatrixApplication.getIdentityMatrix()MatrixApplication.getRotationMatrix([angle:number=0.0])MatrixApplication.getScaleMatrix([scaleX:number=100.0]

[,scaleY:number=100.0])MatrixApplication.getTranslationMatrix([deltaX:

number=0.0][,deltaY:number=0.0])MatrixApplication.invertMatrix(matrix:Matrix)


Contents::Index

Enumeration

LibraryType Illustratorlibrarytypes.


LibraryType.BRUSHES Illustratorbrusheslibrary.

LibraryType.GRAPHICSTYLES Illustratorgraphicstyleslibrary.

LibraryType.ILLUSTRATORARTWORK Illustratorartwork.

LibraryType.SWATCHES Illustratorswatcheslibrary.

LibraryType.SYMBOLS Illustratorsymbolslibrary.

Usage AspropertyOpenOptions.openAs


Contents::Index

Class

OpenOptions Optionswhichmaybesuppliedwhenopeningafile.

Class Property Type

convertCropAreaToArtboard bool

convertTilesToArtboard bool

createArtboardWithArtworkBoundingBox bool

openAs LibraryTypeLibraryType.ILLUSTRATORARTWORKLibraryType.SWATCHESLibraryType.BRUSHESLibraryType.GRAPHICSTYLESLibraryType.SYMBOLS

preserveLegacyArtboard bool

updateLegacyGradientMesh bool

updateLegacyText bool


v3.0.3i

Class

OpenOptionsAutoCAD OptionswhichmaybesuppliedwhenopeningaAutoCADfile.

Hierarchy


centerArtwork bool

globalScaleOption AutoCADGlobalScaleOptionAutoCADGlobalScaleOption.OriginalSizeAutoCADGlobalScaleOption.FitArtboardAutoCADGlobalScaleOption.ScaleByValue

globalScalePercent number

mergeLayers bool

parent Object

scaleLineweights bool

selectedLayoutName string

typename string

unit AutoCADUnitAutoCADUnit.PointsAutoCADUnit.PicasAutoCADUnit.InchesAutoCADUnit.MillimetersAutoCADUnit.CentimetersAutoCADUnit.Pixels

unitScaleRatio number

Elementof Preferences.AutoCADFileOptions


Contents::Index

Class

OpenOptionsPDF OptionswhichmaybesuppliedwhenopeningaPDFfile.

Hierarchy Object

OpenOptionsPDF


pDFCropToBox PDFBoxType:PDFBoxType.PDFARTBOXPDFBoxType.PDFCROPBOXPDFBoxType.PDFTRIMBOXPDFBoxType.PDFBLEEDBOXPDFBoxType.PDFMEDIABOXPDFBoxType.PDFBOUNDINGBOX

pageToOpen Int32

parent Object

typename string

Elementof Preferences.PDFFileOptions


Contents::Index

Class

OpenOptionsPhotoshop Optionswhichareappliedwhenopeningorplacinga

Photoshopfile.

Hierarchy Object

OpenOptionsPhotoshop


layerComp string

parent Object

preserveHiddenLayers bool

preserveImageMaps bool

preserveLayers bool

preserveSlices bool

typename string

Elementof Preferences.photoshopFileOptions


Contents::Index

Class

EPSSaveOptions OptionswhichmaybesuppliedwhensavingadocumentasanIllustratorEPSfile.

Class Property Type

artboardRange string

cmykPostScript bool

compatibility CompatibilityCompatibility.ILLUSTRATOR3Compatibility.JAPANESEVERSION3Compatibility.ILLUSTRATOR8Compatibility.ILLUSTRATOR9Compatibility.ILLUSTRATOR10Compatibility.ILLUSTRATOR11Compatibility.ILLUSTRATOR12Compatibility.ILLUSTRATOR13Compatibility.ILLUSTRATOR14Compatibility.ILLUSTRATOR15Compatibility.ILLUSTRATOR16

compatibleGradientPrinting bool

embedAllFonts bool

embedLinkedFiles bool

flattenOutput OutputFlatteningOutputFlattening.PRESERVEPATHSOutputFlattening.PRESERVEAPPEARANCE

includeDocumentThumbnails bool

overprint PDFOverprintPDFOverprint.PRESERVEPDFOVERPRINTPDFOverprint.DISCARDPDFOVERPRINT

postScript EPSPostScriptLevelEnumEPSPostScriptLevelEnum.LEVEL2EPSPostScriptLevelEnum.LEVEL3

preview EPSPreviewEPSPreview.NoneEPSPreview.BWMACINTOSHEPSPreview.COLORMACINTOSHEPSPreview.BWTIFFEPSPreview.COLORTIFFEPSPreview.TRANSPARENTCOLORTIFF

saveMultipleArtboards bool


Contents::Index

Class

FXGSaveOptions OptionswhichmaybesuppliedwhensavingadocumentasanFXGfile.

Class Property Type


blendsPolicy BlendsExpandPolicyBlendsExpandPolicy.AUTOMATICALLYCONVERTBLENDSBlendsExpandPolicy.RASTERIZEBLENDS

downsampleLinkedImages bool

filtersPolicy FiltersPreservePolicyFiltersPreservePolicy.EXPANDFILTERSFiltersPreservePolicy.RASTERIZEFILTERSFiltersPreservePolicy.KEEPFILTERSEDITABLE

gradientsPolicy GradientsPreservePolicyGradientsPreservePolicy.KEEPGRADIENTSEDITABLEGradientsPreservePolicy.AUTOMATICALLYCONVERTGRADIENTS

includeMetadata bool

includeUnusedSymbols bool

preserveEditingCapabilities bool


textPolicy TextPreservePolicyTextPreservePolicy.OUTLINETEXTTextPreservePolicy.RASTERIZETEXTTextPreservePolicy.KEEPTEXTEDITABLETextPreservePolicy.AUTOMATICALLYCONVERTTEXT

version FXGVersionFXGVersion.VERSION1PT0FXGVersion.VERSION2PT0


Contents::Index

Class

IllustratorSaveOptions OptionswhichmaybesuppliedwhensavingadocumentasanIllustratorfile.

Class Property Type


compatibility CompatibilityCompatibility.ILLUSTRATOR3Compatibility.JAPANESEVERSION3Compatibility.ILLUSTRATOR8Compatibility.ILLUSTRATOR9Compatibility.ILLUSTRATOR10Compatibility.ILLUSTRATOR11Compatibility.ILLUSTRATOR12Compatibility.ILLUSTRATOR13Compatibility.ILLUSTRATOR14Compatibility.ILLUSTRATOR15Compatibility.ILLUSTRATOR16

compressed bool

embedICCProfile bool

embedLinkedFiles bool

flattenOutput OutputFlatteningOutputFlattening.PRESERVEPATHSOutputFlattening.PRESERVEAPPEARANCE

fontSubsetThreshold number

pdfCompatible bool



Contents::Index

Class

PDFSaveOptions OptionswhichmaybesuppliedwhensavingadocumentasaPDFfile.

Class Property

acrobatLayers

artboardRange

bleedLink

bleedOffsetRect

colorBars

colorCompression

colorConversionID

colorDestinationID

colorDownsampling

colorDownsamplingImageThreshold

colorDownsamplingMethod

colorProfileID

colorTileSize

compatibility

compressArt

documentPassword

enableAccess

enableCopy

enableCopyAccess

enablePlainText

flattenerOptions

flattenerPreset

fontSubsetThreshold

generateThumbnails

grayscaleCompression

grayscaleDownsampling

grayscaleDownsamplingImageThreshold

grayscaleDownsamplingMethod

grayscaleTileSize

monochromeCompression

monochromeDownsampling

monochromeDownsamplingImageThreshold

monochromeDownsamplingMethod

offset

optimization

outputCondition

outputConditionID

outputIntentProfile

pDFAllowPrinting

pDFChangesAllowed

pDFPreset

pDFXStandard

pDFXStandardDescription

pageInformation

pageMarksType

permissionPassword

preserveEditability

printerResolution

registrationMarks

registryName

requireDocumentPassword

requirePermissionPassword

trapped

trimMarkWeight

trimMarks

viewAfterSaving


Contents::Index

Enumeration

ColorDitherMethod MethodusedtodithercolorsforPNG8andGIFexportformats.

Value Name

ColorDitherMethod.DIFFUSION

ColorDitherMethod.NOISE

ColorDitherMethod.NOREDUCTION

ColorDitherMethod.PATTERNDITHER

Usage AspropertyExportOptionsGIF.colorDitherExportOptionsPNG8.colorDither


Contents::Index

Enumeration

ColorReductionMethod MethodusedtoreducecolorforPNG8andGIFexportformats.

Value Name

ColorReductionMethod.ADAPTIVE

ColorReductionMethod.PERCEPTUAL

ColorReductionMethod.SELECTIVE

ColorReductionMethod.WEB

Usage AspropertyExportOptionsGIF.colorReductionExportOptionsPNG8.colorReduction


Contents::Index

Enumeration

DocumentType Savabledocumenttypes.


DocumentType.EPS EPSfileformat.

DocumentType.FXG FXGfileformat.

DocumentType.ILLUSTRATOR Illustratorfileformat.

DocumentType.PDF AcrobatPDFfileformat.

Usage


Contents::Index

Class

ExportOptionsAutoCAD OptionswhichmaybesuppliedwhenexportingadocumenttoAutoCADformats(.dwgor.dxf)

Class Property

alterPathsForAppearance

colors

convertTextToOutlines

exportFileFormat

exportOption

exportSelectedArtOnly

rasterFormat

scaleLineweights

unit

unitScaleRatio

version


Contents::Index

Class

ExportOptionsFlash OptionswhichmaybesuppliedwhenexportingadocumentasanFlash(.SWF)file.

Class Property Type

artClipping ArtClippingOptionArtClippingOption.OUTPUTARTBOUNDSArtClippingOption.OUTPUTARTBOARDBOUNDSArtClippingOption.OUTPUTCROPRECTBOUNDS


backgroundColor RGBColor

backgroundLayers ArrayofLayer

blendAnimation BlendAnimationTypeBlendAnimationType.NOBLENDANIMATIONBlendAnimationType.INSEQUENCEBlendAnimationType.INBUILD

compressed bool


curveQuality Int32(range:0-10)

exportAllSymbols bool

exportStyle FlashExportStyleFlashExportStyle.ARTBOARDSTOFILESFlashExportStyle.ASFLASHFILEFlashExportStyle.LAYERSASFRAMES

FlashExportStyle.LAYERSASFILESFlashExportStyle.LAYERSASSYMBOLS

exportVersion FlashExportVersionFlashExportVersion.FLASHVERSION1FlashExportVersion.FLASHVERSION2FlashExportVersion.FLASHVERSION3FlashExportVersion.FLASHVERSION4FlashExportVersion.FLASHVERSION5FlashExportVersion.FLASHVERSION6FlashExportVersion.FLASHVERSION7FlashExportVersion.FLASHVERSION8FlashExportVersion.FLASHVERSION9

frameRate number(range:0.01-120)

ignoreTextKerning bool

imageFormat FlashImageFormatFlashImageFormat.LOSSLESSFlashImageFormat.LOSSY

includeMetadata bool

jpegMethod FlashJPEGMethodFlashJPEGMethod.StandardFlashJPEGMethod.Optimized

jpegQuality Int32(range:0-10)

layerOrder LayerOrderTypeLayerOrderType.BOTTOMUPLayerOrderType.TOPDOWN

looping bool

playbackAccess FlashPlaybackSecurityFlashPlaybackSecurity.PlaybackLocalFlashPlaybackSecurity.PlaybackNetwork

preserveAppearance bool

readOnly bool

replacing SaveOptionsSaveOptions.SAVECHANGESSaveOptions.DONOTSAVECHANGESSaveOptions.PROMPTTOSAVECHANGES

resolution number(range:72-2400)



Contents::Index

Class

ExportOptionsGIF OptionswhichmaybesuppliedwhenexportingadocumentasaGIFfile.

Class Property Type

antiAliasing bool

artBoardClipping bool

colorCount Int32(range:2-256)

colorDither ColorDitherMethodColorDitherMethod.NOREDUCTIONColorDitherMethod.DIFFUSIONColorDitherMethod.PATTERNDITHERColorDitherMethod.NOISE

colorReduction ColorReductionMethodColorReductionMethod.SELECTIVEColorReductionMethod.ADAPTIVEColorReductionMethod.PERCEPTUALColorReductionMethod.WEB

ditherPercent Int32(range:0-100)


infoLossPercent Int32(range:0-100)

interlaced bool

matte bool

matteColor RGBColor

saveAsHTML bool

transparency bool


webSnap Int32(range:0-100)


Contents::Index

Class

ExportOptionsJPEG Optionswhichmaybesuppliedwhenexportinga

documentasaJPEGfile.


antiAliasing bool r/w

artBoardClipping bool r/w

blurAmount number(range:0.0-2.0)

r/w

horizontalScale number(range:0.0-776.19)

r/w

matte bool r/w

matteColor RGBColor r/w

optimization bool r/w

qualitySetting Int32(range:0.0-100.0)

r/w

saveAsHTML bool r/w

verticalScale number(range:0.0-776.19)

r/w


Contents::Index

Class

ExportOptionsPNG24 Optionswhichmaybesuppliedwhenexportinga

documentasan24bitPNGfile.

Class Property Type

antiAliasing bool



matte bool

matteColor RGBColor

saveAsHTML bool

transparency bool



Contents::Index

Class

ExportOptionsPNG8 Optionswhichmaybesuppliedwhenexportingadocumentasan8bitPNGfile.

Class Property Type

antiAliasing bool


colorCount Int32(range:2-256)

colorDither ColorDitherMethodColorDitherMethod.NOREDUCTIONColorDitherMethod.DIFFUSIONColorDitherMethod.PATTERNDITHERColorDitherMethod.NOISE

colorReduction ColorReductionMethodColorReductionMethod.SELECTIVEColorReductionMethod.ADAPTIVEColorReductionMethod.PERCEPTUALColorReductionMethod.WEB

ditherPercent Int32(range:0-100)


interlaced bool

matte bool

matteColor RGBColor

saveAsHTML bool

transparency bool


webSnap Int32(range:0-100)


Contents::Index

Class

ExportOptionsPhotoshop OptionswhichmaybesuppliedwhenexportingadocumentasaPhotoshopfile.

Class Property

antiAliasing

artboardRange

editableText

embedICCProfile

imageColorSpace

maximumEditability

resolution

saveMultipleArtboards

warnings

writeLayers


Contents::Index

Class

ExportOptionsSVG OptionswhichmaybesuppliedwhenexportingadocumentasanSVGfile.

Class Property Type

DTD SVGDTDVersionSVGDTDVersion.SVG1_0SVGDTDVersion.SVG1_1SVGDTDVersion.SVGTINY1_1SVGDTDVersion.SVGTINY1_1PLUSSVGDTDVersion.SVGBASIC1_1SVGDTDVersion.SVGTINY1_2

compressed bool

coordinatePrecision Int32(range:1-7)

cssProperties SVGCSSPropertyLocationSVGCSSPropertyLocation.ENTITIESSVGCSSPropertyLocation.STYLEATTRIBUTESSVGCSSPropertyLocation.STYLEELEMENTSSVGCSSPropertyLocation.PRESENTATIONATTRIBUTES

documentEncoding SVGDocumentEncodingSVGDocumentEncoding.ASCIISVGDocumentEncoding.UTF8SVGDocumentEncoding.UTF16

embedRasterImages bool

fontSubsetting SVGFontSubsettingSVGFontSubsetting.NoneSVGFontSubsetting.GLYPHSUSEDSVGFontSubsetting.COMMONENGLISHSVGFontSubsetting.GLYPHSUSEDPLUSENGLISHSVGFontSubsetting.COMMONROMANSVGFontSubsetting.GLYPHSUSEDPLUSROMAN

SVGFontSubsetting.ALLGLYPHS

fontType SVGFontTypeSVGFontType.CEFFONTSVGFontType.SVGFONTSVGFontType.OUTLINEFONT

includeFileInfo bool

includeVariablesAndDatasets bool

optimizeForSVGViewer bool

preserveEditability bool

sVGAutoKerning bool

sVGTextOnPath bool

slices bool


Contents::Index

Class

ExportOptionsTIFF OptionswhichmaybesuppliedwhenexportingadocumentasaTIFFfile.

Class Property Type

antiAliasing AntiAliasingMethodAntiAliasingMethod.NoneAntiAliasingMethod.ARTOPTIMIZEDAntiAliasingMethod.TYPEOPTIMIZED


byteOrder TIFFByteOrderTIFFByteOrder.IBMPCTIFFByteOrder.MACINTOSH

embedICCProfile bool

imageColorSpace ImageColorSpaceImageColorSpace.GrayScaleImageColorSpace.RGBImageColorSpace.CMYKImageColorSpace.LABImageColorSpace.SeparationImageColorSpace.DeviceNImageColorSpace.Indexed

lZWCompression bool




Contents::Index

Enumeration

ExportType Exportfiletypes.


ExportType.AUTOCAD AutoCADexportfileformat.

int8

ExportType.FLASH Flashexportfileformat.

int7

ExportType.GIF GIFexportfileformat.

int6

ExportType.JPEG JPEGexportfileformat.

int1

ExportType.PHOTOSHOP Photoshopexportfileformat.

int2

ExportType.PNG24 PNG24-bitexportfileformat.

int5

ExportType.PNG8 PNG8-bitexportfileformat.

int4

ExportType.SVG SVGexportfileformat.

int3

ExportType.TIFF TIFFexportfileformat.

int9

Usage InfunctionvoidDocument.exportFile(exportFile:File,

exportFormat:ExportType[,options:any])


Contents::Index

Class

ImageCaptureOptions Optionswhichmaybesuppliedwhencapturinga

portionoftheartworkasan24bitPNGfile.


antiAliasing bool r/w

matte bool r/w

matteColor RGBColor r/w


r/w

transparency bool r/w

Usedin: voidDocument.imageCapture(clipBounds:Rectangle][,optionsImageCaptureOptions])


Contents::Index

Class

DataSet Asetofvariablesandtheirassociateddynamicdatawhich

willbeusedfordynamicpublishing.

QuickLinks display,remove,removeAll,update

Hierarchy Object

DataSet


name string r/w Thenameofthisdataset.



Methods Instancesvoiddisplay()Displaysthedynamicdatathathasbeencapturedinthedataset.



voidupdate()Re-applythedynamicdataoftheactivedatasettotheartboard.

Elementof Document.activeDataSet

Return DataSetDataSets.add()DataSetDataSets.getByName(name:string)


v3.0.3i

Class

Variable Dynamicobjectusedtocreatedata-drivengraphics.


Hierarchy Object

Variable


kind VariableKind:VariableKind.UnknownVariableKind.VISIBILITYVariableKind.TEXTUALVariableKind.IMAGEVariableKind.GRAPH

r/w Thevariable'stype.

name string r/w Thenameofthisvariable.

pageItems PageItems PageItem readonly Alltheartworkinthisdocument.




voidremoveAll()

Deletesallelements.

Return VariableVariables.add()VariableVariables.getByName(name:string)


Contents::Index

Enumeration

FontSubstitutionPolicy Thefontsubstitutionpolicy.

Value Name

FontSubstitutionPolicy.SUBSTITUTEDEVICE

FontSubstitutionPolicy.SUBSTITUTEOBLIQUE

FontSubstitutionPolicy.SUBSTITUTETINT

Usage AspropertyPrintFontOptions.fontSubstitution


Contents::Index

Class

Ink Printer'sink.


inkInfo InkInfo r/w Theinkinformation.

name string r/w Theink'sname.

Elementof Document.inkListPrintColorSeparationOptions.inkList


Contents::Index

Class

InkInfo Inkinformation.


angle number r/w

customColor Color r/w

density number(min:0) r/w

dotShape string r/w

frequency number(min:0) r/w

kind InkType:InkType.CYANINKInkType.MAGENTAINKInkType.YELLOWINKInkType.BLACKINKInkType.CUSTOMINK

r/w

printingStatus InkPrintStatus:InkPrintStatus.DISABLEINKInkPrintStatus.ENABLEINKInkPrintStatus.CONVERTINK

r/w

trapping TrappingType:TrappingType.NORMALTRAPPINGTrappingType.TRANSPARENTTrappingType.OPAQUETrappingType.IGNOREOPAQUE

r/w

trappingOrder Int32(min:1) r/w

Elementof Ink.inkInfo


Contents::Index

Enumeration

InkPrintStatus Theinkprintingstatus.


InkPrintStatus.CONVERTINK Converttoprocesscolorduringprint.

InkPrintStatus.DISABLEINK Disabletheinkduringprint.

InkPrintStatus.ENABLEINK Enabletheinkduringprint.

Usage AspropertyInkInfo.printingStatus


Contents::Index

Enumeration

InkType Theinktype.


InkType.BLACKINK Blackcolorink. int3

InkType.CUSTOMINK Customcolorink. int4

InkType.CYANINK Cyancolorink. int0

InkType.MAGENTAINK Magentacolorink. int1

InkType.YELLOWINK Yellowcolorink. int2

Usage AspropertyInkInfo.kind


Contents::Index

Class

PPDFile APPDfile.


PPDInfo PPDFileInfo r/w ThePPDfileinformation.

name string r/w ThePPDmodelname.

Elementof Application.PPDFileList


Contents::Index

Class

PPDFileInfo PPDfileinformation.


PPDFilePath File r/w

languageLevel string r/w

screenList ArrayofScreen r/w

screenSpotFunctionList ArrayofScreenSpotFunction

r/w

Elementof PPDFile.PPDInfo

Return PPDFileInfoApplication.getPPDFileInfo(name:string


Contents::Index

Enumeration

PageMarksTypes Thepagemarksstyletype.


PageMarksTypes.Japanese Japanesepagemarksstyle.

PageMarksTypes.Roman Romanpagemarksstyle.

Usage AspropertyPDFSaveOptions.pageMarksTypePrintPageMarksOptions.pageMarksType


Contents::Index

Class

Paper Papersize.


name string r/w Thepapername.

paperInfo PaperInfo r/w Thepaperinformation.

Elementof PrinterInfo.paperSizes


Contents::Index

Class

PaperInfo Paperinformation.


customPaper bool r/w Isitacustompaper?

height number r/w Thepaper'sheight(inpoints)

imageableArea Rectangle r/w Theimageablearea.

width number r/w Thepaper'swidth(inpoints)

Elementof Paper.paperInfo


Contents::Index

Enumeration

PostScriptImageCompressionType ThePostScriptimagecompressiontype.

Value Name

PostScriptImageCompressionType.IMAGECOMPRESSIONNONE

PostScriptImageCompressionType.JPEG

PostScriptImageCompressionType.RLE

Usage AspropertyPrintPostScriptOptions


Contents::Index

Enumeration

PrintArtworkDesignation Theartworklayers/objectstobeprinted.

Value Name

PrintArtworkDesignation.ALLLAYERS

PrintArtworkDesignation.VISIBLELAYERS

PrintArtworkDesignation.VISIBLEPRINTABLELAYERS

Usage AspropertyPrintJobOptions.designation


Contents::Index

Enumeration

PrintColorIntent Thecolorintenttype.

Value Name

PrintColorIntent.ABSOLUTECOLORIMETRIC

PrintColorIntent.PERCEPTUALINTENT

PrintColorIntent.RELATIVECOLORIMETRIC

PrintColorIntent.SATURATIONINTENT

Usage AspropertyPrintColorManagementOptions.intent


Contents::Index

Class

PrintColorManagementOptions Thecolormanagementoptions.

Class Property

colorProfileMode

intent

name

Elementof PrintOptions


Contents::Index

Enumeration

PrintColorProfile Thecolorprofiletype.

Value Name

PrintColorProfile.CUSTOMPROFILE

PrintColorProfile.OLDSTYLEPROFILE

PrintColorProfile.PRINTERPROFILE

PrintColorProfile.SOURCEPROFILE

Usage AspropertyPrintColorManagementOptions.colorProfileMode


Contents::Index

Enumeration

PrintColorSeparationMode Thecolorseparationmode.

Value Name

PrintColorSeparationMode.COMPOSITE

PrintColorSeparationMode.HOSTBASEDSEPARATION

PrintColorSeparationMode.INRIPSEPARATION

Usage AspropertyPrintColorSeparationOptions


Contents::Index

Class

PrintColorSeparationOptions Printcolorseparationoptions.

Class Property

colorSeparationMode

convertSpotColors

inkList

overPrintBlack

Elementof PrintOptions.colorSeparationOptions


Contents::Index

Class

PrintCoordinateOptions Theprintcoordinateoptions.

Class Property Type

emulsion bool

fitToPage bool

horizontalScale number(range:1-10000)

orientation PrintOrientationPrintOrientation.PORTRAITPrintOrientation.LANDSCAPEPrintOrientation.REVERSEPORTRAITPrintOrientation.REVERSELANDSCAPEPrintOrientation.AUTOROTATE

position PrintPositionPrintPosition.TRANSLATETOPLEFTPrintPosition.TRANSLATETOPPrintPosition.TRANSLATETOPRIGHTPrintPosition.TRANSLATELEFTPrintPosition.TRANSLATECENTERPrintPosition.TRANSLATERIGHTPrintPosition.TRANSLATEBOTTOMLEFTPrintPosition.TRANSLATEBOTTOMPrintPosition.TRANSLATEBOTTOMRIGHT

tiling PrintTilingPrintTiling.TILESINGLEFULLPAGEPrintTiling.TILEFULLPAGESPrintTiling.TILEIMAGEABLEAREAS

verticalScale number(range:1-10000)

Elementof PrintOptions.coordinateOptions


Contents::Index

Class

PrintFlattenerOptions Thetransparencyflatteningoptions.

Class Property Type

clipComplexRegions bool

convertStrokesToOutlines bool


flatteningBalance Int32(range:0-100)

gradientResolution number

overprint PDFOverprintPDFOverprint.PRESERVEPDFOVERPRINTPDFOverprint.DISCARDPDFOVERPRINT

rasterizationResolution number

Elementof PDFSaveOptions.flattenerOptionsPrintOptions.flattenerOptions


Contents::Index

Enumeration

PrintFontDownloadMode Theprinterfontdownloadmode.

Value Name

PrintFontDownloadMode.DOWNLOADCOMPLETE

PrintFontDownloadMode.DOWNLOADNONE

PrintFontDownloadMode.DOWNLOADSUBSET

Usage AspropertyPrintFontOptions.downloadFonts


Contents::Index

Class

PrintFontOptions Thefontoptionsforprinting.

Class Property Type

downloadFonts PrintFontDownloadModePrintFontDownloadMode.DOWNLOADNONEPrintFontDownloadMode.DOWNLOADSUBSETPrintFontDownloadMode.DOWNLOADCOMPLETE

fontSubstitution FontSubstitutionPolicyFontSubstitutionPolicy.SUBSTITUTEOBLIQUEFontSubstitutionPolicy.SUBSTITUTETINTFontSubstitutionPolicy.SUBSTITUTEDEVICE

Elementof PrintOptions.fontOptions


Contents::Index

Class

PrintJobOptions Theprintjoboptions.

Class Property Type


bitmapResolution number(min:0)

collate bool

copies Int32(min:1)

designation PrintArtworkDesignationPrintArtworkDesignation.VISIBLEPRINTABLELAYERSPrintArtworkDesignation.VISIBLELAYERSPrintArtworkDesignation.ALLLAYERS

file File

name string

printAllArtboards bool

printArea PrintingBounds:PrintingBounds.ARTBOARDBOUNDSPrintingBounds.ARTWORKBOUNDSPrintingBounds.CROPBOUNDS

printAsBitmap bool

reversePages bool

Elementof PrintOptions.jobOptions


Contents::Index

Class

PrintOptions Theprintoptions.

Class Property Type

PPDName string

colorManagementOptions PrintColorManagementOptions

colorSeparationOptions PrintColorSeparationOptions

coordinateOptions PrintCoordinateOptions

flattenerOptions PrintFlattenerOptions

flattenerPreset string

fontOptions PrintFontOptions

jobOptions PrintJobOptions

pageMarksOptions PrintPageMarksOptions

paperOptions PrintPaperOptions

postScriptOptions PrintPostScriptOptions

printPreset string

printerName string

Usedin: voidDocument.print([options:PrintOptions])


Contents::Index

Enumeration

PrintOrientation Theartworkprintingorientation.

Value Name

PrintOrientation.AUTOROTATE

PrintOrientation.LANDSCAPE

PrintOrientation.PORTRAIT

PrintOrientation.REVERSELANDSCAPE

PrintOrientation.REVERSEPORTRAIT

Usage AspropertyPrintCoordinateOptions.orientation


Contents::Index

Class

PrintPageMarksOptions Thepagemarksoptions.

Class Property Type

bleedOffsetRect Rectangle

colorBars bool

marksOffsetRect Rectangle

pageInfoMarks bool

pageMarksType PageMarksTypesPageMarksTypes.RomanPageMarksTypes.Japanese

registrationMarks bool

trimMarks bool

trimMarksWeight number

Elementof PrintOptions.pageMarksOptions


Contents::Index

Class

PrintPaperOptions Thepaperoptions.


height number r/w Thecustomheight(inpoints)forusingthecustompaper.(default:

name string r/w Thepaper'sname.

offset number r/w Customoffset(inpoints)forusingthecustompaper.(default:

transverse bool r/w Whethertotransversetheartwork(rotate90degrees)onthecustompaper.(default:false)

width number r/w Thecustomwidth(inpoints)forusingthecustom

paper.(default:

Elementof PrintOptions.paperOptions


Contents::Index

Enumeration

PrintPosition Theartworkprintingpositiononmedia.


PrintPosition.TRANSLATEBOTTOM Translatetothebottomcenterofmedia.

PrintPosition.TRANSLATEBOTTOMLEFT Translatetothebottomleftofmedia.

PrintPosition.TRANSLATEBOTTOMRIGHT Translatetothebottomrightofmedia.

PrintPosition.TRANSLATECENTER Translatetothecenterofmedia.

PrintPosition.TRANSLATELEFT Translatetotheleftcenterofmedia.

PrintPosition.TRANSLATERIGHT Translatetotherightcenterofmedia.

PrintPosition.TRANSLATETOP Translatetothetopcenterofmedia.

PrintPosition.TRANSLATETOPLEFT Translateto

thetopleftofmedia.

PrintPosition.TRANSLATETOPRIGHT Translatetothetoprightofmedia.

Usage AspropertyPrintCoordinateOptions.position


Contents::Index

Class

PrintPostScriptOptions ThePostScriptoptions.

Class Property Type

binaryPrinting bool

compatibleShading bool

forceContinuousTone bool

imageCompression PostScriptImageCompressionTypePostScriptImageCompressionType.IMAGECOMPRESSIONNONEPostScriptImageCompressionType.RLEPostScriptImageCompressionType.JPEG

negativePrinting bool

postScriptLevel PrinterPostScriptLevelEnumPrinterPostScriptLevelEnum.PSLEVEL1PrinterPostScriptLevelEnum.PSLEVEL2PrinterPostScriptLevelEnum.PSLEVEL3

shadingResolution number

Elementof PrintOptions.postScriptOptions


Contents::Index

Enumeration

PrintTiling Thepagetilingtype.


PrintTiling.TILEFULLPAGES Tilefullpages.

PrintTiling.TILEIMAGEABLEAREAS Tileimageableareas.

PrintTiling.TILESINGLEFULLPAGE Tilesinglefullpage.

Usage AspropertyPrintCoordinateOptions.tiling


Contents::Index

Class

Printer Aninstalledprinter.


name string r/w Theprintername.

printerInfo PrinterInfo r/w Theprinterinformation.

Elementof Application.printerList


Contents::Index

Enumeration

PrinterColorMode Theprintercolormode.

Value Name

PrinterColorMode.BLACKANDWHITEPRINTER

PrinterColorMode.COLORPRINTER

PrinterColorMode.GRAYSCALEPRINTER

Usage AspropertyPrinterInfo.colorSupport


Contents::Index

Class

PrinterInfo Printerinformation.

Class Property Type

binaryPrintingSupport bool

colorSupport PrinterColorMode:PrinterColorMode.COLORPRINTERPrinterColorMode.GRAYSCALEPRINTERPrinterColorMode.BLACKANDWHITEPRINTER

customPaperSupport bool

customPaperTransverseSupport bool

deviceResolution number

inRIPSeparationSupport bool

maxDeviceResolution number

maxPaperHeight number

maxPaperHeightOffset number

maxPaperWidth number

maxPaperWidthOffset number

minPaperHeight number

minPaperHeightOffset number

minPaperWidth number

minPaperWidthOffset number

paperSizes ArrayofPaper

postScriptLevel PrinterPostScriptLevelEnumPrinterPostScriptLevelEnum.PSLEVEL1PrinterPostScriptLevelEnum.PSLEVEL2PrinterPostScriptLevelEnum.PSLEVEL3

printerType PrinterTypeEnum:PrinterTypeEnum.UnknownPrinterTypeEnum.POSTSCRIPTPRINTERPrinterTypeEnum.NONPOSTSCRIPTPRINTER

Elementof Printer.printerInfo


Contents::Index

Enumeration

PrinterTypeEnum Theprintertype.

Value Name

PrinterTypeEnum.NONPOSTSCRIPTPRINTER

PrinterTypeEnum.POSTSCRIPTPRINTER

PrinterTypeEnum.Unknown

Usage AspropertyPrinterInfo.printerType


Contents::Index

Enumeration

PrintingBounds Theprintingboundstype.


PrintingBounds.ARTBOARDBOUNDS Useartboardbounds.

PrintingBounds.ARTWORKBOUNDS Useartworkbounds.

PrintingBounds.CROPBOUNDS Usecropbounds.

Usage AspropertyPrintJobOptions.printArea


Contents::Index

Class

Screen Colorseparationscreen.


name string r/w Thecolorseparationscreenname.

screenInfo ScreenInfo r/w Thecolorseparationscreeninformation.

Elementof PPDFileInfo.screenList


Contents::Index

Class

ScreenInfo Screeninformation.


angle number r/w Thescreen'sangle(indegrees)

defaultScreen bool r/w Isitthedefaultscreen?

frequency number r/w Thescreen'sfrequency.

Elementof Screen.screenInfo


Contents::Index

Class

ScreenSpotFunction Colorseparationscreenspotfunction.


name string r/w Thecolorseparationscreenspotfunctionname.

spotFunction string r/w ThespotfunctionintermsofthePostScriptcommands.

Elementof PPDFileInfo.screenSpotFunctionList


Contents::Index

Enumeration

TrappingType Thetrappingtype.


TrappingType.IGNOREOPAQUE Ignoreopaquetrappingtype.

TrappingType.NORMALTRAPPING Normaltrappingtype.

TrappingType.OPAQUE Opaquetrappingtype.

TrappingType.TRANSPARENT Transparenttrappingtype.

Usage AspropertyInkInfo.trapping


Contents::Index

Enumeration

TracingColorType TheinputcolortypeFullColororLimitedcolors.

Value Name

TracingColorType.TRACINGFULLCOLOR

TracingColorType.TRACINGLIMITEDCOLOR

Usage AspropertyTracingOptions.tracingColorTypeValue


Contents::Index

Enumeration

TracingMethodType Thetracingmethod:abuttingandoverlapping.

Value Name

TracingMethodType.TRACINGMETHODABUTTING

TracingMethodType.TRACINGMETHODOVERLAPPING

Usage AspropertyTracingOptions.tracingMethod


Contents::Index

Enumeration

TracingModeType Thetracingmode:color,grayscale,blackandwhite.

Value Name

TracingModeType.TRACINGMODEBLACKANDWHITE

TracingModeType.TRACINGMODECOLOR

TracingModeType.TRACINGMODEGRAY

Usage AspropertyTracingOptions.tracingMode


Contents::Index

Class

TracingObject Atracingobject.

QuickLinks expandTracing,releaseTracing

Hierarchy Object

TracingObject


anchorCount Int32 readonly Thenumberofanchorsinthetracingresult.


pathCount Int32 readonly Thenumberofpathsinthetracingresult.

sourceArt PageItem readonly Thesourceartusedwhencreatinganewtracingobject.

tracingOptions TracingOptions readonly Theoptionsusedwhentracingtheartwork.

typename string readonly Theclassnameofthe

object.

usedColorCount Int32 readonly Thenumberofcolorsusedinthetracingresult.

Methods InstancesGroupItemexpandTracing([viewed:bool=falseExpandthetracingtopaths.Deletesthistracingobject.Parameter Type Description

viewed bool Expandasviewedwiththerasterandvectorviewmodes.(default:(Optional)

PageItemreleaseTracing()Releasethesourceartworkforthetracingobject.Deletesthistracingobject.

Elementof PluginItem.tracing


Contents::Index

Class

TracingOptions Tracingoptionsthatguidethetracingprocess.

QuickLinks loadFromPreset,storeToPreset

Hierarchy


colorFidelity number

colorGroup string

cornerFidelity number

fills bool

grayLevels Int32(range:1-256)

ignoreWhite bool

maxStrokeWeight number

noiseFidelity number

palette string

parent Object

pathFidelity number

preset string

snapCurveToLines bool

strokes bool

threshold Int32(range:1-256)

tracingColorTypeValue TracingColorType:TracingColorType.TRACINGLIMITEDCOLORTracingColorType.TRACINGFULLCOLOR

tracingColors Int32

tracingMethod TracingMethodType

TracingMethodType.TRACINGMETHODABUTTINGTracingMethodType.TRACINGMETHODOVERLAPPING

tracingMode TracingModeType:TracingModeType.TRACINGMODECOLORTracingModeType.TRACINGMODEGRAYTracingModeType.TRACINGMODEBLACKANDWHITE

typename string

viewMode ViewType:ViewType.TRACINGVIEWVECTORTRACINGRESULTViewType.TRACINGVIEWVECTOROUTLINESWITHTRACINGViewType.TRACINGVIEWVECTOROUTLINESViewType.TRACINGVIEWVECTORWITHTRANSPARENTIMAGEViewType.TRACINGVIEWIMAGE

Methods InstancesboolloadFromPreset(presetName:string)Loadoptionsfrompreset.Parameter Type

presetName string

boolstoreToPreset(presetName:string)StoreoptionstoapresetkAiVectorizeSuite.Willoverwriteanexisting(unlocked)presetifnamesmatch.Parameter Type

presetName string

Elementof TracingObject.tracingOptions


Contents::Index

Enumeration

ViewType Controlsthetypeofvectorview.

Value Name

ViewType.TRACINGVIEWIMAGE

ViewType.TRACINGVIEWVECTOROUTLINES

ViewType.TRACINGVIEWVECTOROUTLINESWITHTRACING

ViewType.TRACINGVIEWVECTORTRACINGRESULT

ViewType.TRACINGVIEWVECTORWITHTRANSPARENTIMAGE

Usage AspropertyTracingOptions.viewMode


Contents::Index

Class

ArtStyles Acollectionofartstyles.

SeealsoArtStyle.

QuickLinks getByName,removeAll

Hierarchy Object

ArtStyles


length int readonly Numberofelementsinthecollection.



Methods InstancesArtStylegetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.graphicStyles


Contents::Index

Class

Artboards Acollectionofartboards.

SeealsoArtboard.

QuickLinks add,getActiveArtboardIndex,getByName,getByName,insert,remove,removeAll,setActiveArtboardIndex

Hierarchy Object

Artboards





Methods ClassArtboardadd(artboardRect:Rectangle)Addartboardobject.Parameter Type Description

artboardRect Rectangle Sizeandpositionofartboard.

InstancesInt32getActiveArtboardIndex()Retrievestheindexpositionoftheactiveartboardinthedocument'slist.

ArtboardgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.


name string

ArtboardgetByName(artboardName:string)GetthefirstArtboardwithspecifiedname.Parameter Type Description

artboardName string Thenameoftheartboard.

voidinsert(artboardRect:Rectangle,index:Int32)InsertanArtboardatspecifiedlocation.Parameter Type Description

artboardRect Rectangle Sizeandpositionofartboard.

index Int32 Indexpositionwhereartboardshouldbeinserted.

voidremove(index:Int32)Deleteartboardobject.Parameter Type Description

index Int32 Indexofthecropareatobedeleted.


voidsetActiveArtboardIndex(index:Int32)Makesaspecificartboardactive,andmakesitcurrentintheiterationorder.Parameter Type Description

index Int32 The0-basedindexpositionoftheartboardinthedocumentlist.

Elementof Document.artboards


v3.0.3i

Class

Brushes Acollectionofbrushes.

QuickLinks getByName

Hierarchy Object

Brushes





Methods InstancesBrushgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.brushes


Contents::Index

Class

CharacterStyles Acollectionofcharacterstyles.

SeealsoCharacterStyle.

QuickLinks add,getByName,removeAll

Hierarchy Object

CharacterStyles





Methods ClassCharacterStyleadd(name:string)Createanamedcharacterstyle.Parameter Type Description

name string Thecharacterstylename.

InstancesCharacterStylegetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.characterStylesTextRange.characterStyles


Contents::Index

Class

Characters Acollectionofcharacters.

QuickLinks add,addBefore,getByName,removeAll

Hierarchy Object

Characters





Methods ClassTextRangeadd(contents:string)Createacharacter.Parameter Type Description

contents string Thetextstring.

TextRangeaddBefore(contents:string)Parameter Type Description


InstancesTextRangegetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof InsertionPoint.charactersStory.charactersTextFrameItem.charactersTextRange.characters


Contents::Index

Class

CompoundPathItems Acollectionofcompoundpathitems.

SeealsoCompoundPathItem.


Hierarchy Object

CompoundPathItems





Methods ClassCompoundPathItemadd()Createacompoundpathitem.

InstancesCompoundPathItemgetByNamestring)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

voidremoveAll()

Deletesallelements.

Elementof Document.compoundPathItemsGroupItem.compoundPathItemsLayer.compoundPathItems


Contents::Index

Class

DataSets Acollectionofdatasets.

SeealsoDataSet.


Hierarchy Object

DataSets





Methods ClassDataSetadd()Createadataset.

InstancesDataSetgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.dataSets

Jongware,25-

Nov-2012v3.0.3i Contents::Index

Class

Documents Acollectionofdocuments.

SeealsoDocument.

QuickLinks add,addDocument,getByName

Hierarchy Object

Documents





Methods ClassDocumentadd([documentColorSpace:DocumentColorSpacenumber=612.0][,height:number=792.0][,numArtboardsDocumentArtboardLayout=DocumentArtboardLayout.GridByRowartboardRowsOrCols:Int32=1])Adocument.Parameter Type


width number

height number

numArtboards Int32

artboardLayout DocumentArtboardLayout:DocumentArtboardLayout.GridByRowDocumentArtboardLayout.GridByColDocumentArtboardLayout.RowDocumentArtboardLayout.ColumnDocumentArtboardLayout.RLGridByRowDocumentArtboardLayout.RLGridByColDocumentArtboardLayout.RLRow



DocumentaddDocument(startupPreset:string,presetSettingsCreateadocumentfromthepreset.Parameter Type Description

startupPreset string Thenameofstartupdocumentpreset.

presetSettings DocumentPreset Thecustomdocumentpresetsettings.

InstancesDocumentgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type

name string

Elementof Application.documents


Contents::Index

Class

GradientStops Acollectionofgradientstops.

SeealsoGradientStop.


Hierarchy Object

GradientStops





Methods ClassGradientStopadd()Createagradientstop.

InstancesGradientStopgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Gradient.gradientStops


Contents::Index

Class

Gradients Acollectionofgradients.

SeealsoGradient.


Hierarchy Object

Gradients





Methods ClassGradientadd()Createagradient.

InstancesGradientgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.gradients

Jongware,25-


Class

GraphItems SeealsoGraphItem.


Hierarchy Object

GraphItems





Methods InstancesGraphItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.graphItemsGroupItem.graphItemsLayer.graphItems


Contents::Index

Class

GroupItems Acollectionofgroupitems.

SeealsoGroupItem.

QuickLinks add,createFromFile,getByName,removeAll

Hierarchy Object

GroupItems





Methods ClassGroupItemadd()Createagroupitem.

GroupItemcreateFromFile(imageFile:File)Createagroupitemfromavectorgraphicsfile.Parameter Type Description

imageFile File Thevectorgraphicsfiletobeembedded.

InstancesGroupItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.


name string


Elementof Document.groupItemsGroupItem.groupItemsLayer.groupItems


Contents::Index

Class

InsertionPoints Acollectionofinsertionpoints.

SeealsoInsertionPoint.


Hierarchy Object

InsertionPoints





Methods InstancesInsertionPointgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Story.insertionPointsTextFrameItem.insertionPointsTextRange.insertionPoints


v3.0.3i

Class

Layers Acollectionoflayers.

SeealsoLayer.


Hierarchy Object

Layers





Methods ClassLayeradd()Createalayer.

InstancesLayergetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.layersLayer.layers


Contents::Index

Class

LegacyTextItems Acollectionoflegacytextitems.

SeealsoLegacyTextItem.

QuickLinks convertToNative,getByName

Hierarchy Object

LegacyTextItems





Methods InstancesboolconvertToNative()Createtextframesfromalllegacytextitems.Theoriginallegacytextitemswillbedeleted.

LegacyTextItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.legacyTextItemsGroupItem.legacyTextItemsLayer.legacyTextItems


Contents::Index

Class

Lines Acollectionoflines.


Hierarchy Object

Lines





Methods InstancesTextRangegetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof InsertionPoint.linesStory.linesTextFrameItem.linesTextRange.lines


Contents::Index

Class

MeshItems SeealsoMeshItem.


Hierarchy Object

MeshItems





Methods InstancesMeshItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.meshItemsGroupItem.meshItemsLayer.meshItems


Contents::Index

Class

NonNativeItems SeealsoNonNativeItem.


Hierarchy Object

NonNativeItems





Methods InstancesNonNativeItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.nonNativeItemsGroupItem.nonNativeItemsLayer.nonNativeItems


Contents::Index

Class

PageItems Acollectionofpageitems.

SeealsoPageItem.


Hierarchy Object

PageItems





Methods InstancesPageItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.pageItemsGroupItem.pageItemsLayer.pageItemsVariable.pageItems


Contents::Index

Class

ParagraphStyles Acollectionofparagraphstyles.

SeealsoParagraphStyle.


Hierarchy Object

ParagraphStyles





Methods ClassParagraphStyleadd(name:string)Createanamedparagraphstyle.Parameter Type Description

name string Theparagraphstylename.

InstancesParagraphStylegetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.paragraphStylesTextRange.paragraphStyles


Contents::Index

Class

Paragraphs AcollectionofParagraphs.


Hierarchy Object

Paragraphs





Methods ClassTextRangeadd(contents:string)Createatextartitem.Parameter Type Description





name string


Elementof InsertionPoint.paragraphsStory.paragraphsTextFrameItem.paragraphsTextRange.paragraphs


Contents::Index

Class

PathItems Acollectionofpathitems.

SeealsoPathItem.

QuickLinks add,ellipse,getByName,polygon,rectangle,removeAll,roundedRectangle,star

Hierarchy Object

PathItems





Methods ClassPathItemadd()Createapath.

PathItemellipse([top:number=100][,left:number=100][,width:number=50][,height:number=100][,reversed:bool=false][,inscribed:bool=true])Createanellipticalpathitem.Parameter Type Description

top number Theellipse'sbounds.(default:100)(Optional)

left number Theellipse'sbounds.(default:100)(Optional)

width number Theellipse'sbounds.(default:

50)(Optional)

height number Theheightoftheellipse.(default:100)(Optional)

reversed bool Istheellipsepathreversed?(default:false)(Optional)

inscribed bool Istheellipsepathinscribed?(default:true)(Optional)

PathItempolygon([centerX:number=200][,centerY:number=300][,radius:number=50][,sides:Int32=8][,reversed:bool=false])Usedtocreatearegularpolygonpathitem.Notforpathitemaccess.Parameter Type Description

centerX number (default:200)(Optional)

centerY number (default:300)(Optional)

radius number Theradiusofthepolygonpoints.(default:50)(Optional)

sides Int32 Thenumberofsidesonthepolygon.(default:8)(Optional)

reversed bool Isthepolygonpathreversed?(default:false)(Optional)

PathItemrectangle(top:number,left:number,width:number,height:number[,reversed:bool=false])Usedtocreatearectangularpathitem.Notforpathitemaccess.Parameter Type Description

top number Thetopcoordinateoftherectangle'sbounds.

left number Theleftcoordinateoftherectangle'sbounds.

width number Thewidthoftherectangle.

height number Theheightoftherectangle.

reversed bool Istherectanglepathreversed?(default:false)(Optional)

PathItemroundedRectangle(top:number,left:number,width:number,height:number[,horizontalRadius:number=15][,verticalRadius:number=20][,reversed:bool=false])Usedtocreatearounded-cornerrectangularpathitem.Notforpathitemaccess.Parameter Type Description

top number

left number

width number

height number

horizontalRadius number Horizontalcornerradius.(default:15)(Optional)

verticalRadius number Verticalcornerradius.(default:20)(Optional)

reversed bool Istherectanglepathreversed?(default:false)(Optional)

PathItemstar([centerX:number=200][,centerY:number=300][,radius:number=50][,innerRadius:number=20][,points:Int32=5][,reversed:bool=false])Usedtocreateastar-shapedpathitem.Notforpathitemaccess.Parameter Type Description

centerX number (default:200)(Optional)

centerY number (default:300)(Optional)

radius number Theoutsideradiusofthestarpoints.(default:50)(Optional)

innerRadius number Theinsideradiusofthestarpoints.(default:20)(Optional)

points Int32 Thenumberofpointsonthestar.(default:5)(Optional)

reversed bool Isthestarpathreversed?(default:false)(Optional)

InstancesPathItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof CompoundPathItem.pathItemsDocument.pathItemsGroupItem.pathItemsLayer.pathItems


Contents::Index

Class

PathPoints Acollectionofpathpoints.

SeealsoPathPoint.


Hierarchy Object

PathPoints





Methods ClassPathPointadd()Createapathpoint.

InstancesPathPointgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof PathItem.pathPointsTextPath.pathPoints


Contents::Index

Class

Patterns Acollectionofpatterns.

SeealsoPattern.


Hierarchy Object

Patterns





Methods ClassPatternadd()Createapattern.

InstancesPatterngetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.patterns

Jongware,25-


Class

PlacedItems SeealsoPlacedItem.


Hierarchy Object

PlacedItems





Methods ClassPlacedItemadd()Createaplaceditem.

InstancesPlacedItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.placedItemsGroupItem.placedItems

Layer.placedItems


Contents::Index

Class

PluginItems SeealsoPluginItem.


Hierarchy Object

PluginItems





Methods InstancesPluginItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.pluginItemsGroupItem.pluginItemsLayer.pluginItems


Contents::Index

Class

RasterItems SeealsoRasterItem.


Hierarchy Object

RasterItems





Methods InstancesRasterItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.rasterItemsGroupItem.rasterItemsLayer.rasterItems


Contents::Index

Class

Spots Acollectionofcustomspotcolors.

SeealsoSpot.


Hierarchy Object

Spots





Methods ClassSpotadd()Createaspotcolor.

InstancesSpotgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.spots


Contents::Index

Class

Stories Acollectionofstories.

SeealsoStory.


Hierarchy Object

Stories





Methods InstancesStorygetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.stories


Contents::Index

Class

SwatchGroups AcollectionofSwatchgroups.

SeealsoSwatchGroup.


Hierarchy Object

SwatchGroups





Methods ClassSwatchGroupadd()CreateaSwatchgroup.

InstancesSwatchGroupgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.swatchGroups


Contents::Index

Class

Swatches Acollectionofswatches.

QuickLinks add,getByName,getSelected,removeAll

Hierarchy Object

Swatches





Methods ClassSwatchadd()Createaswatch.

InstancesSwatchgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

ArrayofSwatchgetSelected()Getselectedswatchesinthedocument.


Elementof Document.swatches


Contents::Index

Class

SymbolItems Acollectionofsymbolitems.

SeealsoSymbolItem.


Hierarchy Object

SymbolItems





Methods ClassSymbolItemadd(symbol:Symbol)Aninstanceofasymbolitem.Parameter Type Description

symbol Symbol Thesymboltomakeaninstanceof.

InstancesSymbolItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.symbolItemsGroupItem.symbolItemsLayer.symbolItems


Contents::Index

Class

Symbols Acollectionofsymbols.

SeealsoSymbol.


Hierarchy


length int readonly



Methods ClassSymboladd(sourceArt:PageItem[,registrationPoint:SymbolRegistrationPointCreateasymbol.Parameter Type

sourceArt PageItem

registrationPoint SymbolRegistrationPoint:SymbolRegistrationPoint.SYMBOLTOPLEFTPOINTSymbolRegistrationPoint.SYMBOLTOPMIDDLEPOINTSymbolRegistrationPoint.SYMBOLTOPRIGHTPOINTSymbolRegistrationPoint.SYMBOLMIDDLELEFTPOINTSymbolRegistrationPoint.SYMBOLCENTERPOINTSymbolRegistrationPoint.SYMBOLMIDDLERIGHTPOINTSymbolRegistrationPoint.SYMBOLBOTTOMLEFTPOINTSymbolRegistrationPoint.SYMBOLBOTTOMMIDDLEPOINTSymbolRegistrationPoint.SYMBOLBOTTOMRIGHTPOINT

InstancesSymbolgetByName(name:string)

Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type

name string


Elementof Document.symbols


Contents::Index

Class

Tags Thecollectionoftagsassociatedwithapageitem.

SeealsoTag.


Hierarchy Object

Tags





Methods ClassTagadd()Createatag.

InstancesTaggetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.tagsPageItem.tags


Contents::Index

Class

TextFonts Acollectionoffonts.

SeealsoTextFont.


Hierarchy Object

TextFonts





Methods InstancesTextFontgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Application.textFonts


Contents::Index

Class

TextFrameItems Acollectionoftextframeitems.

SeealsoTextFrameItem.

QuickLinks add,areaText,getByName,pathText,pointText

Hierarchy Object

TextFrameItems





Methods ClassTextFrameItemadd()Createapointtextframeitem.

TextFrameItemareaText(textPath:PathItemTextOrientation=TextOrientation.HORIZONTAL[,postFix:bool=true])Createanareatextframeitem.Parameter Type

textPath PathItem


baseFrame TextFrameItem

postFix bool

TextFrameItempathText(textPath:PathItemendTValue:number=0.0][,orientation:TextOrientation=TextOrientation.HORIZONTAL[,postFix:bool=true])Createanon-pathtextframeitem.Parameter Type

textPath PathItem

startTValue number

endTValue number


baseFrame TextFrameItem

postFix bool

TextFrameItempointText(anchor:Point[,orientationTextOrientation=TextOrientation.HORIZONTALCreateapointtextframeitem.Parameter Type

anchor Point


InstancesTextFrameItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type

name string


Elementof Document.textFramesGroupItem.textFramesLayer.textFramesStory.textFrames


Contents::Index

Class

TextRanges Acollectionoftextrangeitems.

SeealsoTextRange.


Hierarchy Object

TextRanges





Methods InstancesTextRangegetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof InsertionPoint.textRangesStory.textRangesTextFrameItem.textRangesTextRange.textRanges


Contents::Index

Class

Variables Acollectionofvariables.

SeealsoVariable.


Hierarchy Object

Variables





Methods ClassVariableadd()Createavariable.

InstancesVariablegetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.variables

Jongware,25-


Class

Views Acollectionofviews.

SeealsoView.


Hierarchy Object

Views





Methods InstancesViewgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.views


Contents::Index

Class

Words Acollectionofwords.


Hierarchy Object

Words





Methods ClassTextRangeadd(contents:string)Createaword.Parameter Type Description





name string

voidremoveAll()

Deletesallelements.

Elementof InsertionPoint.wordsStory.wordsTextFrameItem.wordsTextRange.words


Contents::Index

Class

Point Describesapoint.Thisclassisalsoatwo-elementcollection.


left number r/w Theleftcoordinate.

length number readonly Thearraylength.(default:2)

top number r/w Thetopcoordinate.

x number r/w Theleftcoordinate.

y number r/w Thetopcoordinate.

Elementof

Artboard.rulerOriginButton.locationCheckbox.locationDocument.pageOriginDocument.rulerOriginDropDownList.locationEditText.locationFlashPlayer.locationGradientColor.originGroup.locationIconButton.locationListBox.locationPageItem.positionPanel.locationPathPoint.anchorPathPoint.leftDirectionPathPoint.rightDirectionPatternColor.scaleFactorProgressbar.locationRadioButton.locationScriptUIGraphics.currentPointScrollbar.locationSlider.locationStaticText.location

TextFrameItem.anchorTextPath.positionTreeView.locationView.centerPointWindow.frameLocationWindow.location

Usedin: PointDocument.convertCoordinate(coordinate:Point,source:CoordinateSystem,destination:CoordinateSystem)

voidDocument.windowCapture(imageFile:File,windowSize:Point)

TextFrameItemTextFrameItems.pointText(anchor:Point[,orientation:TextOrientation=TextOrientation.HORIZONTAL])

Return PointDocument.convertCoordinate(coordinate:Point,source:CoordinateSystem,destination:CoordinateSystem)

PointScriptUIGraphics.ellipsePath(left:Number,top:Number,width:Number,height:Number)

PointScriptUIGraphics.lineTo(x:Number,y:Number)PointScriptUIGraphics.moveTo(x:Number,y:Number)PointScriptUIGraphics.rectPath(left:Number,top:Number,

width:Number,height:Number)


Contents::Index

Class

Rectangle Describesarectangle.Thisclassisalsoafour-element

collection.


bottom number r/w Thebottomcoordinate.

height number r/w Theheight.

left number r/w Theleftcoordinate.

length number readonly Thearraylength.(default:4)

right number r/w Therightcoordinate.

top number r/w Thetopcoordinate.

width number r/w Thewidth.

x number r/w Theleftcoordinate.

y number r/w Thetopcoordinate.

Elementof Artboard.artboardRectDocument.cropBoxDocument.geometricBoundsDocument.visibleBoundsPDFSaveOptions.bleedOffsetRectPageItem.controlBoundsPageItem.geometricBoundsPageItem.visibleBoundsPaperInfo.imageableAreaPlacedItem.boundingBoxPrintPageMarksOptions.bleedOffsetRectPrintPageMarksOptions.marksOffsetRectRasterItem.boundingBoxView.bounds

Usedin: ArtboardArtboards.add(artboardRect:Rectangle)

voidArtboards.insert(artboardRect:Rectangle,index:Int32)

voidDocument.imageCapture(imageFile:File[,clipBounds:Rectangle][,options:ImageCaptureOptions])

PageItemDocument.rasterize(sourceArt:any[,clipBounds:Rectangle][,options:RasterizeOptions])


Contents::Index

Class

Bounds Definestheboundariesofawindowwithinthescreen's

coordinatespace,orofaUIelementwithinthecontainer'scoordinatespace.ABoundsobjectiscreatedwhenyousetanelement'sboundsproperty.YoucansetthepropertyusingaJavaScriptobjectwithpropertiesnamedleft,top,right,bottomorx,y,width,height,oranarraywith4valuesintheorder[x,y,wd,ht].


bottom Number r/w Theverticalcoordinate,apixeloffsetfromtheoriginoftheelement'scoordinatespace.

height Number r/w Theheightinpixels.

left Number r/w Thehorizontalcoordinate,apixeloffsetfromtheoriginoftheelement'scoordinatespace.

length Number readonly Thearraylength.(default:4)

right Number r/w Thewidthinpixels.

top Number r/w Theheightinpixels.

width Number r/w Thewidthinpixels.

x Number r/w Thehorizontalcoordinate,apixeloffsetfromtheoriginoftheelement'scoordinatespace.

y Number r/w Theverticalcoordinate,apixeloffsetfromtheoriginoftheelement'scoordinatespace.

Elementof Button.boundsButton.windowBoundsCheckbox.boundsCheckbox.windowBoundsDropDownList.boundsDropDownList.windowBoundsEditText.boundsEditText.windowBoundsFlashPlayer.boundsFlashPlayer.windowBoundsGroup.boundsGroup.windowBoundsIconButton.boundsIconButton.windowBoundsListBox.boundsListBox.windowBoundsPanel.boundsPanel.windowBoundsProgressbar.boundsProgressbar.windowBoundsRadioButton.boundsRadioButton.windowBoundsScrollbar.boundsScrollbar.windowBoundsSlider.boundsSlider.windowBoundsStaticText.boundsStaticText.windowBoundsTreeView.boundsTreeView.windowBoundsWindow.boundsWindow.frameBoundsWindow.windowBounds

Usedin: ObjectGroup.add(type:String[,bounds:Bounds][,text:String][,properties:Object])

ObjectPanel.add(type:String[,bounds:Bounds][,text:String][,properties:Object])


ObjectWindow.add(type:String[,bounds:Bounds][,text:String][,properties:Object])


Contents::Index

Class

Button(SUI) Apushbuttonelementcontainingamouse-sensitivetextstring.

CallstheonClick()callbackifthecontrolisclickedorifitsnotify()methodiscalled.

QuickLinks addEventListener,dispatchEvent,hide,notify,onActivate,onClickonDeactivate,onDraw,onShortcutKey,removeEventListener,show

Hierarchy Object

Button(SUI)


active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.

alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrensettingfortheparentcontainer.Thiscanbeasingle

string,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,rightfill

bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.

characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthe

preferredsizeoftheelement.

children ArrayofObject readonly Anarrayofchildelements.

enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.

graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()event.

helpTip String r/w Thehelpstringthatisdisplayedwhenthemousehoversovertheelement.

indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.

justify String r/w Thetextjustification

style.(default:leftOneofleft,centerright.Justificationonlyworksifthisvalueissetoncreationoftheelement.

location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.

maximumSize Dimension r/w Themaximumheightandwidthtowhichtheelementcanberesized.

minimumSize Dimension r/w Theminimumheightandwidthtowhichtheelementcanberesized.

parent Object readonly Theparentelement.

preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,

andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).AButtonobjecthasnocreationproperties,butthethirdargumenttotheadd()methodthatcreatesitcanbetheinitialtextvalue.

shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()callbackforthiselement(inWindowsonly).

size Dimension r/w Thecurrentdimensionsofthiselement.

Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizeorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.

text String r/w Thetexttodisplay,alocalizablestring.

type String readonly Theelementtype;"button".

visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.

window Window(SUI) readonly Thewindowthatthiselementbelongsto.

windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-levelparentwindow.

Methods EventsvoidonActivate()Anevent-handlercallbackfunction,calledwhentheelementacquiresthekeyboardfocus.Calledwhentheusergivesthecontrolthekeyboardfocusbyclickingitortabbingintoit.

voidonClick()Anevent-handlercallbackfunction,calledwhentheelementhasbeenclicked

voidonDeactivate()Anevent-handlercallbackfunction,calledwhentheelementlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviouslyactivecontroltoanothercontrol.

voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.

voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement'sshortcutKeysequenceistypedintheactivewindow.InWindowsonly.

InstancesBooleanaddEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringin

thiselement.Parameter Type Description

eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.

handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.

capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.(default:false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.

EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.

voidhide()Hidesthiselement.

voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description

eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingdefault,simulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)

BooleanremoveEventListener(eventName:String,handler:

Function[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description

eventName String Thenameoftheevent.

handler Function Thefunctionthathandlestheevent.

capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:false)

voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.


Contents::Index

Class

Checkbox(SUI) Adual-statecontrolshowingaboxthathasacheckmarkwhenthe

valueistrue,andisemptywhenthevalueisfalse.CallstheonClick()callbackifthecontrolisclickedorifitsmethodiscalled.

QuickLinks addEventListener,dispatchEvent,hide,notify,onActivateonDeactivate,onDraw,onShortcutKey,removeEventListener

Hierarchy Object

Checkbox(SUI)



alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenfortheparentcontainer.

Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right•Fororientation=stack:bottom,leftfill


characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhen

calculatingthepreferredsizeoftheelement.




helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.


justify String r/w Thedefaulttextjustificationstyleforchildtextelements.(default:leftOneofleftright.Justificationonlyworksifthisvalueissetoncreationoftheelement.





preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueis

establishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesoftheitem(propertiesusedonlywhentheelementiscreated).ACheckBoxobjecthasnocreationproperties.Thethirdargumenttothemethodthatcreatesitisthetexttobedisplayed.


size Dimension r/w Thecurrent

dimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizeorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.

text String r/w Thetexttodisplay,alocalizablestring.

type String readonly Theelementtype;"checkbox".

value Boolean r/w Theselectionstateofthecontrol.Whentrue,thecontrolisintheselectedorsetstateanddisplaysthecheckmark.Whenfalse,showsanemptybox.





voidonClick()Anevent-handlercallbackfunction,calledwhentheelementhasbeenclicked.


voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.

Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.


InstancesBooleanaddEventListener(eventName:String,handler:capturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description





voidhide()

Hidesthiselement.



BooleanremoveEventListener(eventName:String,handlerFunction[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description






Contents::Index

Class

Dimension DefinesthesizeofawindoworUIelement.Contains

a2-elementarray.Specifiestheheightandwidthofanelementinpixels.ADimensionobjectiscreatedwhenyousetanelement'ssizeproperty.YoucansetthepropertyusingaJavaScriptobjectwithnamedproperties{width:wd,height:ht},oranarraywith2valuesintheorder[wd,ht].


height Number r/w Theheightinpixels.


width Number r/w Thewidthinpixels.

Elementof Button.maximumSizeButton.minimumSizeButton.preferredSizeButton.sizeCheckbox.maximumSizeCheckbox.minimumSizeCheckbox.preferredSizeCheckbox.sizeDropDownList.itemSizeDropDownList.maximumSizeDropDownList.minimumSizeDropDownList.preferredSizeDropDownList.sizeEditText.maximumSizeEditText.minimumSizeEditText.preferredSizeEditText.sizeFlashPlayer.maximumSizeFlashPlayer.minimumSize

FlashPlayer.preferredSizeFlashPlayer.sizeGroup.maximumSizeGroup.minimumSizeGroup.preferredSizeGroup.sizeIconButton.maximumSizeIconButton.minimumSizeIconButton.preferredSizeIconButton.sizeListBox.itemSizeListBox.maximumSizeListBox.minimumSizeListBox.preferredSizeListBox.sizePanel.maximumSizePanel.minimumSizePanel.preferredSizePanel.sizeProgressbar.maximumSizeProgressbar.minimumSizeProgressbar.preferredSizeProgressbar.sizeRadioButton.maximumSizeRadioButton.minimumSizeRadioButton.preferredSizeRadioButton.sizeScriptUIImage.sizeScrollbar.maximumSizeScrollbar.minimumSizeScrollbar.preferredSizeScrollbar.sizeSlider.maximumSizeSlider.minimumSizeSlider.preferredSizeSlider.sizeStaticText.maximumSizeStaticText.minimumSizeStaticText.preferredSize

StaticText.sizeTreeView.itemSizeTreeView.maximumSizeTreeView.minimumSizeTreeView.preferredSizeTreeView.sizeWindow.frameSizeWindow.maximumSizeWindow.minimumSizeWindow.preferredSizeWindow.size

Return DimensionScriptUIGraphics.measureString(text:String[,font:ScriptUIFont][,boundingWidth:Number])


Contents::Index

Class

DrawState Describesaninputstateatthetimeofthetriggering

ScriptUIGraphics.onDraw()event.Containspropertiesthatreportwhetherthecurrentcontrolhastheinputfocus,andtheparticularmousebuttonandkeypressstate.PassedinasargumenttoScriptUIGraphics.onDraw().


altKeyPressed Boolean readonly TrueiftheAltkeyisbeingpressed(inWindowsonly).

capsLockKeyPressed Boolean readonly TrueiftheCapsLockkeyisbeingpressed.

cmdKeyPressed Boolean readonly TrueiftheCommandkeyisbeingpressed(inMacOSonly).

ctrlKeyPressed Boolean readonly TrueiftheCtrlkeyisbeingpressed.

hasFocus Boolean readonly Trueiftheelementhastheinputfocus.

leftButtonPressed Boolean readonly Trueiftheleftmousebuttonisbeingpressed.

middleButtonPressed Boolean readonly Trueifthemiddlemousebuttonisbeingpressed.

mouseOver Boolean readonly Trueifthecursorishoveringoverthiselement.

numLockKeyPressed Boolean readonly TrueiftheNumLockkeyisbeingpressed.

optKeyPressed Boolean readonly TrueiftheOptionkeyisbeingpressed(inMacOSonly).

rightButtonPressed Boolean readonly Trueiftherightmousebuttonisbeingpressed.

shiftKeyPressed Boolean readonly TrueiftheShiftkeyisbeingpressed.


Contents::Index

Class

DropDownList Displaysasinglevisibleitem.Whenyouclickthecontrol,alistdrops

downorpopsup,andallowsyoutoselectoneoftheotheritemsinthelist.Drop-downlistscanhavenonselectableseparatoritemsforvisuallyseparatinggroupsofrelateditems,asinamenu.Youcanspecifytheitemsoncreationofthelistobject,orafterwardusingthelistobject'sadd()method.Youcanremoveitemsprogrammaticallywiththelistobject'sremove()andremoveAll()methods.Callsthecallbackiftheitemselectionischangedorifitscalled.

QuickLinks add,addEventListener,dispatchEvent,find,hideonChange,onDeactivate,onDraw,onShortcutKeyremoveAll,removeEventListener,show

Hierarchy Object

DropDownList


active Boolean r/w

alignment String r/w

bounds Bounds r/w

children ArrayofObject readonly

enabled Boolean r/w

graphics ScriptUIGraphics readonly

helpTip String r/w

indent Number(min:0) r/w

itemSize Dimension r/w

items ArrayofListItem readonly

location Point r/w

maximumSize Dimension r/w

minimumSize Dimension r/w


preferredSize Dimension r/w

properties Object r/w

selection ListItem r/w

shortcutKey String r/w

size Dimension r/w

type String readonly

visible Boolean r/w

window Window(SUI) readonly

windowBounds Bounds readonly


voidonChange()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementhasbeenchanged




InstancesListItemadd(type:String[,text:String])Addsanitemorseparatortothechoicesinthislist.Returnstheitemcontrolobjectfortype="item",ornullfortype="separator".Parameter Type Description

type String Thetypeofthechildelement.Eitheritem(abasic,selectableitemwithatextlabel)orseparator

text String Thelocalizabletextlabelfortheitem.(Optional)

BooleanaddEventListener(eventName:StringcapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description

eventName String Thenameoftheevent.EventnamesarelistedintheToolsGuide.




ListItemfind(text:String)Retrievesanitemobjectfromthelistthathasagiventextlabel.Parameter Type Description

text String Thetextstringtomatch.



eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChangedefault,simulatestheonChange

edittextcontrol,anonClickthatsupportthatevent.(Optional)

voidremove(what:Any)Removesachilditemfromthelist.Parameter Type Description

what Any Theitemorchildtoremove,specifiedby0-basedindex,textvalue,orasaListItemobject.

voidremoveAll()Removesallchilditemsfromthelist.

BooleanremoveEventListener(eventName:StringFunction[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description






Contents::Index

Class

EditText Aneditabletextfieldthattheusercanselectandchange.

CallstheonChange()callbackifthetextischangedandtheusertypesEnterorthecontrollosesfocus,orifitsnotify()methodiscalled.CallstheonChanging()callbackwhenanychangeismadetothetext.Thetextselectionpropertycontainscurrentlyselectedtext.

QuickLinks addEventListener,dispatchEvent,hide,notify,onActivate,onChangeonChanging,onDeactivate,onDraw,onShortcutKey,removeEventListenershow

Hierarchy Object

EditText



alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththe

horizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,


characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeoftheelement.



graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheevent.



justify String r/w Thetextjustificationstyle.(default:left)Oneofleft,centerJustificationonlyworksifthisvalueissetoncreationoftheelement.





preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.

Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).CreationpropertiesofanEditTextobjectcaninclude:•multiline:Whenfalse(thedefault),thecontroldisplaysasinglelineoftext.Whentrue,thecontroldisplaysmultiplelines,inwhichcasethetextwrapswithinthewidthofthecontrol.•readonly:Whenfalse(thedefault),thecontrolacceptstextinput.Whentrue,thecontroldoesnotacceptinputbutonlydisplaysthecontentsofthetextproperty.•noecho:Whenfalse(thedefault),thecontroldisplaysinputtext.Whentrue,thecontroldoesnotdisplayinput

text(usedforpasswordinputfields).•enterKeySignalsOnChangeWhenfalse(thedefault),thecontrolsignalsaneventwhentheeditabletextischangedandthecontrollosesthekeyboardfocus(thatis,theusertabstoanothercontrol,clicksoutsidethecontrol,ortypesEnter).Whentrue,thecontrolonlysignalsanonChange()eventwhentheeditabletextischangedandtheusertypesEnter;otherchangestothekeyboardfocusdonotsignaltheevent.


size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizesize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settingan

element'ssizechangesitsboundsproperty,andvice-versa.

text String r/w Thecurrenttextdisplayedinthefield,alocalizablestring.

textselection String r/w Thecurrentlyselectedtext,ortheemptystringifthereisnotextselected.Settingthevaluereplacesthecurrenttextselectionandmodifiesthevalueoftheproperty.Ifthereisnocurrentselection,insertsthenewvalueintothetextstringatthecurrentinsertionpoint.Thetextselectionvalueisresettoanemptystringafteritmodifiesthetextvalue.Notethatsettingthetextselectionpropertybeforetheelement'sparentWindowexistsisanundefinedoperation.

type String readonly Theelementtype;"edittext".





voidonChange()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementhasbeenchangedThehandleriscalledonlywhenthechangeiscomplete–thatis,whenfocusmovestoanothercontrol,ortheusertypesEnter.TheexactbehaviordependsonthecreationparameterenterKeySignalsOnChange;seetheproperty.

voidonChanging()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementisintheprocessofchangingThehandleriscalledforeachkeypresswhilethiscontrolhastheinputfocus.


voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aobject.

voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement'ssequenceistypedintheactivewindow.InWindowsonly.

InstancesBooleanaddEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description



capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.




eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.

(Optional)

BooleanremoveEventListener(eventName:String,handlercapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description



capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:



Contents::Index

Class

Environment DefinesattributesoftheScriptUIenvironment.

AccessthroughtheScriptUI.environmentproperty.


keyboardState KeyboardState readonly Anobjectthatreportstheactivestateofthekeyboardatanytime.Providesaccesstothekeystateindependentoftheevent-handlingframework.

Elementof ScriptUI.environment


Contents::Index

Class

Event(SUI) BaseclassforUIEvent.

Encapsulatesinputeventinformationforaneventthatpropagatesthroughacontainerandcontrolhierarchy.ImplementsW3Cstandardeventhandling.

QuickLinks preventDefault,stopPropagation


bubbles Boolean readonly Trueiftheeventisofatypethatbubbles.

cancelable Boolean readonly TrueifthedefaultactionassociatedwiththeeventcanbecanceledwithpreventDefault().

captures Boolean readonly Trueifthiseventcanbecaptured.

currentTarget Boolean readonly Theeventtargetobjectwhichiscurrentlyhandlingtheevent.Duringcapturingandbubbling,thisisdifferentfromthepropertytarget.

eventPhase String readonly Thecurrentphaseofeventpropagation;oneofnone,target,capture,bubble.

target Object readonly Theeventtargetobjectforthisevent.

timeStamp Date readonly Thedateandtimeatwhichtheeventoccurred.

type String readonly Thenameoftheeventthatthisobjectrepresents.EventtypesarelistedintheJavaScriptToolsGuide.


AT_TARGET any readonly

BUBBLING_PHASE any readonly

CAPTURING_PHASE any readonly

NOT_DISPATCHING any readonly

Methods InstancesvoidpreventDefault()Preventsthedefaultactionassociatedwiththiseventfrombeingcalled.

voidstopPropagation()Stopsthepropagationofthisevent.

Return EventEvents(SUI).createEvent(eventType:String)


Contents::Index

Class

Events(SUI) ProvidesaccesstoobjectsusedintheScriptUIeventsystem.

AccessthroughtheScriptUI.eventsproperty.

QuickLinks createEvent

Methods InstancesEventcreateEvent(eventType:String)CreatesaninstanceofthespecifiedEventsubclass.TheEventreturnedisaUIEvent,KeyboardEventorMouseEventobject,dependingontherequestedtype.Thisobjectcanbepassedasaparametertoanelement'sdispatchEventfunctioninordertosimulateauser-interactionevent.Parameter Type Description

eventType String Thenameofaneventtype:oneof"UIEvent","KeyboardEvent",or"MouseEvent".


Contents::Index

Class

FlashPlayer AcontrolthatcontainsaFlashPlayer,whichcanloadandplay

FlashmoviesstoredinSWFfiles.TheScriptUIFlashPlayerelementrunstheFlashapplicationwithinanAdobeapplication.TheFlashapplicationrunsActionScript,adifferentimplementationofJavaScriptfromtheExtendScriptversionofJavaScriptthatAdobeapplicationsrun.AcontrolobjectofthistypecontainsfunctionsthatallowyourscripttoloadSWFfiles,controlmovieplayback,andcommunicatewiththeActionScriptenvironment.

QuickLinks addEventListener,callback,dispatchEvent,hide,invokePlayerFunction,loadMovie,notify,playMovieremoveEventListener,show,stopMovie

Hierarchy Object

FlashPlayer



alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalue

overridesthealignChildrenfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,fill

bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-

versa.



indent Number(min:0)

r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.


maximumSize Dimension r/w Themaximumheight

andwidthtowhichtheelementcanberesized.



preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer

(propertiesusedonlywhentheelementiscreated).AFlashPlayerobjecthasnocreationproperties.

size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizeorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.

type String readonly Theelementtype,"flashplayer".

visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildren

arealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.

window Window(SUI)

readonly Thewindowthatthiselementbelongsto.


Methods Eventsvoidcallback()AfunctiondefinitionforacallbackfromtheFlashActionScriptenvironment.TheFlashActionScriptcodecancallanycallbackfunctiondefinedontheExtendScriptsideoftheFlashPlayerobject,invokingitbynameasapropertyofthecontrolobject.Thefunctioncantakeanyargumentsofasupporteddatatypes,andcanreturnanyvalueofasupporteddatatype.datatypes:Number,String,Boolean,null,undefined,Object,Array.

InstancesBooleanaddEventListener(eventName:String,handlerFunction[,capturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description


handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunction

definedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.

capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.(default:falseDefaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.



AnyinvokePlayerFunction(name:String[,argumentInvokesanActionScriptfunctiondefinedintheFlashapplication.Returnstheresultoftheinvokedfunction,whichmustbeoneoftheallowedtypes.TheActionScriptclassanddateobjectsarenotsupportedasreturnvalues.Parameter Type Description

name String ThenameofaFlashActionScriptfunctionthathasbeenregisteredwiththeExternalInterfaceobjectbythecurrentlyloadedSWFfile.

argument Any Anargumenttopassthroughtothefunction.Therecanbeanynumberofarguments.Anargumentmustbeoneofthesedata

types:Number,String,Boolean,null,undefined,Object,Array.Nootherdatatypesaresupported.(Optional)

voidloadMovie(file:File)LoadsamovieintotheFlashPlayer,andbeginsplayingit.Parameter Type Description

file File TheFileobjectfortheSWFfiletoload.


eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChanging.Bydefault,simulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)

voidplayMovie([rewind:Boolean=false])Restartsamoviethathasbeenstopped.Donotuseonamoviethatiscurrentlyplaying.ThestopMovie()-playMovie()sequencedoesnotworkforSWFfilesproducedbyFlex,orforsomefilesproducedbyFlashAuthoring(dependingonhowtheywereimplemented).Parameter Type Description

rewind Boolean Whentrue,restartsthemoviefromthebeginning;otherwise,startsplayingfromthepointwhereitwasstopped.(default:false)

BooleanremoveEventListener(eventName:String,Function[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.

Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description



capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:false


voidstopMovie()Haltsplaybackofthecurrentmovie.ThestopMovie()-playMovie()sequencedoesnotworkforSWFfilesproducedbyFlex,orforsomefilesproducedbyFlashAuthoring(dependingonhowtheywereimplemented).UsingstopMovie()fromtheplayer'shostingenvironmenthasnoeffectonanSWFfileplayinginaScriptUIFlashPlayerelement.Itis,however,possibletoproduceanSWFusingFlashAuthoringthatcanstopitselfinresponsetouserinteraction.


Contents::Index

Class

Group(SUI) Acontainerforothercontrolswithinawindow.

Agroupcanspecifylayoutoptionsforitschildelements.Hidingagrouphidesallitschildren.Makingitvisiblemakesvisiblethosechildrenthatarenotindividuallyhidden.

QuickLinks add,addEventListener,dispatchEvent,hide,onDraw,remove,removeEventListener,show

Hierarchy Object

Group(SUI)


alignChildren String r/w Tellsthelayoutmanagerhowunlike-sizedchildrenofthiscontainershouldbealignedwithinacolumnorrow.Orderofcreationdetermineswhichchildrenareatthetopofacolumnortheleftofarow;theearlierachildiscreated,thecloseritistothetoporleftofitscolumnorrow.Ifdefined,alignmentforachildelementoverridesthealignChildrensettingfortheparentcontainer.See

alignmentpropertyforvalues.

alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrensettingfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,rightfill

bounds Bounds r/w Theboundariesoftheelement,inparent-

relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.





indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orrow

orientationandtopalignment.

layout LayoutManager r/w Thelayoutmanagerforthiscontainer.Thefirsttimeacontainerobjectismadevisible,ScriptUIinvokesthislayoutmanagerbycallingitslayout()function.DefaultisaninstanceoftheLayoutManagerclassthatisautomaticallycreatedwhenthecontainerelementiscreated.


margins Number r/w Thenumberofpixelsbetweentheedgesofacontainerandtheoutermostchildelements.Youcanspecifydifferentmarginsforeachedgeofthecontainer.Thedefaultvalueisbasedonthe

typeofcontainer,andischosentomatchthestandardAdobeUIguidelines.



orientation String r/w Thelayoutorientationofchildreninacontainer.Interpretedbythelayoutmanagerforthecontainer.ThedefaultLayoutManagerObjectacceptsthe(case-insensitive)valuesrow,columnorstack.Forwindowandpanel,thedefaultiscolumn,andforgroupthedefaultisrow.Theallowedvaluesforthecontainer'salignChildrenanditschildren'salignmentpropertiesdependontheorientation.


preferredSize Dimension r/w Thepreferredsize,

usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontrol(propertiesusedonlywhentheelementiscreated).AGroupobjecthasnocreationproperties.

size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itis

definedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizeorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.

spacing Number r/w Thenumberofpixelsseparatingonechildelementfromitsadjacentsiblingelement.Becauseeachcontainerholdsonlyasingleroworcolumnofchildren,onlyasinglespacingvalueisneededforacontainer.Thedefaultvalueisbasedonthetypeofcontainer,andischosentomatchstandardAdobeUIguidelines.

type String readonly Theelementtype;"group".




Methods EventsvoidonDraw()Anevent-handlercallbackfunction,calledwhenthegroupisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.

InstancesObjectadd(type:String[,bounds:Bounds][,text:String][,propertiesObject])Addsachildelementtothiscontainer.Createsandreturnsanewcontrolorcontainerobjectandaddsittothechildrenofthisgroup.Parameter Type Description

type String Thetypeofthechildelement,asspecifiedforthetypeproperty.ControltypesarelistedintheJavaScript

ToolsGuide.

bounds Bounds Aboundsspecificationthatdescribesthesizeandpositionofthenewcontrolorcontainer,relativetoitsparent.Ifsupplied,thisvaluecreatesanewBoundsobjectwhichisassignedtothenewobject'sboundsproperty.(Optional)

text String Thetextorlabel,alocalizablestring.Initialtexttobedisplayedinthecontrolasthetitle,label,orcontents,dependingonthecontroltype.Ifsupplied,thisvalueisassignedtothenewobject'stextproperty.(Optional)

properties Object Anobjectthatcontainsoneormorecreationpropertiesofthenewchild(propertiesusedonlywhentheelementiscreated).Thecreationpropertiesdependontheelementtype.Seepropertyofeachcontroltype.(Optional)

BooleanaddEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description



capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.

(default:false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.



voidremove(what:Any)Removesthespecifiedchildcontrolfromthisgroup'schildrenarray.Noerrorresultsifthechilddoesnotexist.Parameter Type Description

what Any Thechildcontroltoremove,specifiedby0-basedindex,textpropertyvalue,orasacontrolobject.

BooleanremoveEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description




voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,

butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.


Contents::Index

Class

IconButton Amouse-sensitivepushbuttonthatdisplaysanimageinsteadoftext.

CallstheonClick()callbackifthecontrolisclickedorifitsmethodiscalled.


Hierarchy Object

IconButton



alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthe

alignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom•Fororientation=column:left,right•Fororientation=stack:bottomfill



enabled Boolean r/w Trueifthiselementisenabled.Anenabledelement

canacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.

graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()


image ScriptUIImage r/w Theimageobjectthatdefinestheimagetobedrawn.


location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settingan

element'slocationchangesitsboundsproperty,andvice-versa.




preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthe

default.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).CreationpropertiesofanIconButtonobjectcaninclude:•style:thevisualstyle,either"button",whichhasavisibleborderwitharaisedor3Dappearance,or"toolbutton",whichhasaflatappearance,appropriateforinclusioninatoolbar.


size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.Ascriptcanexplicitlysetsizebeforethe

layoutmanagerisinvokedtoestablishanelementsizeotherthantheorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.

type String readonly Theelementtype;"iconbutton".




Methods EventsvoidonActivate()

Anevent-handlercallbackfunction,calledwhentheelementacquiresthekeyboardfocus.Calledwhentheusergivesthecontrolthekeyboardfocusbyclickingitortabbingintoit.





InstancesBooleanaddEventListener(eventName:String,handlercapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description


handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhenthe

eventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.












Contents::Index

Class

KeyboardState Reportstheactivestateofthekeyboard.

AccessthroughtheScriptUI.environment.keyboardStateproperty.Querythepropertiesofthisobjectatanytimetodeterminethecurrentkeythatisdownandanymodifiersthatarepressed.


altKey Boolean readonly TrueiftheAltorOptionkeyispressed.

ctrlKey Boolean readonly TrueiftheCtrlkeyispressed.

keyName String readonly Astringcontainingthenameofthecurrentlypressedkey,suchas"a",oranemptystring.

metaKey Boolean readonly TrueiftheCmdkey(inMacOS)orWindowskey(inWindows)ispressed.

shiftKey Boolean readonly TrueiftheShiftkeyispressed.

Elementof Environment.keyboardState


Contents::Index

Class

LayoutManager Controlstheautomaticlayoutbehaviorfor

awindoworcontainer.ThesubclassAutoLayoutManagerimplementsthedefaultautomaticlayoutbehavior.

QuickLinks layout,resize

Methods Instancesvoidlayout()Invokestheautomaticlayoutbehaviorforthemanagedcontainer.Adjustssizesandpositionsofthechildelementsofthiswindoworcontaineraccordingtotheplacementandalignmentpropertyvaluesintheparentandchildren.Invokedautomaticallythefirsttimethewindowisdisplayed.Thereafter,thescriptmustinvokeitexplicitlytochangethelayoutincaseofchangesinthesizeorpositionoftheparentorchildren.

voidresize()PerformsalayoutafteraWindowisresized,basedonthenewsize.Resizesthechildelementsofthemanagedcontainerwithagivenalignmenttype,afterthewindowhasbeenresizedbytheuser.

Elementof Group.layoutPanel.layoutWindow.layout


Contents::Index

Class

ListBox(SUI) Displaysalistofchoices,representedbyListItemobjects.

Whenyoucreatetheobject,youspecifywhetheritallowstheusertoselectonlyoneormultipleitems.Ifalistcontainsmoreitemsthancanbedisplayedintheavailablearea,ascrollbarmayappearthatallowstheusertoscrollthroughallthelistitems.Youcanspecifytheitemsoncreationofthelistobject,orafterwardusingthelistobject'sadd()method.Youcanremoveitemsprogrammaticallywiththelistobject'sremove()andremoveAll()methods.Youcancreatealistboxwithmultiplecolumns;inthiscase,eachrowisaselectablechoice,andeachListItemrepresentsonerow.

QuickLinks add,addEventListener,dispatchEvent,find,hide,notify,onActivateonChange,onDeactivate,onDoubleClick,onDraw,onShortcutKeyremove,removeAll,removeEventListener,show

Hierarchy Object

ListBox(SUI)



alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrensettingfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,rightfill

bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement's

sizeorlocationchangesitsboundsproperty,andvice-versa.

children ArrayofObject readonly AnarrayofchildListItemelements.

columns Object readonly Foramulti-columnlistbox,thecolumnproperties.AJavaScriptobjectwithtworead-onlypropertieswhosevaluesaresetbythecreationparameters:•titles:Anarrayofcolumntitlestrings,whoselengthmatchesthenumberofcolumnsspecifiedatcreation.•preferredWidthsAnarrayofcolumnwidths,whoselengthmatchesthenumberofcolumnsspecifiedatcreation.





itemSize Dimension r/w Thewidthandheightinpixelsofeachiteminthelist.Usedbyauto-layouttodeterminethepreferredSizeofthelist,ifnototherwisespecified.Ifnotsetexplicitly,thesizeofeachitemissettomatchthelargestheightandwidthamongallitemsinthelist

items ArrayofListItem readonly Thearrayofchoiceitemsdisplayedinthelist.

Accessthisarraywitha0-basedindex.Toobtainthenumberofitemsinthelist,useitems.length.Theobjectsarecreatedwhenitemsarespecifiedoncreationoftheparentlistobject,orafterwardusingthelistcontrol'sadd()method.Eachitemhasaselectedpropertythatistruewhenitisintheselectedstate.





preferredSize Dimension r/w Thepreferredsize,

usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontrol(propertiesusedonlywhentheelementiscreated).CreationpropertiesofaListBoxobjectcaninclude:•multiselect:Whenfalse(thedefault),onlyoneitemcanbeselected.Whentrue,multipleitemscanbeselected.

•items:Anarrayofstringsforthetextofeachlistitem.Anitemobjectiscreatedforeachitem.Anitemwiththetextstring"-"createsaseparatoritem.Supplythisproperty,ortheitemsargumenttotheadd()method,notboth.ThisformismostusefulforelementsdefinedusingResourceSpecifications.•numberOfColumnsAnumberofcolumnsinwhichtodisplaytheitems;defaultis1.Whentherearemultiplecolumns,eachListItemobjectrepresentsaselectablerow.Itstextandimagevaluesspecifythelabelinthefirstcolumn,andthesubitemspropertyspecifiesthelabelsintheadditionalcolumns.•showHeadersTruetodisplaycolumntitles.•columnWidthsarrayofnumbersfor

thepreferredwidthinpixelsofeachcolumn.•columnTitlescorrespondingarrayofstringsforthetitleofeachcolumn,tobeshownifshowHeadersistrue.

selection ListItem r/w Thecurrentlyselecteditemforasingle-selectionlist,oranarrayofitemsforcurrentselectioninamulti-selectionlist.Settingthisvaluecausestheselecteditemtobehighlightedandtobescrolledintoviewifnecessary.Ifnoitemsareselected,thevalueisnull.Settonulltodeselectallitems.Youcansetthevalueusingtheindexofanitemoranarrayofindices,ratherthanobjectreferences.Ifsettoanindexvaluethatisoutofrange,theoperationisignored.Whensetwithindexvalues,thepropertystillreturnsobjectreferences.•Ifyousetthevaluetoanarrayforasingle-selectionlist,

onlythefirstiteminthearrayisselected.•Ifyousetthevaluetoasingleitemforamulti-selectionlist,thatitemisaddedtothecurrentselection.



type String readonly Theelementtype;"listbox".







voidonDoubleClick()

Anevent-handlercallbackfunction,calledwhenaniteminthelistboxisdouble-clickedChecktheselectionpropertytoidentifytheitemthatwasdouble-clicked.



InstancesListItemadd(type:String[,text:String])Addsanitemtothechoicesinthislist.Returnstheitemcontrolobject.Ifthisisamulti-columnlistbox,eachaddedListItemrepresentsoneselectablerow.Itstextandimagevaluesspecifythelabelinthefirstcolumn,andthesubitemspropertyspecifiesthelabelsintheadditionalcolumns.Parameter Type Description

type String Thetypeofthechildelement,thestring"item".












voidremove(what:Any)

Removesachilditemfromthelist.Parameter Type Description

what Any Theitemorchildtoremove,specifiedby0-basedindex,textvalue,orasaListItemobject.








Contents::Index

Class

ListItem Aniteminalistbox,drop-downlist,ortreeview.

Youcanspecifyinitialitemsinthecreationparameterswhencreatingtheparentlist.Createnewitemsusingtheadd()method(ListBox.add(),DropDownList.add(),TreeView.add())intheparentlistwithcontroltype="item",or,forDropDownListcontrols,type="separator".Foramulti-columnlistbox,theobjectrepresentsoneselectablerow.Itstextandimagevaluesspecifythelabelinthefirstcolumn,andthesubitemspropertyspecifiesthelabelsintheadditionalcolumns.

Hierarchy Object

ListItem


checked Boolean r/w Thecheckedstateofaniteminalist.Whentrue,theitemismarkedwiththeplatform-appropriatecheckmark.Whenfalse,nocheckmarkisdrawn,butspaceisreservedforitintheleftmargin,sothattheitemlinesupwithothercheckableitems.Whenundefined,nospaceisreservedforacheckmark.

expanded Boolean r/w TheexpansionstateofanitemoftypenodethatisachildofaTreeViewlistcontrol.Whentrue,theitemisintheexpandedstateanditschildrenareshown,whenfalse,itiscollapsedandchildrenarehidden.

image ScriptUIImage r/w Animageobjectforanicontodisplayintheitem.Whenspecified,theimageappropriatetotheselectionsstateisdrawntotheleftofthetextlabel.Iftheparentisamulti-columnlistbox,thisdescribesthelabelinthefirstcolumn.Labelsinadditionalcolumnsaredescribedbythesubitemsproperty.

index Number readonly The0-basedindexofthisitemintheitemscollectionofitsparentlistcontrol.

parent Object readonly Theparentelement,alistcontrol.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesoftheitem(propertiesusedonlywhentheelementiscreated).AListItemobjecthasnocreationproperties.

selected Boolean r/w Theselectionstateofthisitem.Whentrue,theitemispartoftheselectionforitsparentlist.Whenfalse,theitemisnotselected.Settotruetoselectthisiteminasingle-selectionlist,ortoaddittotheselectionarrayforamulti-selectionlist.

subItems Array readonly Whentheparentisamulti-columnListBox,thisdescribesthelabelsforthisselectablerowinadditionalcolumns.Aarrayof

JavaScriptobjectswhoselengthisonelessthanthenumberofcolumns.Thefirstmemberdescribesthelabelinthesecondcolumn.Eachmemberobjecthastwoproperties,ofwhichyoucanspecifyoneorboth:•text:Adisplaystringforthecorrespondinglabel.•image:AnScriptUIImageobjectforthecorrespondinglabel.

text String r/w Thelabeltexttodisplayfortheitem,alocalizablestring.Iftheparentisamulti-columnlistbox,thisdescribesthelabelinthefirstcolumn.Labelsinadditionalcolumnsaredescribedbythesubitemsproperty.

type String readonly Theelementtype.

Normally"item",butanitemwhoseparentisaDropDownListcontrolcanhavetype"separator".Aseparatoritemisnotmouse-sensitiveandisdrawnasahorizontallineacrossthedrop-downorpop-upmenu.

Elementof DropDownList.itemsDropDownList.selectionListBox.itemsListBox.selectionTreeView.itemsTreeView.selection

Usedin: voidTreeView.onCollapse(item:ListItem)voidTreeView.onExpand(item:ListItem)

Return ListItemDropDownList.add(type:String[,text:String])ListItemDropDownList.find(text:String)ListItemListBox(SUI).add(type:String[,text:String])ListItemListBox(SUI).find(text:String)ListItemTreeView.add(type:String[,text:String])ListItemTreeView.find(text:String)


Contents::Index

Class

Panel(SUI) Acontainerforothertypesofcontrols,withanoptionalframe.

Apanelcanspecifylayoutoptionsforitschildelements.Hidingapanelhidesallitschildren.Makingitvisiblemakesvisiblethosechildrenthatarenotindividuallyhidden.

QuickLinks add,addEventListener,dispatchEvent,hide,onDraw,remove,removeEventListener,show

Hierarchy Object

Panel(SUI)


alignChildren String r/w Specifieshowtoalignthechildelements.

alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrensettingfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependonthe

orientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,right


characters Number(min:0) r/w Reservespaceforthespecifiednumberofcharacters;affectscalculationofpreferredSize.


enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshavea

dimmedappearance.




justify String r/w Thedefaulttextjustificationstyleforchildtextelements.(default:left)Oneofleft,centerright.Justificationonlyworksifthisvalueissetoncreationoftheelement.

layout LayoutManager r/w Thelayoutmanagerforthiscontainer.Thefirsttimeacontainerobjectismadevisible,ScriptUIinvokesthislayoutmanagerbycallingits

layout()function.DefaultisaninstanceoftheLayoutManagerclassthatisautomaticallycreatedwhenthecontainerelementiscreated.

location Point r/w Theupperleftcornerofthiselement'sframerelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.

margins Number r/w Thenumberofpixelsbetweentheedgesofacontainerandtheoutermostchildelements.Youcanspecifydifferentmarginsforeachedgeofthecontainer.Thedefaultvalueisbasedonthetypeofcontainer,andischosentomatchthestandardAdobeUIguidelines.


minimumSize Dimension r/w Theminimumheightandwidthtowhichthe

elementcanberesized.

orientation String r/w Thelayoutorientationofchildreninacontainer.Interpretedbythelayoutmanagerforthecontainer.ThedefaultLayoutManageracceptsthe(case-insensitive)valuesrow,column,orstack.Forwindowandpanel,thedefaultiscolumn,andforgroupthedefaultisrow.Theallowedvaluesforthecontainer'salignChildrenanditschildren'salignmentpropertiesdependontheorientation.


preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUI

framework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontrol(propertiesusedonlywhentheelementiscreated).CreationpropertiesofaPanelobjectcaninclude:•borderStyle:Astringthatspecifiestheappearanceoftheborderdrawnaroundthepanel.Oneofblack,etched,grayraised,sunken.Defaultisetched•su1PanelCoordinatesPhotoshoponly.Whentrue,thispanelautomaticallyadjuststhepositionsofitschildrenforcompatabilitywithPhotoshopCS.Defaultisfalse,meaningthatthepaneldoesnotadjustthepositionsofitschildren,evenifthe

parentwindowhasautomaticadjustmentenabled.


spacing Number r/w Thenumberofpixelsseparatingonechildelementfromitsadjacentsiblingelement.Becauseeachcontainerholdsonlyasingleroworcolumnofchildren,onlyasinglespacingvalueisneededforacontainer.Thedefaultvalueis

basedonthetypeofcontainer,andischosentomatchstandardAdobeUIguidelines.

text String r/w Thetitleorlabeltext,alocalizablestring.

type String readonly Theelementtype;"panel".




Methods EventsvoidonDraw()Anevent-handlercallbackfunction,calledwhenthepanelisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.

InstancesObjectadd(type:String[,bounds:Bounds][,text:String][,propertiesObject])Addsachildelementtothiscontainer.Createsandreturnsanewcontrolorcontainerobjectandaddsittothechildrenofthisgroup.Parameter Type Description

type String Thetypeofthechildelement,asspecifiedforthetypeproperty.ControltypesarelistedintheJavaScriptToolsGuide.



properties Object Anobjectthatcontainsoneormorecreationpropertiesofthenewchild(propertiesusedonlywhentheelementiscreated).Thecreationpropertiesdependontheelementtype.Seepropertyofeachcontroltype.(Optional)



EventnamesarelistedintheJavaScriptToolsGuide.





voidremove(what:Any)Removesthespecifiedchildcontrolfromthisgroup'schildrenarray.Noerrorresultsifthechilddoesnotexist.Parameter Type Description








Contents::Index

Class

Point(SUI) DefinesthelocationofawindoworUIelement.Containsa2-

elementarray.Specifiestheoriginpointofanelementashorizontalandverticalpixeloffsetsfromtheoriginoftheelement'scoordinatespace.APointobjectiscreatedwhenyousetanelement'slocationproperty.YoucansetthepropertyusingaJavaScriptobjectwithpropertiesnamedxandy,oranarraywith2valuesintheorder[x,y].


left Number r/w Theleftcoordinate.


top Number r/w Thetopcoordinate.

x Number r/w Thehorizontalcoordinate,apixeloffsetfromtheoriginoftheelement'scoordinatespace.

y Number r/w Theverticalcoordinate,apixeloffsetfromtheoriginoftheelement'scoordinatespace.


Contents::Index

Class

Progressbar Ahorizontalbarwithanindicatorthatshowstheprogressofan

operation.Allprogressbarcontrolshaveahorizontalorientation.Thepropertycontainsthecurrentpositionoftheprogressindicator;thedefaultis0.Thereisaminvalueproperty,butitisalways0;attemptstosetittoadifferentvaluearesilentlyignored.

QuickLinks addEventListener,dispatchEvent,hide,onDraw,removeEventListener,show

Hierarchy Object

Progressbar


alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueof

theparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom•Fororientation=column:left,right•Fororientation=stack:bottomfill




graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedto

customizetheelement'sappearance,inresponsetotheonDraw()





maxvalue Number r/w Themaximumvalueintherange.Defaultis100.

minimumSize Dimension r/w Theminimumheight

andwidthtowhichtheelementcanberesized.

minvalue Number r/w Theminimumvalueintherange;always0.Ifsettoadifferentvalue,itisignored.



properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer

(propertiesusedonlywhentheelementiscreated).AProgressBarobjecthasnocreationproperties.Thethirdargumentofthemethodthatcreatesitistheinitialvalue(default0),andthefourthargumentisthemaximumvalueoftherange(default100).

size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.Ascriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthantheorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.

type String readonly Theelementtype,"progessbar".

value Number r/w Thecurrentpositionoftheindicator.Ifsettoavalueoutsidetherangespecifiedby0tomaxvalueautomaticallyresettotheclosestboundary.




Methods EventsvoidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.







BooleanremoveEventListener(eventName:String,Function[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.







Contents::Index

Class

RadioButton(SUI) Adual-statecontrol,groupedwithotherradiobuttons,ofwhichonly

onecanbeintheselectedstate.Showstheselectedstatewhenvalue=true,emptywhenCallstheonClick()callbackifthecontrolisclickedorifitsmethodiscalled.


Hierarchy Object

RadioButton(SUI)


active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButtonwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.

alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenfortheparent

container.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom•Fororientation=column:left,•Fororientation=stack:bottomfill


characters Number(min:0) r/w Anumberofcharactersforwhich

toreservespacewhencalculatingthepreferredsizeoftheelement.



graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw



justify String r/w Thedefaulttextjustificationstyleforchildtextelements.(default:Oneofrightonlyworksifthisvalueissetoncreationoftheelement.





preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueis

establishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).ARadioButtonobjecthasnocreationproperties.Thethirdargumentofthemethodthatcreatescanbethelabeltext.


size Dimension r/w Thecurrent

dimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.Ascriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthantheorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.

text String r/w Thelabeltextforthisbutton,alocalizablestring.

type String readonly Theelementtype;"radiobutton".

value Boolean r/w Theselectionstateofthisbutton,selectedwhentrue.

visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildren

arealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.







voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement's

shortcutKeysequenceistypedintheactivewindow.InWindowsonly.








eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingdefault,simulatestheonChangeedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)

BooleanremoveEventListener(eventName:StringFunction[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description






Contents::Index

Class

ScriptUI AglobalclasscontainingcentralinformationaboutScriptUI.Notinstantiable.

QuickLinks getResourceText,newFont,newImage


Alignment String readonly Collectstheenumeratedvaluesthatcanbeusedinthealignmentpropertiesofcontrolsandcontainers.Predefinedalignmentvaluesare:TOP,BOTTOM,LEFT,RIGHT,FILL,CENTER

FontStyle Object readonly CollectstheenumeratedvaluesthatcanbeusedasthestyleargumenttotheScriptUI.newFont()PredefinedstylesareREGULAR,BOLD,ITALIC,BOLDITALIC.

applicationFonts Object readonly Thefontconstantsdefinedbythehostapplication.

compatibility Object readonly Anobjectwhosepropertiesarethenamesofcompatabilitymodessupportedbythehostapplication.ThepresenceofScriptUI.compatability.su1PanelCoordinatesmeansthattheapplicationallowsbackwardcompatibilitywiththecoordinatesystemofPanelelementsinScriptUIversion1.

coreVersion String readonly AstringcontainingtheinternalversionnumberoftheScriptUImodule.

environment Environment readonly AnobjectwhosepropertiesdefineattributesoftheenvironmentinwhichScriptUIoperates.

events Events readonly AnobjectwhosepropertiesandmethodsprovideaccesstoobjectsusedintheScriptUIeventsystem.

Itcontainsonefunction,allowsyoutocreateeventobjectsinordertosimulateuser-interactionevent

frameworkName String readonly AstringcontainingthenameoftheUIcomponentframeworkwithwhichthisversionofScriptUIiscompatible.

version Any readonly AstringcontainingtheversionnumberoftheScriptUIcomponentframework

Methods StringgetResourceText(text:String)Findsandreturnstheresourceforagiventextstringfromthehostapplication'sresourcedata.Ifnostringresourcematchesthegiventext,thetextitselfisreturned.Parameter Type Description

text String Thetexttomatch.

ScriptUIFontnewFont(name:String,style:String|NumberCreatesanewfontobjectforuseintextcontrolsandtitles.Parameter Type Description

name String Thefontname,orthefontfamilyname.

style String|Number

Thefontstyle;canbestring,oroneofthevaluesofScriptUI.FontStyle.

size Number Thefontsizeinpoints.

ScriptUIImagenewImage(normal:String[,disabled:String][,String])Loadsanewimagefromresourcesordiskfilesintoanimageobject.Createsanewglobalimageobjectforuseincontrolsthatcandisplayimages,loadingtheassociatedimagesfromthespecifiedresourcesorimagefiles.Parameter Type Description

normal String Theresourcenameorthediskfilepathtotheimageusedforthenormalstate.

disabled String Theresourcename,orthediskfilepathtotheimageusedforthedisabledstate.(Optional)

pressed String Theresourcename,orthefile-systempathtotheimageusedforthepressedstate.(Optional)

rollover String Theresourcename,orthefile-systempathtotheimageusedfortherolloverstate.(Optional)


Contents::Index

Class

ScriptUIBrush Apaintingbrushthatencapsulatesacolororpatternusedtofillpaths.

CreatewithScriptUIGraphics.newBrush().Useasavalueofproperties,andpassasanargumenttothefillPath()


color ArrayofNumber

readonly Thebrushcolor.ThepaintcolortousewhenthetypeisSOLID_COLOR.Anarrayintheform[R,B,G,A]specifyingthered,green,bluevaluesofthecolorandtheopacity(alphachannel)valueasnumbersintherange[0.0..1.0].Anopacityof0isfullytransparent,andanopacityof1isfullyopaque.

theme String readonly Thethemename.ThenameofacolorthemetousefordrawingwhenthetypeisTHEME_COLOR.Themecolorsaredefinedbythehostapplication.

type Number readonly Thebrushtype,solidortheme.Oneoftheseconstants:ScriptUIGraphics.BrushType.SOLID_COLORorScriptUIGraphics.BrushType.THEME_COLOR

Elementof ScriptUIGraphics.backgroundColorScriptUIGraphics.disabledBackgroundColor

Usedin: voidScriptUIGraphics.fillPath(brush:ScriptUIBrush

Return ScriptUIBrushScriptUIGraphics.newBrush(typeNumber|String)


Contents::Index

Class

ScriptUIFont Encapsulatesthequalitiesofafontusedtodrawtextintoa

control.CreatewiththenewFont()method.UsedasavalueofPassedasanargumenttodrawString()andmeasureString()


family String readonly Thefontfamilyname.

name String readonly Thecompletefontname,consistingofthefamilyandstyle,ifspecified.

size Number readonly Thefontpointsize.

style Object readonly Thefontstyle.OneoftheconstantsinScriptUIGraphics.FontStyle

substitute String readonly Thenameofasubstitutionfont,afallbackfonttosubstituteforthisfontiftherequestedfontfamilyorstyleisnotavailable.

Elementof ScriptUIGraphics.font

Usedin: voidScriptUIGraphics.drawString(text:String,penScriptUIPen,x:Number,y:Number[,font:ScriptUIFont])

DimensionScriptUIGraphics.measureString(text:font:ScriptUIFont][,boundingWidth:Number

Return ScriptUIFontScriptUI.newFont(name:String,style|Number,size:Number)


Contents::Index

Class

ScriptUIGraphics Anobjectusedtodrawcustomgraphics,foundinthe

ofwindow,container,andcontrolobjects.Allowsascripttocustomizeaspectsoftheelement'sappearance,suchasthecolorandfont.UseanonDrawcallbackfunctiontosetthesepropertiesorcallthefunctions.Allmeasurementsareinpixels.

QuickLinks closePath,drawFocusRing,drawImage,drawOSControlellipsePath,fillPath,lineTo,measureStringnewPath,newPen,rectPath,strokePath


backgroundColor ScriptUIBrush

currentPath ScriptUIPath

currentPoint Point

disabledBackgroundColor ScriptUIBrush

disabledForegroundColor ScriptUIPen

font ScriptUIFont

foregroundColor ScriptUIPen


BrushType Object readonly ContainstheenumeratedconstantsforthetypeargumentofTypeconstantsare:SOLID_COLOR,THEME_COLOR.

PenType Object readonly ContainstheenumeratedconstantsforthetypeargumentofTypeconstantsare:SOLID_COLOR,

THEME_COLOR.

Methods InstancesvoidclosePath()Closesthecurrentpath.Definesalinefromthecurrentpostion(currentPointofthecurrentpath(thevalueofcurrentPath

voiddrawFocusRing(left:Number,topheight:Number)Drawsafocusringwithinaregionofthiselement.Parameter Type Description

left Number Theleftcoordinateoftheregion.Valueisrelativetotheoriginofthiselement.

top Number Thetopcoordinateoftheregion.Valueisrelativetotheoriginofthiselement.

width Number Thewidthoftheregioninpixels.

height Number Theheightoftheregioninpixels.

voiddrawImage(image:ScriptUIImagewidth:Number][,height:Number])Drawsanimagewithinagivenregionoftheelement.Usestheversionoftheimagethatisappropriatetotheelement'scurrentstate.Parameter Type Description

image ScriptUIImage Theimagetodraw.Thisobjectcontainsdifferentversionsofanimageappropriatetovariouselementstates,suchasadimmedversionforthedisabledstate.

left Number Theleftcoordinateoftheregion,relativetotheoriginofthiselement.

top Number Thetopcoordinateoftheregion,relativetotheoriginofthiselement.

width Number Thewidthinpixels.Ifprovided,theimageisstretchedorshrunktofit.Ifomitted,usestheoriginalimagewidth.(Optional)

height Number Theheightinpixels.Ifprovided,theimageisstretchedorshrunktofit.Ifomitted,usestheoriginalimageheight.(Optional)

voiddrawOSControl()Drawtheplatform-specificcontrolassociatedwiththiselement.

voiddrawString(text:String,pen:ScriptUIPenNumber[,font:ScriptUIFont])Drawastringoftextstartingatagivenpointinthiselement,usingagivendrawingpenandfont.Parameter Type Description

text String Thetextstring.

pen ScriptUIPen Thedrawingpentouse.

x Number Theleftcoordinate,relativetotheoriginofthiselement.

y Number Thetopcoordinate,relativetotheoriginofthiselement.

font ScriptUIFont Thefonttouse.Defaultisthethisobject.(Optional)

PointellipsePath(left:Number,top:NumberNumber)DefinesanellipticalpathwithinagivenrectangularareainthecurrentPathobject,whichcanbefilledusingstrokePath().ReturnsaPointobjectfortheupperleftcornerofthearea,whichisthenewcurrentPoint.Parameter Type Description

left Number Theleftcoordinateoftheregion,relativetothe

originofthiselement.

top Number Thetopcoordinateoftheregion,relativetotheoriginofthiselement.

width Number Thewidthoftheregioninpixels.

height Number Theheightoftheregioninpixels.

voidfillPath(brush:ScriptUIBrush[,pathFillsapathusingagivenpaintingbrush.Parameter Type Description

brush ScriptUIBrush Thebrushobjectthatdefinesthefillcolor.

path ScriptUIPath Thepathobject.DefaultisthecurrentPath.

PointlineTo(x:Number,y:Number)AddsapathsegmenttothecurrentPath.ThelineisdefinedfromthecurrentPointpoint.ReturnsthePointobjectforthedestinationpoint,whichbecomesthenewvalueofcurrentPoint.Parameter Type Description

x Number TheXcoordinateforthedestinationpoint,relativetotheoriginofthiselement.

y Number TheYcoordinateforthedestinationpoint,relativetotheoriginofthiselement.

DimensionmeasureString(text:String[,boundingWidth:Number])Calculatesthesizeneededtodisplayastringusingthegivenfont.ReturnsaDimensionobjectthatcontainstheheightandwidthofthestringinpixels.Parameter Type Description

text String Thetextstringtomeasure.

font ScriptUIFont Thefonttouse.Defaultisthefont

valueinthisobject.

boundingWidth Number Theboundingwidth.(Optional)

PointmoveTo(x:Number,y:Number)AddsagivenpointtothecurrentPath,andmakesitthecurrentdrawingposition.ReturnsthePointobjectwhichisthenewvalueofParameter Type Description

x Number TheXcoordinateforthenewpoint,relativetotheoriginofthiselement.

y Number TheYcoordinateforthenewpoint,relativetotheoriginofthiselement.

ScriptUIBrushnewBrush(type:NumberString)Createsanewpaintingbrushobject.Parameter Type Description

type Number Thebrushtype,solidortheme.OneoftheconstantsScriptUIGraphics.BrushType.SOLID_COLORorScriptUIGraphics.BrushType.THEME_COLOR

color ArrayofNumber|String

Thebrushcolor.

•IftypeisSOLID_COLOR,thecolorexpressedasanarrayofthreeorfourvalues,intheform[R,B,G,A]specifyingthered,green,andbluevaluesofthecolorand,optionally,theopacity(alphachannel).Allvaluesarenumbersintherange[0.0..1.0].Anopacityof0isfullytransparent,andanopacityof1isfullyopaque.•IfthetypeisTHEME_COLOR,thenamestringofthetheme.Themecolorsaredefinedbythehostapplication.

ScriptUIPathnewPath()

Createsanew,emptypathobject.ReplacesanyexistingpathincurrentPath

ScriptUIPennewPen(type:Number,colorwidth:Number)Createsanewdrawingpenobject.Parameter Type Description

type Number Thepentype,solidortheme.OneoftheconstantsScriptUIGraphics.PenType.SOLID_COLORScriptUIGraphics.PenType.THEME_COLOR

color ArrayofNumber|String

Thepencolor.

•IftypeisSOLID_COLOR,thecolorexpressedasanarrayofthreeorfourvalues,intheform[R,B,G,A]specifyingthered,green,andbluevaluesofthecolorand,optionally,theopacity(alphachannel).Allvaluesarenumbersintherange[0.0..1.0].Anopacityof0isfullytransparent,andanopacityof1isfullyopaque.•IfthetypeisTHEME_COLOR,thenamestringofthetheme.Themecolorsaredefinedbythehostapplication.

width Number Thewidthofthepenlineinpixels.Thelineiscenteredaroundthecurrentpoint.Forexample,ifthevalueis2,drawingalinefrom(0,10)to(5,10)paintsthetworowsofpixelsdirectlyaboveandbelowy-position10.

PointrectPath(left:Number,top:NumberNumber)DefinesarectangularpathinthecurrentPathTherectanglecanbefilledusingfillPath()ReturnsthePointobjectfortheupperleftcorneroftherectangle,whichbecomesthenewvalueofcurrentPoint.Parameter Type Description

left Number Theleftcoordinaterelativetotheoriginofthis

element.

top Number Thetopcoordinaterelativetotheoriginofthiselement.

width Number Thewidthinpixels.

height Number Theheightinpixels.

voidstrokePath(pen:ScriptUIPen[,pathStrokesthepathsegmentsofapathwithagivendrawingpen.Parameter Type Description

pen ScriptUIPen Thedrawingpenthatdefinesthecolorandlinewidth.

path ScriptUIPath Thepathobject.DefaultisthecurrentPath.(Optional)

Elementof Button.graphicsCheckbox.graphicsDropDownList.graphicsEditText.graphicsGroup.graphicsIconButton.graphicsListBox.graphicsPanel.graphicsProgressbar.graphicsRadioButton.graphicsScrollbar.graphicsSlider.graphicsStaticText.graphicsTreeView.graphicsWindow.graphics


Contents::Index

Class

ScriptUIImage Encapsulatesasetofimagesthatcanbedrawn

intoacontrol.Differentimagescanreflectthecurrentstate,suchasadimmedversionforadisabledcontrol.CreatewiththenewImage()method.PassedasanargumenttodrawImage().


format String readonly Theimageformat.Oneof:resource,JPEG,GIF,TIFF,PNG,orPICT(Macintosh).

name String readonly Theimagename.Eitherthefilename,ortheresourcename.

pathname String readonly Thefullpathtothefilethatcontainstheimage.

size Dimension readonly Theimagesizeinpixels.

Elementof IconButton.imageListItem.image

Usedin: voidScriptUIGraphics.drawImage(image:

ScriptUIImage,left:Number,top:Number[,width:Number][,height:Number])

Return ScriptUIImageScriptUI.newImage(normal:String[,disabled:String][,pressed:String][,rollover:String])


Contents::Index

Class

ScriptUIPath Ahelperobjectthatencapsulatesadrawingpath

forafiguretobedrawnintoawindoworcontrol.CreatewiththenewPath(),moveto(),lineto(),rectPath(),andellipsePath()methods.UsedasvalueofcurrentPath,whereitisacteduponbymethodssuchasclosePath().PassasoptionalargumenttofillPath()andstrokePath(),whichotherwiseactuponthecurrentpath.

Elementof ScriptUIGraphics.currentPath

Usedin: voidScriptUIGraphics.fillPath(brush:ScriptUIBrush[,path:ScriptUIPath])

voidScriptUIGraphics.strokePath(pen:ScriptUIPen[,path:ScriptUIPath])

Return ScriptUIPathScriptUIGraphics.newPath()


Contents::Index

Class

ScriptUIPen Adrawingpenthatdefinesacolorandlinewidthusedtostrokepaths.

CreatewithScriptUIGraphics.newPen().Useasavalueofproperties,andpassasanargumenttodrawString()and


color ArrayofNumber

readonly Thepencolor.ThepaintcolortousewhenthetypeisSOLID_COLOR.Anarrayintheform[R,B,G,A]specifyingthered,green,bluevaluesofthecolorandtheopacity(alphachannel)valueasnumbersintherange[0.0..1.0].Anopacityof0isfullytransparent,andanopacityof1isfullyopaque.

lineWidth Number(min:1)

r/w Thepixelwidthofthedrawingline.

theme String readonly Thethemename.ThenameofacolorthemetousefordrawingwhenthetypeisTHEME_COLOR.Themecolorsaredefinedbythehostapplication.

type String readonly Thepentype,solidortheme.Oneoftheseconstants:ScriptUIGraphics.PenType.SOLID_COLORorScriptUIGraphics.PenType.THEME_COLOR

Elementof ScriptUIGraphics.disabledForegroundColorScriptUIGraphics.foregroundColor

Usedin: voidScriptUIGraphics.drawString(text:String,pen:y:Number[,font:ScriptUIFont])

voidScriptUIGraphics.strokePath(pen:ScriptUIPen

Return ScriptUIPenScriptUIGraphics.newPen(type:NumberNumber|String,width:Number)


Contents::Index

Class

Scrollbar Ascrollbarwithadraggablescrollindicatorandstepperbuttonsto

movetheindicator.Thescrollbarcontrolhasahorizontalorientationifthewidthisgreaterthantheheightatcreationtime,orverticalifitsheightisgreaterthanitswidth.CallstheonChange()callbackafterthepositionoftheindicatorischangedorifitsnotify()methodiscalled.CallstheonChanging()callbackrepeatedlywhiletheuserismovingtheindicator.ScrollbarsareoftencreatedwithanassociatedEditTextfieldtodisplaythecurrentvalueofthescrollbar,andtoallowsettingthescrollbar'spositiontoaspecificvalue.

QuickLinks addEventListener,dispatchEvent,hide,notify,onActivate,onChanging,onDeactivate,onDraw,onShortcutKey,removeEventListener,show

Hierarchy Object

Scrollbar



alignment String r/w Thealignmentstyleforthiselement.If

defined,thisvalueoverridesthealignChildrenfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,leftfill

bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsbounds

property,andvice-versa.






jumpdelta Number(min:0) r/w Theamountto

incrementordecrementascrollbarindicator'spositionwhentheuserclicksaheadorbehindthemoveableelement.Defaultis20%oftherangebetweenthemaxvalueandminvaluepropertyvalues.



maxvalue Number r/w Themaximumvalueallowedintheproperty.Togetherwithminvalue,setsthescrollingrange.Defaultis100.


minvalue Number r/w Theminimumvalueallowedintheproperty.Togetherwithmaxvalue,setsthescrollingrange.Defaultis0.



properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonly

whentheelementiscreated).AScrollbarobjecthasnocreationproperties.Thethirdargumentofthemethodthatcreatesitistheinitialvalue,andthefourthandfifthargumentsaretheminimumandmaximumvaluesoftherange.


size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizeorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,

bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.

stepdelta Number(min:0) r/w Theamountbywhichtoincrementordecrementascrollbarelement'spositionwhentheuserclicksastepperbutton.

type String readonly Theelementtype,"scrollbar".

value Number r/w Thecurrentpositionoftheindicator.Ifsettoavalueoutsidetherangespecifiedbyminvalueandmaxvalue,itisautomaticallyresettotheclosestboundary.



windowBounds Bounds readonly Theboundsofthis

elementrelativetothetop-levelparentwindow.


voidonChange()Anevent-handlercallbackfunction,calledwhentheuserhasfinisheddraggingthepositionindicator,orhasclickedthecontrol.

voidonChanging()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementisintheprocessofchangingThehandleriscalledforanymotionofthepositionindicatorwhilethiscontrolhastheinputfocus.




InstancesBooleanaddEventListener(eventName:String,handler:Function

capturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description







eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingdefault,simulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrols

thatsupportthatevent.(Optional)







Contents::Index

Class

Slider Asliderbarthatindicatesanumericvaluewithamoveableposition

indicator.Allslidercontrolshaveahorizontalorientation.CallstheonChange()callbackafterthepositionoftheindicatorischangedorifitsnotify()methodiscalled.CallstheonChanging()callbackrepeatedlywhiletheuserismovingtheindicator.Thevaluepropertycontainsthecurrentpositionoftheindicatorwithintherangeofminvaluetomaxvalue.

QuickLinks addEventListener,dispatchEvent,hide,notify,onActivate,onChangeonChanging,onDeactivate,onDraw,onShortcutKey,removeEventListener,show

Hierarchy Object

Slider



alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthe

alignChildrensettingfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,rightfill







location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationis

definedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.


maxvalue Number r/w Themaximumvalueallowedinthevalueproperty.Togetherwithminvalue,setstherange.Defaultis100.


minvalue Number r/w Theminimumvalueallowedinthevalueproperty.Togetherwithmaxvalue,setstherange.Defaultis0.


preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUI

frameworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).ASliderobjecthasnocreationproperties.Thethirdargumentoftheadd()methodthatcreatesitistheinitialvalue,andthefourthandfifthargumentsaretheminimumandmaximumvaluesoftherange.

shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()callbackforthiselement(inWindows

only).


type String readonly Theelementtype,"slider".

value Number r/w Thecurrentpositionoftheindicator.Ifsettoavalueoutsidetherangespecifiedbyminvalueandmaxvalue,itisautomaticallyresettotheclosestboundary.

visible Boolean r/w Trueifthiselementis

shown,falseifitishidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.




voidonChange()Anevent-handlercallbackfunction,calledwhentheuserhasfinisheddraggingthepositionindicator,orhasclickedthecontrol.

voidonChanging()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementisintheprocessofchangingThehandleriscalledforanymotionofthepositionindicatorwhilethiscontrolhastheinputfocus.

voidonDeactivate()Anevent-handlercallbackfunction,calledwhentheelementlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviously

activecontroltoanothercontrol.



InstancesBooleanaddEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description




EventdispatchEvent()

Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.










v3.0.3i

Class

StaticText(SUI) Atextlabelthattheusercannotchange.

QuickLinks addEventListener,dispatchEvent,hide,notify,onDraw,onShortcutKey,removeEventListener,show

Hierarchy Object

StaticText(SUI)


active Boolean r/w Alwaysfalse.Thiselementcannothaveinputfocus.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.

alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenfortheparentcontainer.Thiscanbeasinglestring,which

indicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right•Fororientation=stack:bottom,leftfill


characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeofthe

element.






justify String r/w Thetextjustificationstyle.(default:

Oneofleftright.Justificationonlyworksifthisvalueissetoncreationoftheelement.





preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuch

attributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).CreationpropertiesofaStaticTextobjectcaninclude:•multiline:Whenfalse(thedefault),thecontroldisplaysasinglelineoftext.Whentrue,thecontroldisplaysmultiplelines,inwhichcasethetextwrapswithinthewidthofthecontrol.•scrolling:Whenfalse(thedefault),thedisplayedtextcannotbescrolled.Whentrue,thedisplayed

textcanbeverticallyscrolledusingtheUpArrowandDownArrow;thiscaseimpliesmultiline=true.



text String r/w Thetexttodisplay,a

localizablestring.

type String readonly Theelementtype,"statictext".




Methods EventsvoidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.


InstancesBooleanaddEventListener(eventName:String,handler:

capturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description







eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingdefault,simulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrols

thatsupportthatevent.(Optional)







Contents::Index

Class

TreeView Ahierarchicallistwhoseitemscancontainchilditems.

TheListItemchildrenofthiscontrol(intheitemsarray)canbeoftypenode,whichmeansthattheycancontainchilditems.Anitemwithchilditemscanexpanded,sothatthechilditemsaredisplayed,orcollapsed,sothatthechilditemsarehiddenIndividualitemscanbeselectedatanylevelofthetree.

QuickLinks add,addEventListener,dispatchEvent,find,hide,notify,onActivateonChange,onCollapse,onDeactivate,onDraw,onExpand,onShortcutKey,remove,removeAll,removeEventListener,

Hierarchy Object

TreeView



alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenfortheparent

container.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,•Fororientation=stack:bottom,leftfill







itemSize Dimension r/w Thewidthandheightinpixelsofeachiteminthelist.Usedbyauto-layouttodeterminethepreferredSize

list,ifnototherwisespecified.Ifnotsetexplicitly,thesizeofeachitemissettomatchthelargestheightandwidthamongallitemsinthelist

items ArrayofListItem readonly Thearrayoftop-levelitemsdisplayedinthelist.Accessthisarraywitha0-basedindex.Toobtainthenumberofitemsinthelist,useitems.lengthobjectsarecreatedwhenitemsarespecifiedoncreationoftheparentlistobject,orafterwardusingthelistcontrol'sadd()method.






properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontrol(propertiesusedonlywhentheelementiscreated).CreationpropertiesofaListBoxobjectcan

include:•items:Anarrayofstringsforthetextofeachtop-levellistitem.Anitemobjectiscreatedforeachitem.Anitemwiththetextstring"-"createsaseparatoritem.Supplythisproperty,ortheargumenttothemethod,notboth.ThisformismostusefulforelementsdefinedusingResourceSpecifications.

selection ListItem r/w Thecurrentlyselectedlistitem.Settingthisvaluecausestheselecteditemtobehighlightedandtobescrolledintoviewifnecessary.Ifnoitemsareselected,thevalueisnull.Settonulltodeselectallitems.Youcansetthevalueusingtheindexofanitem,ratherthananobjectreference.Ifsettoanindexvaluethatisoutofrange,theoperationisignored.Whensetwithanindexvalue,thepropertystill

returnsanobjectreference.



type String readonly Theelementtype,"treeview".

visible Boolean r/w Trueifthiselementisshown,falseifitis

hidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.





voidonCollapse(item:ListItem)Anevent-handlercallbackfunction,calledwhentheusercollapses(closes)anexpandednodeinthetreeview.Parameter Type Description

item ListItem TheListItemnodethatcollapsed.

voidonDeactivate()Anevent-handlercallbackfunction,calledwhentheelementlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviously

activecontroltoanothercontrol.


voidonExpand(item:ListItem)Anevent-handlercallbackfunction,calledwhentheuserexpands(opens)acollapsednodeinthetreeview.Parameter Type Description

item ListItem TheListItemnodethatexpanded.


InstancesListItemadd(type:String[,text:String])Addsanitemtothetop-levelchoicesinthislist.Returnstheitemcontrolobject.Parameter Type Description

type String Thetypeofthechildelement,thestring"item".












voidremove(what:Any)

Removesachilditemfromthelist.Parameter Type Description

what Any Theitemorchildtoremove,specifiedby0-basedindexinthetop-levelitemlist,textvalue,orasaListItemobject.








Contents::Index

Class

UIEvent Encapsulatesinputeventinformationforaneventthat

propagatesthroughacontainerandcontrolhierarchy.ImplementsW3Cstandardeventhandling.Thisobjectispassedtoafunctionthatyouregistertorespondtoeventsofacertaintypethatoccurinawindoworcontrol.UsewindowObj.addEventListener()orcontrolObj.addEventListener()toregisterahandlerfunction.

QuickLinks UIEvent,initEvent,initUIEvent,preventDefault,stopPropagation


bubbles Boolean readonly Trueiftheeventisofatypethatbubbles.

cancelable Boolean readonly TrueifthedefaultactionassociatedwiththeeventcanbecanceledwithpreventDefault().

captures Boolean readonly Trueifthiseventcanbecaptured.

currentTarget Boolean readonly Theeventtargetobjectwhichiscurrentlyhandlingtheevent.Duringcapturingandbubbling,thisisdifferentfromthepropertytarget.

detail Any readonly Theclickcountforamouse-clickevent.

eventPhase String readonly Thecurrentphaseofeventpropagation;one

ofnone,target,capture,bubble.

target Object readonly Theeventtargetobjectforthisevent.

timeStamp Date readonly Thedateandtimeatwhichtheeventoccurred.

type String readonly Thenameoftheeventthatthisobjectrepresents.EventtypesarelistedintheJavaScriptToolsGuide.

view Any readonly TheScriptUIelementthatthiseventrelatesto.

Methods ConstructorUIEventUIEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,view:Object][,detail:Number])Createsanevent.TheUIEventobjectisnormallycreatedbyScriptUIandpassedtoyoureventhandler.However,youcansimulateauseractionbyconstructinganeventobjectandsendingittoatargetobject'sdispatchEvent()function.Parameter Type Description

type String Theeventtype.SeeUIEvent.typeproperty.

captures Boolean Settotrueifthiseventcanbecaptured.(default:false)

bubbles Boolean Settotrueiftheeventbubbles.(default:false)

view Object TheScriptUIelementthatthiseventrelatesto.(Optional)

detail Number Theclickcountforamouse-clickevent.(Optional)

InstancesvoidinitEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,cancelable:Boolean=false])InitializesaUIeventasacoreW3Cevent.Parameter Type Description

type String Theeventtype.



cancelable Boolean Settotrueifthedefaultactioniscancelable.(default:false)

voidinitUIEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,view:Object][,detail:Number])Initializesanevent.Parameter Type Description

type String Theeventtype.



view Object TheScriptUIelementthatthiseventrelatesto.(Optional)

detail Number Theclickcountforamouse-clickevent.(Optional)

voidpreventDefault()Preventsthedefaultactionassociatedwiththiseventfrombeingcalled.

voidstopPropagation()Stopsthepropagationofthisevent.

Return UIEventUIEvent.UIEvent(type:String[,captures:Boolean=false][,bubbles:Boolean=false][,view:Object][,detail:Number])

UIEventWindow(SUI).dispatchEvent()


Contents::Index

Class

Window(SUI) Theinstancerepresentsatop-levelwindowordialogbox,which

containsuser-interfaceelements.ThegloballyavailableWindowobjectprovidesaccesstopredefinedandscript-definedwindows.

QuickLinks Window,add,addEventListener,alert,center,close,confirm,dispatchEvent,find,hide,notify,onActivate,onClose,onDeactivateonMove,onMoving,onResize,onResizing,onShortcutKey,onShowprompt,remove,removeEventListener,show

Hierarchy Object

Window(SUI)


active Boolean r/w Settotruetomakethiswindowactive.

•Amodaldialogthatisvisibleisbydefinitiontheactivedialog.•Anactivepaletteisthefront-mostwindow.•Anactivecontrolistheonewithfocus'thatis,theonethatacceptskeystrokes,orinthecaseofaButtonselectedwhentheusertypesReturnorEnter.

alignChildren String r/w Tellsthelayoutmanagerhowunlike-

sizedchildrenofthiscontainershouldbealignedwithinacolumnorrow.Orderofcreationdetermineswhichchildrenareatthetopofacolumnortheleftofarow;theearlierachildiscreated,thecloseritistothetoporleftofitscolumnorrow.Ifdefined,alignmentforachildelementoverridesthealignChildrenfortheparentcontainer.Seealignmentpropertyforvalues.

alignment String r/w Thealignmentstyleforchildelementsofacontainer.Ifdefined,thisvalueoverridesthealignChildrenfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependonthe

orientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,

bounds Bounds r/w Theboundsofthewindow'sdrawablearea,excludingtheframe,inscreencoordinates.

cancelElement Object r/w Forwindowsoftypedialog,theUIelementtonotifywhentheuserpressesacancellationkeycombination.ThecancellationkeyistheEsckey.Bydefault,looksforabuttonwhosenameortextis"cancel"(casedisregarded).

characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeofthewindow.

children ArrayofObject readonly ThecollectionofUIelementsthathave

beenaddedtothiscontainer.Anarrayindexedbynumberorbyastringcontaininganelement'sname.Thelengthpropertyofthisarrayisthenumberofchildelementsforcontainerelements,andiszeroforcontrols.

defaultElement Object r/w Forwindowsoftypedialog,theUIelementtonotifywhentheuserpressesaEnterkey.Bydefault,looksforabuttonwhosenameortextis"ok"(casedisregarded).


frameBounds Bounds readonly Theboundsofthewindowframeinscreencoordinates.Theframeconsistsofthetitlebarandbordersthatenclosethecontentregionofa

window,dependingonthewindowingsystem.

frameLocation Point r/w Thetopleftcornerofthewindowframeinscreencoordinates.Thesameas[frameBounds.x,frameBounds.y].Setthisvaluetomovethewindowframetothespecifiedlocationonthescreen.TheframeBoundschangesaccordingly.

frameSize Dimension readonly Thesizeandlocationofthewindow'sframeinscreencoordinates.

graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizethewindow'sappearance,inresponsetotheonDrawevent.


indent Number(min:0) r/w Thenumberofpixelstoindenttheelement.

justify String r/w Thedefaulttextjustificationstyleforchildtextelements.(default:left)Oneofleft,centerright.Justification

onlyworksifthisvalueissetoncreationoftheelement.

layout LayoutManager r/w Thelayoutmanagerforthiscontainer.Thefirsttimeacontainerobjectismadevisible,ScriptUIinvokesthislayoutmanagerbycallingitslayout()function.DefaultisaninstanceoftheLayoutManagerclassthatisautomaticallycreatedwhenthecontainerelementiscreated.

location Point r/w Theupperleftcornerofthewindow'sdrawablearea.Thesameas[bounds.x,bounds.y].

margins Number r/w Thenumberofpixelsbetweentheedgesofacontainerandtheoutermostchildelements.Youcanspecifydifferentmarginsforeachedgeofthecontainer.Thedefaultvalueisbasedonthetypeofcontainer,andischosentomatchthestandardAdobeUIguidelines.

maximized Boolean r/w Trueifthewindowisexpanded.

maximumSize Dimension r/w Thelargestrectangletowhichthewindowcanberesized.

minimized Boolean r/w Trueifthewindowisminimizedoriconified.

minimumSize Dimension r/w Thesmallestrectangletowhichthewindowcanberesized.

opacity Number r/w Theopacityofthewindow,intherange[0..1].(default:Avalueof1.0(thedefault)makesthewindowcompletelyopaque,avalueof0makesitcompletelytransparent.Intermediatevaluesmakeitpartiallytransparenttoanydegree.

orientation String r/w Thelayoutorientationofchildreninacontainer.Interpretedbythelayoutmanagerforthecontainer.ThedefaultLayoutManageracceptsthe(case-insensitive)valuesrow,column,orstack.Forwindowandpanel,thedefaultis

column,andforgroupthedefaultisrow.Theallowedvaluesforthecontainer'salignChildrenchildren'salignmentpropertiesdependontheorientation.

parent Object readonly Theimmediateparentelement.

preferredSize Dimension r/w Thepreferredsizeofthewindow.Usedinautomaticlayoutandresizing.Tosetaspecificvalueforonlyonedimension,specifytheotherdimensionas-1.

properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).CreationpropertiesofaWindowobjectcaninclude:•resizeable:Whentrue,thewindowcanberesizedbytheuser.Defaultisfalse.•su1PanelCoordinates:Photoshoponly.Whentrue,thechildpanelsofthiswindowautomaticallyadjustthepositionsoftheir

childrenforcompatabilitywithPhotoshopCS(inwhichtheverticalcoordinatewasmeasuredfromoutsidetheframe).Defaultisfalse.Individualpanelscanoverridetheparentwindow'ssetting.•closeButton:Bridgeonly.Whentrue,thetitlebarincludesabuttontoclosethewindow,iftheplatformandwindowtypeallowit.Whenfalse,itdoesnot.Defaultistrue.Notusedfordialogs.•maximizeButton:Bridgeonly.Whentrue,thetitlebarincludesabuttontoexpandthewindowtoitsmaximumsize(typically,theentirescreen),iftheplatformandwindowtypeallowit.Whenfalse,itdoesnot.Defaultisfalsefortypepalette,truefortypewindow.Notusedfordialogs.

shortcutKey String r/w Thekeypresscombinationthatinvokesthiselement'sonShortcutKey()

callback.

size Dimension r/w Thecurrentsizeandlocationofthecontentareaofthewindowinscreencoordinates.

spacing Number r/w Thenumberofpixelsseparatingonechildelementfromitsadjacentsiblingelement.Becauseeachcontainerholdsonlyasingleroworcolumnofchildren,onlyasinglespacingvalueisneededforacontainer.Thedefaultvalueisbasedonthetypeofcontainer,andischosentomatchstandardAdobeUIguidelines.

text String r/w Thetitle,label,ordisplayedtext,alocalizeablestring.Doesnotapplytocontainersoftypegroup.

type String readonly Theelementtype;"dialog","palette",or"window".

visible Boolean r/w Whentrue,theelementisshown,whenfalseitishidden.Whenacontainerishidden,itschildrenare

alsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.


windowBounds Bounds readonly Theboundsofthiswindowrelativetothetop-levelparentwindow.


frameworkName String readonly Deprecated.UseScriptUI.frameworkNameinstead.

version Any readonly Deprecated.UseScriptUI.versioninstead.

Methods ConstructorWindow(type:String[,title:String][,bounds:Bounds][,propertiesObject])Createsanewwindow.Parameter Type Description

type String Thewindowtype.Oneof:•window:Createsasimplewindowthatcanbeusedasamainwindowforanapplication.(NotsupportedbyPhotoshopCS3.)•palette:Createsamodelessdialog,alsocalledafloatingpalette.(NotsupportedbyPhotoshopCS3.)•dialog:Createsamodaldialog.This

argumentcanalsobeaScriptUIresourcespecification;inthatcase,allotherargumentsareignored.

title String Thewindowtitle,alocalizablestring.(Optional)

bounds Bounds Thewindow'spositionandsize.(Optional)

properties Object Anobjectcontainingcreation-onlyproperties.Cancontainanyoftheseproperties:•resizeable:Whentrue,thewindowcanberesizedbytheuser.Defaultisfalse.•su1PanelCoordinates:Photoshoponly.Whentrue,thechildpanelsofthiswindowautomaticallyadjustthepositionsoftheirchildrenforcompatabilitywithPhotoshopCS(inwhichtheverticalcoordinatewasmeasuredfromoutsidetheframe).Defaultisfalse.Individualpanelscanoverridetheparentwindow'ssetting.•:Whentrue,thetitlebarincludesabuttontoclosethewindow,iftheplatformandwindowtypeallowit.Whenfalse,itdoesnot.Defaultistrue.Notusedfordialogs.•maximizeButton:Whentrue,thetitlebarincludesabuttontoexpandthewindowtoitsmaximumsize(typically,theentirescreen),iftheplatformandwindowtypeallowit.Whenfalse,itdoesnot.Defaultisfalsefortypepalette,truefortypewindow.Notusedfordialogs.•minimizeButton:Whentrue,thetitlebarincludesabuttontominimizeoriconifythewindow,iftheplatformandwindowtypeallowit.Whenfalse,itdoesnot.Defaultisfalsefortypepalette,truefortypewindow.MainwindowscannothaveaminimizebuttoninMacOS.Notusedfordialogs.

•independent:Whentrue,awindowoftypewindowisindependentofotherapplicationwindows,andcanbehiddenbehindtheminWindows.InMacOS,hasnoeffect.Defaultisfalse.•borderless:Whentrue,thewindowhasnotitlebarorborders.Propertiesthatcontrolthosefeaturesareignored.(Optional)

Classvoidalert(message:String[,title:String][,errorIcon:BooleanDisplaysaplatform-standarddialogcontainingashortmessageandanOKbutton.Parameter Type Description

message String TThestringforthedisplayedmessage.

title String Astringtoappearasthetitleofthedialog,iftheplatformsupportsatitle.IgnoredinMacOS,whichdoesnotsupporttitlesforalertdialogs.Thedefaulttitlestringis"ScriptAlert".(Optional)

errorIcon Boolean Whentrue,theplatform-standardalerticonisreplacedbytheplatform-standarderroriconinthedialog.(default:false)IgnoredinMacOS,whichdoesnotsupporticonsforalertdialogs.

Booleanconfirm(message:String[,noAsDefault:Boolean=falsetitle:String])Displaysaplatform-standarddialogcontainingashortmessageandtwobuttonslabeledYesandNo.ReturnstrueiftheuserclickedYes,falseiftheuserclickedNo.Parameter Type Description

message String Thestringforthedisplayedmessage.

noAsDefault Boolean Whentrue,theNobuttonisthedefaultchoice,selectedwhentheusertypesEnter.

(default:false)Defaultisfalse,meaningthatYesisthedefaultchoice.

title String Astringtoappearasthetitleofthedialog,iftheplatformsupportsatitle.IgnoredinMacOS,whichdoesnotsupporttitlesforalertdialogs.Thedefaulttitlestringis"ScriptAlert".(Optional)

Windowfind(type:String,title:String)Usethismethodtofindanexistingwindow.ThisincludeswindowsdefinedbyScriptUIresourcestrings,windowsalreadycreatedbyascript,andwindowscreatedbytheapplication(iftheapplicationsupportsthiscase).Thisfunctionisnotsupportedbyallapplications.ReturnsaWindowobjectfoundorgeneratedfromtheresource,ornullifnosuchwindoworresourceexists.Parameter Type Description

type String ThenameofapredefinedresourceavailabletoJavaScriptinthecurrentapplication;orthewindowtype.Ifatitleisspecified,thetypeisusedifmorethanonewindowwiththattitleisfound.Canbenullortheemptystring.

title String Thewindowtitle.

Stringprompt(prompt:String[,default:String][,title:StringDisplaysamodaldialogthatreturnstheuser'stextinput.ReturnsthevalueofthetexteditfieldiftheuserclickedOK,nulliftheuserclickedCancel.Parameter Type Description

prompt String Thestringforthedisplayedmessage.

default String Theinitialvaluetobedisplayedinthetexteditfield.(Optional)

title String Astringtoappearasthetitleofthedialog.InWindows,thisappearsinthewindow'sframe;

inMacOSitappearsabovethemessage.Thedefaulttitlestringis"ScriptPrompt".(Optional)

EventsvoidonActivate()Anevent-handlercallbackfunction,calledwhenthewindowacquiresthekeyboardfocus.Calledwhentheusergivesthewindowthekeyboardfocusbyclickingitorotherwisemakingittheactivewindow.

BooleanonClose()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobeclosed.Calledwhenarequestismadetoclosethewindow,eitherbyanexplicitcalltotheclose()functionorbyauseraction(clickingtheOS-specificcloseiconinthetitlebar).Thefunctioniscalledbeforethewindowactuallycloses;itcanreturnfalsetocancelthecloseoperation.

voidonDeactivate()Anevent-handlercallbackfunction,calledwhenthewindowlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviouslyactivewindowtoanotherwindow.

voidonMove()Anevent-handlercallbackfunction,calledwhenthewindowmoved

voidonMoving()Anevent-handlercallbackfunction,calledwhenthewindowisbeingmovedCalledwhileawindowinbeingmoved,eachtimethepositionchanges.Ahandlercanmonitorthemoveoperation.

voidonResize()Anevent-handlercallbackfunction,calledafterthewindowhasbeenresized

voidonResizing()Anevent-handlercallbackfunction,calledwhileawindowisbeingresizedCalledwhileawindowisbeingresized,eachtimetheheightorwidth

changes.Ahandlercanmonitortheresizeoperation.

voidonShortcutKey()InWindowsonly,anevent-handlercallbackfunction,calledashortcut-keysequenceistypedthatmatchestheshortcutKeyvalueforthiswindow.

voidonShow()Anevent-handlercallbackfunction,calledjustbeforethewindowisdisplayedCalledwhenarequestismadetoopenthewindowusingthemethod,beforethewindowismadevisible,butafterautomaticlayoutiscomplete.Ahandlercanmodifytheresultsoftheautomaticlayout.

InstancesObjectadd(type:String[,bounds:Bounds][,text:String][,propertiesObject])Createsandreturnsanewcontrolorcontainerobjectandaddsittothechildrenofthiswindow.Parameter Type Description

type String Thetypeofthechildelement,asspecifiedforthetypeproperty.ControltypesarelistedintheJavaScriptToolsGuide.



properties Object Anobjectthatcontainsoneormorecreationpropertiesofthenewchild(propertiesused

onlywhentheelementiscreated).Thecreationpropertiesdependontheelementtype.Seepropertyofeachcontroltype.(Optional)

BooleanaddEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiswindow.Parameter Type Description

eventName String Thenameoftheevent.Predefinedeventnamesare:change,changing,move,moving,resize,resizing,show,enterKey,focus,blur,keydown,keyup,mousedown,mouseup,mousemove,mouseover,mouseout,click(detail=1forsingle,2fordouble).


capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.(default:false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.(Optional)

voidcenter([window:Window])Centersthiswindowonscreenorwithrepecttoanotherwindow.Parameter Type Description

window Window Therelativewindow.Ifnotspecified,centers

(SUI) onthescreen.(Optional)

voidclose([return:Any])Closesthiswindow..IfanonClose()callbackisdefinedforthewindow,callsthatfunctionbeforeclosingthewindow.Parameter Type Description

return Any Anumbertobereturnedfromtheshow()methodthatinvokedthiswindowasamodaldialog.(Optional)

UIEventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.

voidhide()Hidesthiswindows.Whenawindowishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.•Foramodaldialog,closesthedialogandsetsitsresultto0.

voidnotify([eventName:String])Sendsanotificationmessagetoalllisteners,simulatingthespecifieduserinteractionevent.Parameter Type Description

eventName String Theeventname;ifomitted,thedefaulteventissent.Oneof:onClose,onMove,onMoving,onResize,onResizing,onShow(Optional)

voidremove(what:Any)Removesthespecifiedchildcontrolfromthiswindow'schildrenNoerrorresultsifthechilddoesnotexist.Parameter Type Description


BooleanremoveEventListener(eventName:String,handlerFunction[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiswindow.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description




voidshow()Makesthiswindowvisible.IfanonShow()callbackisdefinedforawindow,callsthatfunctionbeforeshowingthewindow.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.•Foramodaldialog,opensthedialoganddoesnotreturnuntilthedialogisdismissed.Ifitisdismissedviatheclose()method,thismethodreturnsanyresultvaluepassedtothatmethod.Otherwise,returns0.

Elementof Button.windowCheckbox.windowDropDownList.windowEditText.windowFlashPlayer.windowGroup.windowIconButton.windowListBox.windowPanel.windowProgressbar.windowRadioButton.windowScrollbar.windowSlider.window

StaticText.windowTreeView.windowWindow.window

Usedin: voidWindow.center([window:Window])


Contents::Index

Enumeration

ColorType Thecolormodel.


ColorType.CMYK int1

ColorType.GRADIENT int4

ColorType.GRAY int0

ColorType.None int6

ColorType.PATTERN int2

ColorType.RGB int5

ColorType.SPOT int3

Usage


Contents::Index