adobe framemaker-12 object modelrun an xslt style sheet over an xslt style sheet, for example to...
TRANSCRIPT
Contents
JavaScriptReferenceGuideScriptingisoneofthemostpowerfulfeaturesinFramemaker.Itcansavelotsoftime:almostanythingyoucandowiththeuserinterface,youcandowithscripts,andthereareevenafewthingsyoucandoinscriptingthatyoucannotdofromwithintheuserinterface.Thecontentsontherightiscategorizedbyfunction;intheindexatthebottom,youcanfindallobjectsinalphabeticalorder.Eachobjectdescriptionlistsitselements,properties,andmethods.Thisentiresitewasentirelycreatedautomatically!Ohwow-readmore!
AdobeFrameMaker-12.0JavaScriptBaseClassesScriptUIClasses
Jongware,18-Jan-2015v1.0 Contents::Index
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
afewclickstore-generatetheentireHelpsetanew.IsaiditbeforeandI'llsayitagain:SupportOpenSourceSoftware!
Jongware,18-Jan-2015v1.0 Contents::Index
ContentsAdobeFrameMaker-12.0
AdobeFrameMaker-12.0JavaScriptBaseClassesScriptUIClasses
AFrameArcAttrCondExprAttributeAttributeDefAttributeDefsAttributeExAttributesAttributesExBodyPageBookBookComponentCMSCheckinParamCMSConnectionCMSDeleteParamCMSInfoCMSMenuItemCMSObjectCMSPropertiesCMSPropertyCMSRegistrationCMSResultCMSSessionCellCharFmtColorCombinedFontCombinedFontDefnCombinedFontsCommandCompareRetCondFmtConstantsDocElement
ElementCatalogEntriesElementCatalogEntryElementDefElementLocElementRangeEllipseFCodesFilterArgsFlowFmtChangeListFmtRuleFmtRuleClauseFnFontFontEncFontsGraphicsFmtGroupHiddenPageIdValuePairIdValuePairsInsetIntsIteratorKeyCatalogLineMarkerMarkerTypeMasterPageMathMathMLMenuMenuItemSeparatorMetricsPgfPgfFmtPointPointsPolygon
PolylinePropIdentPropValPropValsRectangleRefPageRoundRectRowRubiRulingFmtStringsSubColTabTabsTblTblFmtTemplateDataTemplateDatasTextFrameTextItemTextItemsTextLineTextLocTextRangeTiApiClientTiFlowTiTextTiTextTableTypedValTypedValsUBytesUIntsUnanchoredFrameVarVarFmtXRefXRefFmtapp
AFrame
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
AFrameIsCropped bool readwrite
AFrameIsFloating bool readwrite
Alignment int readwrite
AnchorType int readwrite
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BaselineOffset int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Element Element readonly
Fill int readwrite
FirstGraphicInFrame FMObject readonly
FirstGraphicInFrame FMObject readonly
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
InTextFrame TextFrame readonly
InTextObj FMObject readonly
IsHotspot int readwrite
LastGraphicInFrame FMObject readonly
LastGraphicInFrame FMObject readonly
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextAFrame AFrame readonly
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevAFrame AFrame readonly
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
SideOffset int readwrite
TailArrow int readwrite
TextLoc TextLoc readonly
TintPercent int readwrite
Unique int readonly
UserString string readwrite
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof AFrame.NextAFrameAFrame.PrevAFrameSubCol.FirstAFrameSubCol.LastAFrameTextFrame.FirstAFrameTextFrame.LastAFrame
Return AFrameDoc.NewAnchoredAFrame(textloc:TextLoc)
Arc
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
DTheta int readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
Theta int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return ArcDoc.NewArc(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
AttrCondExpr
QuickLinks ApplyAttributeExpression,GetProps,ObjectValid
Properties Property Type Access
AttrCondExprIsActive bool readwrite
AttrCondExprStr string readwrite
NextAttrCondExprInDoc AttrCondExpr readonly
Methods InstancesintApplyAttributeExpression()Alsoavaillableas'Apply'
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof AttrCondExpr.NextAttrCondExprInDocDoc.FirstAttrCondExprInDoc
Return AttrCondExprDoc.GetNamedAttrCondExpr(AttrCondExprDoc.NewNamedAttrCondExpr
Jongware,18-Jan-2015v1.0 Contents::Index
Attribute
QuickLinks Attribute
Properties Property Type Access Description
allow uint readwrite
name string readwrite
valflags uint readwrite
values Strings String readwrite
Methods ConstructorAttributeAttribute(name:string,values:Strings,valflags:uint,allow:uint)Parameter Type Description
name string
values Strings
valflags uint
allow uint
Example newAttribute()
Elementof TypedVal.asval
Usedin: numberAttributes.push(value:Attribute)
Return AttributeAttribute.Attribute(name:string,values:Strings,valflags:uint,allow:uint)
AttributeAttributes.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
AttributeDef
QuickLinks AttributeDef
Properties Property Type Access Description
attrType int readwrite
choices StringsString
readwrite
defValues StringsString
readwrite
flags uint readwrite
name string readwrite
rangeMax string readwrite
rangeMin string readwrite
required int readwrite
Methods ConstructorAttributeDefAttributeDef(name:string,required:int,flags:uint,attrType:int,choices:Strings,defValues:Strings,rangeMin:string,rangeMax:string)Parameter Type Description
name string
required int
flags uint
attrType int
choices Strings
defValues Strings
rangeMin string
rangeMax string
Example newAttributeDef()
Usedin: numberAttributeDefs.push(value:AttributeDef)
Return AttributeDefAttributeDef.AttributeDef(name:string,required:int,flags:uint,attrType:int,choices:Strings,defValues:Strings,rangeMin:string,rangeMax:string)
AttributeDefAttributeDefs.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
AttributeDefs AnArrayofAttributeDefobjectswithinteger
indexingandalengthproperty.SeealsoAttributeDef.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesAttributeDefsconcat(value:AttributeDefs)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value AttributeDefs Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
AttributeDefpop()Removesthelastelementfromthearray.
numberpush(value:AttributeDef)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.
Parameter Type Description
value AttributeDef
Elementof ElementDef.AttributeDefsTypedVal.adsval
Usedin: AttributeDefsAttributeDefs.concat(value:AttributeDefs)
Return AttributeDefsAttributeDefs.concat(value:AttributeDefs)
AttributeDefsElementDef.GetAttributeDefs()
Jongware,18-Jan-2015v1.0 Contents::Index
AttributeEx
QuickLinks AttributeEx
Properties Property Type Access Description
allow uint readwrite
name string readwrite
originalValues StringsString
readwrite
overriddenFlags uint readwrite
valflags uint readwrite
values StringsString
readwrite
Methods ConstructorAttributeExAttributeEx(name:string,values:Strings,originalValues:Strings,valflags:uint,allow:uint,overriddenFlags:uint)Parameter Type Description
name string
values Strings
originalValues Strings
valflags uint
allow uint
overriddenFlags uint
Example newAttributeEx()
TypedVal.asvalEx
Elementof
Usedin: numberAttributesEx.push(value:AttributeEx)
Return AttributeExAttributeEx.AttributeEx(name:string,values:Strings,originalValues:Strings,valflags:uint,allow:uint,overriddenFlags:uint)
AttributeExAttributesEx.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
Attributes AnArrayofAttributeobjectswithintegerindexingand
alengthproperty.SeealsoAttribute.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesAttributesconcat(value:Attributes)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value Attributes Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
Attributepop()Removesthelastelementfromthearray.
numberpush(value:Attribute)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value Attribute
Elementof Element.Attributes
Usedin: AttributesAttributes.concat(value:Attributes)
Return AttributesAttributes.concat(value:Attributes)AttributesElement.GetAttributes()
Jongware,18-Jan-2015v1.0 Contents::Index
AttributesEx AnArrayofAttributeExobjectswithinteger
indexingandalengthproperty.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesAttributesExconcat(value:AttributesEx)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value AttributesEx Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
AttributeExpop()Removesthelastelementfromthearray.
numberpush(value:AttributeEx)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value AttributeEx
Elementof Element.AttributesEx
Usedin: AttributesExAttributesEx.concat(value:AttributesEx)
Return AttributesExAttributesEx.concat(value:AttributesEx)
Jongware,18-Jan-2015v1.0 Contents::Index
BodyPage
QuickLinks ApplyPageLayout,Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
MasterPage string readwrite
PageBackground int readwrite
PageFrame UnanchoredFrame readonly
PageHeight int readonly
PageIsRecto int readonly
PageNext BodyPage readonly
PageNum int readonly
PageNumString string readonly
PagePrev BodyPage readonly
PageWidth int readonly
PointPageNum int readonly
Methods InstancesintApplyPageLayout(srcPage:PageObject)PageObjectisanyPageobjecti.e.,BodyPage,MasterPage,ReferencePageHiddenPageParameter Type Description
srcPage PageObject
intDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof BodyPage.PageNextBodyPage.PagePrevDoc.FirstBodyPageInDocDoc.LastBodyPageInDoc
Return BodyPageDoc.NewSeriesBodyPage(previous:Object)
Jongware,18-Jan-2015v1.0 Contents::Index
Book
QuickLinks Close,Compare,Export,GetDependencies,GetProps,GetUniqueObjectNewBookComponentInHierarchy,NewBookComponentOfTypeInHierarchyNewSeriesBookComponent,NewSeriesObject,ObjectValid,SaveSimpleGenerate,SimpleImportElementDefs,SimpleImportFormats
Properties Property Type
AcrobatBookmarkDisplayTags int
BookDontUpdateReferences int
BookIsModified int
BookIsSelected int
BookIsViewOnly int
CustomElementList Strings String
DocAcrobatColumnArticleThreads int
DocAcrobatDefaultsChanged int
DocAcrobatElementList Strings String
DocAcrobatElements int
DocAcrobatNoArticleThreads int
ElementCatalog ElementCatalogEntriesElementCatalogEntry
ElementCatalogDisplay int
ElementSelection ElementRange
FileExtensionOverride string
FirstComponentInBook BookComponent
FirstElementDefInDoc ElementDef
FirstFmtChangeListInDoc FmtChangeList
FirstSelectedComponentInBook BookComponent
GenerateAcrobatInfo int
HighestLevelElement Element
IsIconified int
IsInFront int
IsOnScreen int
Label string
Name string
NewElemAttrDisplay int
NewElemAttrEditing int
NextOpenBookInSession Book
PDFAllNamedDestinations int
PDFBookmark bool
PDFBookmarksOpenLevel int
PDFConvertCMYKtoRGB int
PDFDestsMarked int
PDFDistillerAbsent int
PDFDocInfo Strings String
PDFEndPage string
PDFGenerateForReview int
PDFJobOption string
PDFJobOptionsAbsent int
PDFOpenPage string
PDFPageHeight int
PDFPageWidth int
PDFPrintPageRange int
PDFRegistrationMarks int
PDFSeparateFiles int
PDFStartPage string
PDFZoomFactor int
PDFZoomType int
PrintBlankPages int
PrintCollated int
PrintDownloadAsianFonts int
PrintDownloadTrueTypeAsType1 int
PrintEmulsion int
PrintEvenPages int
PrintFileName string
PrintImaging int
PrintLastSheetFirst int
PrintLowRes int
PrintNumCopies int
PrintOddPages int
PrintPaperHeight int
PrintPaperWidth int
PrintRegistrationMarks int
PrintScale int
PrintSeps int
PrintToFile int
PrinterName string
ScreenHeight int
ScreenWidth int
ScreenX int
ScreenY int
SeparateInclusions int
ShowElementDescriptiveNames bool
SkipBlankSeps int
StatusLine string
StructuredApplication string
TypeOfDisplayText int
UseInitialStructure int
UseInitialStructureOfAutoInsertedElements bool
ViewOnlyDeadCodes UInts
ViewOnlyWinBorders int
ViewOnlyWinMenubar int
ViewOnlyWinPopup int
XmlDocType string
XmlEncoding string
XmlFileEncoding string
XmlPublicId string
XmlStandAlone int
XmlStyleSheet string
XmlStyleSheetList Strings String
XmlSystemId string
XmlUseBOM int
XmlVersion string
XmlWellFormed int
Methods InstancesintClose(flags:int)Parameter Type Description
flags int
CompareRetCompare(newerDoc:Doc,flags:int,insertCondTagstring,replaceText:string,compareThreshold:int)Parameter Type
newerDoc Doc
flags int
insertCondTag string
deleteCondTag string
replaceText string
compareThreshold int
intExport(fileName:string,exportParams:PropVals,exportReturnParamsParameter Type
fileName string
exportParams PropVals
exportReturnParams PropVals
TypedValsGetDependencies(depMode:int)Parameter Type Description
depMode int
PropValsGetProps()
ObjectGetUniqueObject(objType:int,unique:int)Parameter Type Description
objType int
unique int
ObjectImport(textLocP:TextLoc,filename:string,importParamsimportReturnParams:PropVals)Parameter Type
textLocP TextLoc
filename string
importParams PropVals
importReturnParams PropVals
ElementNewBookComponentInHierarchy(compName:stringParameter Type Description
compName string
elemLoc ElementLoc
BookComponentNewBookComponentOfTypeInHierarchy(compNameint,elemLoc:ElementLoc)Parameter Type Description
compName string
compType int
elemLoc ElementLoc
ObjectNewIterator(paramsp:PropVals)Parameter Type Description
paramsp PropVals
BookComponentNewSeriesBookComponent(previous:ObjectParameter Type Description
previous Object
ObjectNewSeriesObject(objType:int,previous:Object)Parameter Type Description
objType int
previous Object
intObjectValid()
ObjectSave(saveAsName:string,saveParams:PropVals,saveReturnParamsParameter Type
saveAsName string
saveParams PropVals
saveReturnParams PropVals
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
intSilentPrintDoc()
intSimpleGenerate(interactive:int,makeVisible:int)Parameter Type Description
interactive int
makeVisible int
intSimpleImportElementDefs(fromDocOrBook:Doc|Book,importFlagsParameter Type
fromDocOrBook Doc|Book
importFlags int
intSimpleImportFormats(fromDoc:Doc,formatFlags:int)Parameter Type Description
fromDoc Doc
formatFlags int
BookSimpleSave(saveAsName:string,interactive:int)Parameter Type Description
saveAsName string
interactive int
intUpdateBook(updateParams:PropVals,updateReturnParamsParameter Type
updateParams PropVals
updateReturnParams PropVals
Elementof Book.NextOpenBookInSessionBookComponent.BookParentapp.ActiveBookapp.FirstOpenBook
Return BookBook.SimpleSave(saveAsName:string,interactive:int)Bookapp.GetNamedBook(name:string)Bookapp.NewNamedBook(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
BookComponent
QuickLinks Delete,GetProps,MoveComponent,ObjectValid
Properties Property
BookComponentFileType
BookComponentIsFolderWithTemplate
BookComponentIsFolderWithoutTemplate
BookComponentIsGeneratable
BookComponentParent
BookComponentTemplatePath
BookComponentTitle
BookComponentType
BookParent
ChapNumComputeMethod
ChapterNumStyle
ChapterNumText
ChapterNumber
ComponentDisplayText
ComponentElement
ComponentIsDitaMap
ComponentIsSelected
ComponentType
CorrespondingXmlPath
ExcludeBookComponent
ExtractElementTags
ExtractTags
FirstComponentInBookComponent
FirstPageNum
FnCustNumString
FnFirstNum
FnNumComputeMethod
FnNumStyle
GenerateInclude
ImportFmtInclude
InsertLinks
Name
NextBookComponentInDFSOrder
NextComponentInBook
NextSelectedComponentInBook
PageNumComputeMethod
PageNumStyle
PagePrefix
PageSide
PageSuffix
PgfNumComputeMethod
PrevBookComponentInDFSOrder
PrevComponentInBook
PrintInclude
SecNumComputeMethod
SectionNumStyle
SectionNumText
SectionNumber
SubsecNumComputeMethod
SubsectionNumStyle
SubsectionNumText
SubsectionNumber
TblFnCustNumString
TblFnNumComputeMethod
TblFnNumStyle
Unique
UserString
VolNumComputeMethod
VolumeNumStyle
VolumeNumText
VolumeNumber
XmlApplicationForBookComponent
Methods InstancesintDelete()
PropValsGetProps()
voidMoveComponent(moveAction:int)Parameter Type
moveAction int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type
setVal PropVals
Elementof Book.FirstComponentInBookBook.FirstSelectedComponentInBookBookComponent.BookComponentParentBookComponent.FirstComponentInBookComponentBookComponent.NextBookComponentInDFSOrderBookComponent.NextComponentInBookBookComponent.NextSelectedComponentInBookBookComponent.PrevBookComponentInDFSOrderBookComponent.PrevComponentInBookElement.BookComponent
Return BookComponentBook.NewBookComponentOfTypeInHierarchycompType:int,elemLoc:ElementLoc
BookComponentBook.NewSeriesBookComponent
Jongware,18-Jan-2015v1.0 Contents::Index
CMSCheckinParam
QuickLinks CMSCheckinParam
Properties Property Type Access
checkinComment string readwrite
description string readwrite
makeThisCurrentVersion uint readwrite
version uint readwrite
versionLabel string readwrite
Methods ConstructorCMSCheckinParamCMSCheckinParamversionLabel:string,description:stringcheckinComment:string,makeThisCurrentVersionParameter Type
version uint
versionLabel string
description string
checkinComment string
makeThisCurrentVersion uint
Example newCMSCheckinParam()
Return CMSCheckinParamCMSCheckinParam.CMSCheckinParamuint,versionLabel:string,descriptioncheckinComment:string,makeThisCurrentVersionuint)
CMSConnection
QuickLinks GetProps,ObjectValid,SetProps
Methods InstancesPropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Jongware,18-Jan-2015v1.0 Contents::Index
CMSDeleteParam
QuickLinks CMSDeleteParam
Properties Property Type Access
deleteAllDependents uint readwrite
deleteAllVersion uint readwrite
Methods ConstructorCMSDeleteParamCMSDeleteParam(deleteAllVersion:uint,deleteAllDependentsParameter Type Description
deleteAllVersion uint
deleteAllDependents uint
Example newCMSDeleteParam()
Return CMSDeleteParamCMSDeleteParam.CMSDeleteParam(deleteAllVersion:uint,deleteAllDependentsuint)
CMSDeleteParamCMSObject.CMSShowDeleteUI(hideUiItems:int)
Jongware,18-Jan-2015v1.0 Contents::Index
CMSInfo
QuickLinks CMSInfo
Properties Property Type Access Description
cmsName string readwrite
userFields Strings String readwrite
userLoginUi uint readwrite
Methods ConstructorCMSInfoCMSInfo(cmsName:string,userFields:Strings,userLoginUi:uint)Parameter Type Description
cmsName string
userFields Strings
userLoginUi uint
Example newCMSInfo()
Return CMSInfoCMSInfo.CMSInfo(cmsName:string,userFields:Strings,userLoginUi:uint)
CMSInfoCMSRegistration.CMSGetCMSInfo()
Jongware,18-Jan-2015v1.0 Contents::Index
CMSMenuItem
QuickLinks CMSMenuItem
Properties Property Type Access Description
flags uint readwrite
id int readwrite
name string readwrite
Methods ConstructorCMSMenuItemCMSMenuItem(id:int,name:string,flags:uint)Parameter Type Description
id int
name string
flags uint
Example newCMSMenuItem()
Usedin: intGlobals.CMSAddMenuEntry(menuId:int,menuEntryp:CMSMenuItem)
Return CMSMenuItemCMSMenuItem.CMSMenuItem(id:int,name:string,flags:uint)
Jongware,18-Jan-2015v1.0 Contents::Index
CMSObject
QuickLinks CMSCancelCheckout,CMSCheckin,CMSCheckout,CMSDelete,CMSDisableCommand,CMSDownloadObject,CMSEnableCommand,CMSGetProperties,CMSGetProperty,CMSOpenFile,CMSSetProperties,CMSSetProperty,CMSShowCancelCheckoutUI,CMSShowCheckinUI,CMSShowCheckoutUI,CMSShowCommonListUI,CMSShowDeleteUI,CMSShowPropertyUI,CMSShowPropertyUIWithTitle,CMSUploadObject,GetProps,ObjectValid,SetProps
Methods InstancesintCMSCancelCheckout()
intCMSCheckin(checkinParam:IdValuePairs)Parameter Type Description
checkinParam IdValuePairs
intCMSCheckout(rootWithDescendants:bool)Parameter Type Description
rootWithDescendants bool
intCMSDelete(deleteParams:IdValuePairs)Parameter Type Description
deleteParams IdValuePairs
voidCMSDisableCommand(commandId:int)Parameter Type Description
commandId int
stringCMSDownloadObject()
voidCMSEnableCommand(commandId:int)Parameter Type Description
commandId int
PropValsCMSGetProperties()
PropValCMSGetProperty(propertyId:PropIdent)Parameter Type Description
propertyId PropIdent
ObjectCMSOpenFile(openParams:IdValuePairs)Parameter Type Description
openParams IdValuePairs
voidCMSSetProperties(propVals:PropVals)Parameter Type Description
propVals PropVals
voidCMSSetProperty(propVal:PropVal)Parameter Type Description
propVal PropVal
voidCMSShowCancelCheckoutUI()
CMSCheckinParamCMSShowCheckinUI(hideUiItems:int)Parameter Type Description
hideUiItems int
boolCMSShowCheckoutUI(hideUiItems:int)Parameter Type Description
hideUiItems int
boolCMSShowCommonListUI(commandId:int,
title:string,columnProperties:TypedVals)Parameter Type Description
commandId int
title string
columnProperties TypedVals
CMSDeleteParamCMSShowDeleteUI(hideUiItems:int)Parameter Type Description
hideUiItems int
CMSPropertiesCMSShowPropertyUI(props:CMSProperties)Parameter Type Description
props CMSProperties
CMSPropertiesCMSShowPropertyUIWithTitle(props:CMSProperties,title:string)Parameter Type Description
props CMSProperties
title string
intCMSUploadObject(localFilePath:string)Parameter Type Description
localFilePath string
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return CMSObjectCMSSession.CMSCreateObject()CMSObject
CMSSession.CMSShowBrowseRepositoryUI(showContainerOnly:bool)
CMSObjectCMSSession.GetCMSObjectFromPath(urlPath:string)
Jongware,18-Jan-2015v1.0 Contents::Index
CMSProperties AnArrayofCMSPropertyobjectswithinteger
indexingandalengthproperty.SeealsoCMSProperty.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesCMSPropertiesconcat(value:CMSPropertiesReturnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value CMSProperties Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
CMSPropertypop()Removesthelastelementfromthearray.
numberpush(value:CMSProperty)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.
Parameter Type Description
value CMSProperty
Usedin: CMSPropertiesCMSObject.CMSShowPropertyUI(propsCMSProperties)
CMSPropertiesCMSObject.CMSShowPropertyUIWithTitle(props:CMSProperties,title:string)
CMSPropertiesCMSProperties.concat(valueCMSProperties)
Return CMSPropertiesCMSObject.CMSShowPropertyUI(propsCMSProperties)
CMSPropertiesCMSObject.CMSShowPropertyUIWithTitle(props:CMSProperties,title:string)
CMSPropertiesCMSProperties.concat(valueCMSProperties)
Jongware,18-Jan-2015v1.0 Contents::Index
CMSProperty
QuickLinks CMSProperty
Properties Property Type Access Description
isEditable uint readwrite
isMultiValue uint readwrite
label string readwrite
prop uint readwrite
values TypedValsTypedVal
readwrite
Methods ConstructorCMSPropertyCMSProperty(prop:uint,label:string,isMultiValue:uint,isEditable:uint,valuesTypedVals)Parameter Type Description
prop uint
label string
isMultiValue uint
isEditable uint
values TypedVals
Example newCMSProperty()
Usedin: numberCMSProperties.push(value:CMSProperty)
Return CMSPropertyCMSProperties.pop()CMSPropertyCMSProperty.CMSProperty
(prop:uint,label:string,isMultiValue:uint,isEditable:uint,values:TypedVals)
Jongware,18-Jan-2015v1.0 Contents::Index
CMSRegistration
QuickLinks CMSConfigLoginUI,CMSGetCMSInfo,GetProps,ObjectValid,SetProps
Methods InstancesvoidCMSConfigLoginUI(userFields:Strings,userLoginUI:bool)Parameter Type Description
userFields Strings
userLoginUI bool
CMSInfoCMSGetCMSInfo()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return CMSRegistrationCMSSession.CMSGetCmsIdFromSession()
CMSRegistrationGlobals.CMSGetCmsIdFromName(cmsName:string)
CMSRegistrationGlobals.CMSRegister(cmsName:string)
Jongware,18-Jan-2015v1.0 Contents::Index
CMSResult
QuickLinks CMSResult
Properties Property Type Access Description
cmsItems Objects readwrite
message sting readwrite
opResult uint readwrite
status int readwrite
Methods ConstructorCMSResultCMSResult(status:int,opResult:uint,message:string,cmsItems:Objects)Parameter Type Description
status int
opResult uint
message string
cmsItems Objects
Example newCMSResult()
Return CMSResultCMSResult.CMSResult(status:int,opResult:uint,message:string,cmsItems:Objects)
Jongware,18-Jan-2015v1.0 Contents::Index
CMSSession
QuickLinks CMSCreateObject,CMSGetCmsIdFromSession,CMSLogout,CMSShowBrowseRepositoryUI,GetCMSObjectFromPath,GetProps,ObjectValid,SetProps
Methods InstancesCMSObjectCMSCreateObject()
CMSRegistrationCMSGetCmsIdFromSession()
voidCMSLogout()
CMSObjectCMSShowBrowseRepositoryUI(showContainerOnly:bool)Parameter Type Description
showContainerOnly bool
CMSObjectGetCMSObjectFromPath(urlPath:string)Parameter Type Description
urlPath string
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return CMSSessionGlobals.CMSLogin(setVal:IdValuePairs)
Jongware,18-Jan-2015v1.0 Contents::Index
Cell
QuickLinks GetProps,GetText,ObjectValid,SetProps,StraddleCells,UnStraddleCells
Properties Property Type Access Description
CellAboveInCol Cell readonly
CellAngle int readwrite
CellBelowInCol Cell readonly
CellColNum int readonly
CellDefaultBottomRuling RulingFmt readonly
CellDefaultLeftRuling RulingFmt readonly
CellDefaultRightRuling RulingFmt readonly
CellDefaultTopRuling RulingFmt readonly
CellIsShown int readonly
CellIsStraddled int readonly
CellNumColsStraddled int readonly
CellNumRowsStraddled int readonly
CellOverrideBottomRuling RulingFmt readwrite
CellOverrideFill int readwrite
CellOverrideLeftRuling RulingFmt readwrite
CellOverrideRightRuling RulingFmt readwrite
CellOverrideShading Color readwrite
CellOverrideTopRuling RulingFmt readwrite
CellRow Row readonly
CellUseOverrideBRuling int readwrite
CellUseOverrideFill int readwrite
CellUseOverrideLRuling int readwrite
CellUseOverrideRRuling int readwrite
CellUseOverrideShading int readwrite
CellUseOverrideTRuling int readwrite
ContentHeight int readonly
Element Element readonly
FirstPgf Pgf readonly
HighestLevelElement Element readonly
InTextFrame TextFrame readonly
InTextObj SubCol readonly
LastPgf Pgf readonly
NextCell Cell readwrite
NextCellInRow Cell readonly
NextCellInTbl Cell readonly
Overflowed int readonly
PrevCell Cell readonly
PrevCellInRow Cell readonly
Unique int readonly
UserString string readwrite
Methods InstancesPropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
intStraddleCells(heightInRows:int,widthInCols:int)Parameter Type Description
heightInRows int
widthInCols int
intUnStraddleCells(heightInRows:int,widthInCols:int)Parameter Type Description
heightInRows int
widthInCols int
Elementof Cell.CellAboveInColCell.CellBelowInColCell.NextCellCell.NextCellInRowCell.NextCellInTblCell.PrevCellCell.PrevCellInRowRow.FirstCellInRowSubCol.FirstCellSubCol.LastCellTextFrame.FirstCellTextFrame.LastCell
Jongware,18-Jan-2015v1.0 Contents::Index
CharFmt
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access
BkColor FMObject readwrite
Capitalization int readwrite
ChangeBar int readwrite
CharTag string readwrite
Color Color readwrite
CombinedFontFamily CombinedFontDefn readwrite
FontAngle int readwrite
FontEncodingName string readonly
FontFamily int readwrite
FontPlatformName string readwrite
FontPostScriptName string readwrite
FontSize int readwrite
FontVariation int readwrite
FontWeight int readwrite
KernX int readwrite
KernY int readwrite
Language int readwrite
Name string readwrite
NextCharFmtInDoc CharFmt readonly
Overline int readwrite
PairKern int readwrite
Position int readwrite
ReviewTime int readwrite
ReviewerName string readwrite
Spread int readwrite
Stretch int readwrite
Strikethrough int readwrite
Underlining int readwrite
UseBkColor bool readwrite
UseCapitalization int readwrite
UseChangeBar int readwrite
UseColor int readwrite
UseFontAngle int readwrite
UseFontFamily int readwrite
UseFontSize int readwrite
UseFontVariation int readwrite
UseFontWeight int readwrite
UseKernX int readwrite
UseKernY int readwrite
UseOverline int readwrite
UsePairKern int readwrite
UsePosition int readwrite
UseSpread int readwrite
UseStretch int readwrite
UseStrikethrough int readwrite
UseUnderlining int readwrite
UserString string readwrite
WesternFontPlatformName string readwrite
WesternFontPostScriptName string readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof CharFmt.NextCharFmtInDocDoc.FirstCharFmtInDoc
Return CharFmtDoc.GetNamedCharFmt(name:string)CharFmtDoc.NewNamedCharFmt(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
Color
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Black int readwrite
ColorOverprint int readwrite
ColorPrintCtl int readwrite
ColorTintPercent int readwrite
ColorViewCtl int readwrite
Cyan int readwrite
FamilyName string readwrite
InkName string readwrite
Magenta int readwrite
Name string readwrite
NextColorInDoc Color readonly
ReservedColor int readwrite
TintBaseColor Color readwrite
UserString string readwrite
Yellow int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof AFrame.ColorArc.ColorCell.CellOverrideShadingCharFmt.ColorColor.NextColorInDocColor.TintBaseColorCondFmt.BkColorCondFmt.SepOverrideDoc.ChangeBarColorDoc.ColorDoc.FirstColorInDocDoc.SepOverrideDoc.TrackChangesAddedColorDoc.TrackChangesDeletedColorEllipse.ColorFmtChangeList.BkColorFmtChangeList.ColorFmtChangeList.PgfBoxColorGraphicsFmt.ColorGroup.ColorInset.ColorLine.ColorMath.ColorMathML.ColorPgf.BkColorPgf.ColorPgf.PgfBoxColorPgfFmt.BkColorPgfFmt.ColorPgfFmt.PgfBoxColorPolygon.ColorPolyline.ColorRectangle.Color
RoundRect.ColorRow.SepOverrideRulingFmt.RulingSepTbl.TblBodyFirstColorTbl.TblBodyNextColorTbl.TblHFColorTblFmt.TblBodyFirstColorTblFmt.TblBodyNextColorTblFmt.TblHFColorTextFrame.ColorTextLine.ColorUnanchoredFrame.Color
Return ColorDoc.GetNamedColor(name:string)ColorDoc.NewNamedColor(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
CombinedFont
QuickLinks CombinedFont
Properties Property Type Access
angle uint readwrite
combinedFont CombinedFontDefn readwrite
variation uint readwrite
weight uint readwrite
Methods ConstructorCombinedFontCombinedFont(combinedFontCombinedFontDefn,variation:uint,weight:uintParameter Type Description
combinedFont CombinedFontDefn
variation uint
weight uint
angle uint
Example newCombinedFont()
Usedin: numberCombinedFonts.push(value:CombinedFont
Return CombinedFontCombinedFont.CombinedFont(combinedFont:CombinedFontDefn,variationweight:uint,angle:uint)
CombinedFontCombinedFonts.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
CombinedFontDefn
QuickLinks CombinedFamilyFonts,Delete,GetProps
Properties Property Type
BaseFamily int
FontEncodingName string
Name string
NextCombinedFontDefnInDoc CombinedFontDefn
UserString string
WesternFamily int
WesternShift int
WesternSize int
Methods InstancesCombinedFontsCombinedFamilyFonts
intDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type
setVal PropVals
Elementof CharFmt.CombinedFontFamilyCombinedFont.combinedFontCombinedFontDefn.NextCombinedFontDefnInDocDoc.CombinedFontFamilyDoc.FirstCombinedFontDefnInDoc
FmtChangeList.CombinedFontFamilyPgf.CombinedFontFamilyPgfFmt.CombinedFontFamily
Usedin: CombinedFontCombinedFont.CombinedFontCombinedFontDefn,variation:
Return CombinedFontDefnDoc.GetNamedCombinedFontDefnCombinedFontDefnDoc.NewNamedCombinedFontDefn
Jongware,18-Jan-2015v1.0 Contents::Index
CombinedFonts AnArrayofCombinedFontobjectswithinteger
indexingandalengthproperty.SeealsoCombinedFont.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesCombinedFontsconcat(value:CombinedFonts)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value CombinedFonts Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
CombinedFontpop()Removesthelastelementfromthearray.
numberpush(value:CombinedFont)Placesvalueontotheendofthearray.
Returnsthenewlengthofthearray.Parameter Type Description
value CombinedFont
Usedin: CombinedFontsCombinedFonts.concat(valueCombinedFonts)
Return CombinedFontsCombinedFontDefn.CombinedFamilyFonts()
CombinedFontsCombinedFonts.concat(value:CombinedFonts)
Jongware,18-Jan-2015v1.0 Contents::Index
Command
QuickLinks Delete,Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
CanHaveCheckMark int readwrite
CheckMarkIsOn int readwrite
CommandNum int readwrite
EnabledWhen int readwrite
ExpandOMaticParent Command readonly
Fcode unsignedint
readonly
Fcodes UInts readonly
HasShiftOrUnshiftCommand int readwrite
HelpLink string readwrite
KeyboardShortcutLabel string readwrite
KeyboardShortcuts StringsString
readwrite
Label string readwrite
Labels StringsString
readwrite
MenuItemIsEnabled int readonly
MenuItemType int readonly
Mode int readonly
Name string readonly
NextCommandInSession Command readonly
NextMenuItemInMenu FMObject readwrite
NextMenuItemInSession FMObject readonly
PrevMenuItemInMenu FMObject readwrite
Product int readwrite
ShiftOrUnshiftCommand Command readwrite
View int readwrite
Window int readwrite
Methods InstancesintDelete()
intDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Command.ExpandOMaticParentCommand.NextCommandInSessionCommand.ShiftOrUnshiftCommandapp.FirstCommandInSession
Usedin: numberMenu.AddCommandToMenu(command:Command
Return CommandMenu.DefineAndAddCommand(cmdNum:numbername:string,label:string,shortcut:string)
Commandapp.GetNamedCommand(name:string)Commandapp.NewNamedCommand(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
CompareRet
QuickLinks CompareRet
Properties Property Type Access Description
comp Doc readwrite
sum Doc readwrite
Methods ConstructorCompareRetCompareRet(sum:Doc,comp:Doc)Parameter Type Description
sum Doc
comp Doc
Example newCompareRet()
Return CompareRetBook.Compare(newerDoc:Doc,flags:int,insertCondTag:string,deleteCondTag:string,replaceText:string,compareThreshold:int)
CompareRetCompareRet.CompareRet(sum:Doc,comp:Doc)
CompareRetDoc.Compare(newerDoc:Doc,flags:int,insertCondTag:string,deleteCondTag:string,replaceText:string,compareThreshold:int)
Jongware,18-Jan-2015v1.0 Contents::Index
CondFmt
QuickLinks Delete,DeleteCondTag,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
BkColor Color readwrite
CondFmtIsShown int readwrite
Name string readwrite
NextCondFmtInDoc CondFmt readonly
SepOverride Color readwrite
StyleOverride int readwrite
UseBkColor bool readwrite
UseSepOverride int readwrite
UserString string readwrite
Methods InstancesintDelete()
intDeleteCondTag(action:int)Parameter Type Description
action int
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof CondFmt.NextCondFmtInDocDoc.FirstCondFmtInDoc
Return CondFmtDoc.GetNamedCondFmt(name:string)CondFmtDoc.NewNamedCondFmt(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
Constants
Value Name
Constants.EXCLUDE_GRAPHICS_DEPENDENCIES
Constants.EXCLUDE_NONE
Constants.EXCLUDE_OLE_DEPENDENCIES
Constants.EXCLUDE_TEXT_INSET_DEPENDENCIES
Constants.EXCLUDE_XREF_DEPENDENCIES
Constants.FA_CMSAdvancedSearch
Constants.FA_CMSBuildContextMenu
Constants.FA_CMSCloseConnection
Constants.FA_CMSCommandMax
Constants.FA_CMSCommandMin
Constants.FA_CMSCreateConnMgrUI
Constants.FA_CMSCreateConnection
Constants.FA_CMSGetCommandMaxOpCode
Constants.FA_CMSGetItemFromPath
Constants.FA_CMSGetItems
Constants.FA_CMSGetPropertyMaxOpCode
Constants.FA_CMSIsValidCommand
Constants.FA_CMSObjectCancelCheckout
Constants.FA_CMSObjectCheckin
Constants.FA_CMSObjectCheckout
Constants.FA_CMSObjectDelete
Constants.FA_CMSObjectDownload
Constants.FA_CMSObjectDownloadForOpen
Constants.FA_CMSObjectDownloadItem
Constants.FA_CMSObjectEdit
Constants.FA_CMSObjectGetChildren
Constants.FA_CMSObjectIsSame
Constants.FA_CMSObjectOpenReadOnly
Constants.FA_CMSObjectRefresh
Constants.FA_CMSObjectShowCheckOutFiles
Constants.FA_CMSObjectShowDependents
Constants.FA_CMSObjectShowProperties
Constants.FA_CMSObjectShowVersion
Constants.FA_CMSObjectUploadFile
Constants.FA_CMSObjectUploadFolder
Constants.FA_CMSSetRootObject
Constants.FA_CMSSimpleSearch
Constants.FA_COMPONENT_DEMOTE
Constants.FA_COMPONENT_MOVEDOWN
Constants.FA_COMPONENT_MOVEUP
Constants.FA_COMPONENT_PROMOTE
Constants.FA_Init_DocReport
Constants.FA_Init_First
Constants.FA_Init_Subsequent
Constants.FA_Init_TakeControl
Constants.FA_Note_AI_Supported_File
Constants.FA_Note_Alert
Constants.FA_Note_AssignId
Constants.FA_Note_BackToUser
Constants.FA_Note_BodyPageAdded
Constants.FA_Note_BodyPageDeleted
Constants.FA_Note_ClientCall
Constants.FA_Note_ConsoleMessage
Constants.FA_Note_CursorChange
Constants.FA_Note_DITAOptions
Constants.FA_Note_Dialog
Constants.FA_Note_Dialog_Create
Constants.FA_Note_DirtyBook
Constants.FA_Note_DirtyDoc
Constants.FA_Note_DisplayClientTiDialog
Constants.FA_Note_DisplayClientXRefDialog
Constants.FA_Note_ECMInternal
Constants.FA_Note_Enable_Disable_DITA_Menu_Commands
Constants.FA_Note_EnumeratedComponent
Constants.FA_Note_FileOpen
Constants.FA_Note_FilterFileToFile
Constants.FA_Note_FilterIn
Constants.FA_Note_FilterOut
Constants.FA_Note_FontSubstitution
Constants.FA_Note_GenerateFM
Constants.FA_Note_Help
Constants.FA_Note_InsertConRef
Constants.FA_Note_InsertTopicRef
Constants.FA_Note_IsCommandEnabled
Constants.FA_Note_LoadKeyCatalog
Constants.FA_Note_MATHML_CHANGE_NSPREFIX
Constants.FA_Note_MATHML_DblClicked
Constants.FA_Note_MATHML_Deselected
Constants.FA_Note_MATHML_GenerateImage
Constants.FA_Note_MATHML_PopulateObj
Constants.FA_Note_MATHML_Selected
Constants.FA_Note_NewBookmapFile
Constants.FA_Note_NewConceptFile
Constants.FA_Note_NewDitamapFile
Constants.FA_Note_NewGlossEntryFile
Constants.FA_Note_NewReferenceFile
Constants.FA_Note_NewTaskFile
Constants.FA_Note_NewTopicFile
Constants.FA_Note_Not_AI_Supported_File
Constants.FA_Note_Not_RSC_Supported_File
Constants.FA_Note_Not_SWF_File
Constants.FA_Note_Not_U3DCommand
Constants.FA_Note_Num
Constants.FA_Note_OpenAllTopicrefs
Constants.FA_Note_Open_Dtd
Constants.FA_Note_Open_EDD_For_App
Constants.FA_Note_Open_Schema
Constants.FA_Note_Palette
Constants.FA_Note_PostActiveDocChange
Constants.FA_Note_PostAutoSaveDoc
Constants.FA_Note_PostBookComponentOpen
Constants.FA_Note_PostChangeElement
Constants.FA_Note_PostCopyElement
Constants.FA_Note_PostCreateMML
Constants.FA_Note_PostDistill
Constants.FA_Note_PostDragElement
Constants.FA_Note_PostExport
Constants.FA_Note_PostFileType
Constants.FA_Note_PostFunction
Constants.FA_Note_PostGenerate
Constants.FA_Note_PostGoToXrefSrc
Constants.FA_Note_PostHypertext
Constants.FA_Note_PostImport
Constants.FA_Note_PostImportElemDefs
Constants.FA_Note_PostInlineTypeIn
Constants.FA_Note_PostInsertElement
Constants.FA_Note_PostMouseCommand
Constants.FA_Note_PostOpenBook
Constants.FA_Note_PostOpenBookMIF
Constants.FA_Note_PostOpenDoc
Constants.FA_Note_PostOpenMIF
Constants.FA_Note_PostOpenSGML
Constants.FA_Note_PostOpenXML
Constants.FA_Note_PostPrint
Constants.FA_Note_PostPublishDitamap
Constants.FA_Note_PostQuitBook
Constants.FA_Note_PostQuitDoc
Constants.FA_Note_PostQuitSession
Constants.FA_Note_PostRevertBook
Constants.FA_Note_PostRevertDoc
Constants.FA_Note_PostSaveAsPDFDialog
Constants.FA_Note_PostSaveBook
Constants.FA_Note_PostSaveBookMIF
Constants.FA_Note_PostSaveDoc
Constants.FA_Note_PostSaveMIF
Constants.FA_Note_PostSaveSGML
Constants.FA_Note_PostSaveXML
Constants.FA_Note_PostSetAttrValue
Constants.FA_Note_PostSetPropertyValue
Constants.FA_Note_PostSwitchView
Constants.FA_Note_PostUpdateXRefs
Constants.FA_Note_PostWrapElement
Constants.FA_Note_Poster_Applied
Constants.FA_Note_PreAutoSaveDoc
Constants.FA_Note_PreBookComponentOpen
Constants.FA_Note_PreChangeElement
Constants.FA_Note_PreCopyElement
Constants.FA_Note_PreCreateMML
Constants.FA_Note_PreDistill
Constants.FA_Note_PreDragElement
Constants.FA_Note_PreExport
Constants.FA_Note_PreFileType
Constants.FA_Note_PreFunction
Constants.FA_Note_PreGenerate
Constants.FA_Note_PreGoToXrefSrc
Constants.FA_Note_PreHypertext
Constants.FA_Note_PreImport
Constants.FA_Note_PreImportElemDefs
Constants.FA_Note_PreInlineTypeIn
Constants.FA_Note_PreInsertElement
Constants.FA_Note_PreMouseCommand
Constants.FA_Note_PreOpenBook
Constants.FA_Note_PreOpenBookMIF
Constants.FA_Note_PreOpenDoc
Constants.FA_Note_PreOpenMIF
Constants.FA_Note_PreOpenSGML
Constants.FA_Note_PreOpenXML
Constants.FA_Note_PrePrint
Constants.FA_Note_PrePublishDitamap
Constants.FA_Note_PreQuitBook
Constants.FA_Note_PreQuitDoc
Constants.FA_Note_PreQuitSession
Constants.FA_Note_PreRevertBook
Constants.FA_Note_PreRevertDoc
Constants.FA_Note_PreSaveAsPDFDialog
Constants.FA_Note_PreSaveBook
Constants.FA_Note_PreSaveBookMIF
Constants.FA_Note_PreSaveDoc
Constants.FA_Note_PreSaveMIF
Constants.FA_Note_PreSaveSGML
Constants.FA_Note_PreSaveXML
Constants.FA_Note_PreSetAttrValue
Constants.FA_Note_PreSetPropertyValue
Constants.FA_Note_PreSwitchView
Constants.FA_Note_PreUpdateXRefs
Constants.FA_Note_PreWrapElement
Constants.FA_Note_QuitModelessDialog
Constants.FA_Note_RSC_Supported_File
Constants.FA_Note_ReLoadKeyCatalog
Constants.FA_Note_Read_Struct_App
Constants.FA_Note_SWF_File
Constants.FA_Note_SetAttrValue
Constants.FA_Note_Struct_Wizard
Constants.FA_Note_ToolBar
Constants.FA_Note_U3DCommand
Constants.FA_Note_URL
Constants.FA_Note_UndoCheckpoint
Constants.FA_Note_UpdateAllClientTi
Constants.FA_Note_UpdateClientTi
Constants.FA_Note_UpdateDITAReference
Constants.FA_Note_UpdateDITAReferences
Constants.FA_Note_UpdateRefs
Constants.FA_Note_UpdateRefs_On_Save
Constants.FDK_LIBRARY_VERSION
Constants.FE_AcceptRejectCalledOnWrongPreviewState
Constants.FE_AsianSystemRequired
Constants.FE_BadBaseColor
Constants.FE_BadBookId
Constants.FE_BadCompPath
Constants.FE_BadCompare
Constants.FE_BadContainer
Constants.FE_BadDelete
Constants.FE_BadDocId
Constants.FE_BadElementDefId
Constants.FE_BadElementId
Constants.FE_BadElementSelection
Constants.FE_BadFamilyName
Constants.FE_BadFileType
Constants.FE_BadFilterType
Constants.FE_BadInkName
Constants.FE_BadInsertPos
Constants.FE_BadKey
Constants.FE_BadKeyField
Constants.FE_BadMenuBar
Constants.FE_BadName
Constants.FE_BadNew
Constants.FE_BadNewFrame
Constants.FE_BadNewGroup
Constants.FE_BadNewSibling
Constants.FE_BadNotificationNum
Constants.FE_BadObjId
Constants.FE_BadOperation
Constants.FE_BadPageDelete
Constants.FE_BadParameter
Constants.FE_BadPropNum
Constants.FE_BadPropType
Constants.FE_BadRange
Constants.FE_BadRefElementId
Constants.FE_BadRefFlowId
Constants.FE_BadSaveFileName
Constants.FE_BadSelectionForOperation
Constants.FE_BadShortcut
Constants.FE_BadTemplatePath
Constants.FE_BadValue
Constants.FE_BadXRefSrcDocId
Constants.FE_BadXmlApplication
Constants.FE_BookComponentAlreadyHasTrackedEdits
Constants.FE_BookStructured
Constants.FE_BookUnStructured
Constants.FE_Busy
Constants.FE_CMSBadCommandId
Constants.FE_CMSBadItemContainerType
Constants.FE_CMSBadItemFileType
Constants.FE_CMSBadItemType
Constants.FE_CMSBadObjectId
Constants.FE_CMSBadSessionId
Constants.FE_CMSFailedCancelCheckout
Constants.FE_CMSFailedCheckin
Constants.FE_CMSFailedCheckout
Constants.FE_CMSFailedDelete
Constants.FE_CMSFailedDownloadObject
Constants.FE_CMSFailedGetItemFrompath
Constants.FE_CMSFailedLogin
Constants.FE_CMSFailedLogout
Constants.FE_CMSFailedOpenFile
Constants.FE_CMSFailedUploadObject
Constants.FE_CMSIsValidCMSCommand
Constants.FE_CMSNameAlreadyRegistered
Constants.FE_CMSObjectCreationFailed
Constants.FE_CMSRootObjectExists
Constants.FE_CMSSessionCreationFailed
Constants.FE_CMSSessionFailed
Constants.FE_Canceled
Constants.FE_CanceledByClient
Constants.FE_CantSmooth
Constants.FE_CantUpdateMacEdition
Constants.FE_CircularReference
Constants.FE_CompareTypes
Constants.FE_Disabled
Constants.FE_DocAlreadyHasTrackedEdits
Constants.FE_DocModified
Constants.FE_DupName
Constants.FE_EmptyTextObject
Constants.FE_FDKUndoNotAllowed
Constants.FE_FailedExportedFileInvalid
Constants.FE_FailedState
Constants.FE_FileClosedByClient
Constants.FE_FilterFailed
Constants.FE_FlowStructured
Constants.FE_GenRuleAmbiguous
Constants.FE_GenRuleConnectorExpected
Constants.FE_GenRuleItemExpected
Constants.FE_GenRuleLeftBracketExpected
Constants.FE_GenRuleMixedConnectors
Constants.FE_GenRuleRightBracketExpected
Constants.FE_GenRuleSyntaxError
Constants.FE_GraphicInLockedTi
Constants.FE_GroupSelect
Constants.FE_HiddenPage
Constants.FE_InternalErrorFailedToWriteInsets
Constants.FE_InvAttribute
Constants.FE_InvAttributeDef
Constants.FE_InvalidAttrExpr
Constants.FE_InvalidString
Constants.FE_KeyCatalogIsStale
Constants.FE_KeyCatalogNotLoaded
Constants.FE_KeyCatalogNotSpecified
Constants.FE_KeyDefinitionAlreadyExists
Constants.FE_KeyDefinitionDoesNotExist
Constants.FE_LanguageNotAvailable
Constants.FE_MissingFile
Constants.FE_NameNotFound
Constants.FE_NoColorFamily
Constants.FE_NoSuchFlow
Constants.FE_NonDITADocument
Constants.FE_NotApiCommand
Constants.FE_NotBodyPage
Constants.FE_NotBookComponent
Constants.FE_NotCommand
Constants.FE_NotFound
Constants.FE_NotFrame
Constants.FE_NotGraphic
Constants.FE_NotGroup
Constants.FE_NotInMenu
Constants.FE_NotMenu
Constants.FE_NotPgf
Constants.FE_NotPgfOrFlow
Constants.FE_NotTextFrame
Constants.FE_NotTextObject
Constants.FE_OffsetNotFound
Constants.FE_OutOfRange
Constants.FE_PageFrame
Constants.FE_PropNotSet
Constants.FE_ReadOnly
Constants.FE_ReservedColor
Constants.FE_SomeUnresolved
Constants.FE_StringTooLong
Constants.FE_Success
Constants.FE_SystemError
Constants.FE_TableInLockedTi
Constants.FE_TintedColor
Constants.FE_Transport
Constants.FE_TypeUnNamed
Constants.FE_UnLicensed
Constants.FE_UpdateDITAReferenceFailed
Constants.FE_UpdateDITAReferenceFailedCannotConvertToFMObject
Constants.FE_UpdateDITAReferenceFailedCannotFindReferencedFile
Constants.FE_UpdateDITAReferenceFailedCannotOpenReferencedFile
Constants.FE_UpdateDITAReferenceFailedCannotResolveReference
Constants.FE_UpdateDITAReferenceFailedInvalidElementType
Constants.FE_ViewOnly
Constants.FE_WantsCustom
Constants.FE_WantsLandscape
Constants.FE_WantsPortrait
Constants.FE_WithinFrame
Constants.FE_WrongProduct
Constants.FE_WrongView
Constants.FE_WrongWindow
Constants.FE_XRefUnresolved
Constants.FF_ALERT_CANCEL_DEFAULT
Constants.FF_ALERT_CONTINUE_NOTE
Constants.FF_ALERT_CONTINUE_WARN
Constants.FF_ALERT_DNS_OK
Constants.FF_ALERT_NO_DEFAULT
Constants.FF_ALERT_OK_DEFAULT
Constants.FF_ALERT_YES_DEFAULT
Constants.FF_ALERT_YES_NO_CANCEL
Constants.FF_ALT_KEY
Constants.FF_ATTACH_ALL
Constants.FF_ATTACH_BORDER_PAGENUM
Constants.FF_ATTACH_BORDER_PAGEUPDOWN
Constants.FF_ATTACH_BORDER_RIGHTICONS
Constants.FF_ATTACH_BORDER_STATUS
Constants.FF_ATTACH_BORDER_ZOOM
Constants.FF_ATTRDISP
Constants.FF_ATTRDISP_ALL
Constants.FF_ATTR_SEL
Constants.FF_BOR_EXT
Constants.FF_BOR_SEL
Constants.FF_BUBBLE_CONTEXT
Constants.FF_BUBBLE_COPY
Constants.FF_BUBBLE_EXT
Constants.FF_BUBBLE_EXT_CONTEXT
Constants.FF_BUBBLE_SEL
Constants.FF_CELLS_RES
Constants.FF_CELL_EXT
Constants.FF_CELL_RES
Constants.FF_CELL_SEL
Constants.FF_CLEAR_SEL
Constants.FF_CLOSE_MODIFIED
Constants.FF_CMD_KEY
Constants.FF_CMP_ATTRIBUTES
Constants.FF_CMP_CHANGE_BARS
Constants.FF_CMP_COMPKIT
Constants.FF_CMP_HYPERLINKS
Constants.FF_CMP_SUMKIT
Constants.FF_CMP_SUMMARY_ONLY
Constants.FF_COLLAPSE_ALL
Constants.FF_COLLAPSE_ELEM
Constants.FF_CONTEXT_DRAG
Constants.FF_CONTEXT_DRAGTXT
Constants.FF_CONTEXT_DRAG_EXT
Constants.FF_CONTEXT_MENU
Constants.FF_CONTROL_KEY
Constants.FF_COPY_TO_CLIP
Constants.FF_CUT_TBL_CELLS
Constants.FF_Custom_FirstPageLeft
Constants.FF_Custom_FirstPageRight
Constants.FF_Custom_SingleSided
Constants.FF_DIALOG_ALL
Constants.FF_DIALOG_INSET_POD
Constants.FF_DITAUpdateAllConrefs
Constants.FF_DITAUpdateAllLinks
Constants.FF_DITAUpdateAllReferences
Constants.FF_DITAUpdateAllTopicrefs
Constants.FF_DITAUpdateAllTopicsetrefs
Constants.FF_DITAUpdateAllXrefs
Constants.FF_DONT_APPLY_ALL_ROWS
Constants.FF_DONT_DELETE_HIDDEN_TEXT
Constants.FF_DUPLICATE_KEY_DEFINITION
Constants.FF_EDIT_ATTRIBUTE
Constants.FF_ELEMENT_CONTEXT
Constants.FF_ELEMENT_EXT
Constants.FF_ELEMENT_EXT_CONTEXT
Constants.FF_ELEMENT_SEL
Constants.FF_FOUND_IN_REFERENCED_FILE
Constants.FF_HYPERTEXT
Constants.FF_IED_DELETE_EMPTY_PAGES
Constants.FF_IED_DO_NOT_IMPORT_EDD
Constants.FF_IED_DO_NOT_IMPORT_STRUCTAPP
Constants.FF_IED_NO_NOTIFY
Constants.FF_IED_REMOVE_BOOK_INFO
Constants.FF_IED_REMOVE_OVERRIDES
Constants.FF_IMAGE_BACKGROUND
Constants.FF_IMAGE_CLIP
Constants.FF_IMAGE_MASTER
Constants.FF_IMAGE_NOTRIM
Constants.FF_IMAGE_PAGEFRAME
Constants.FF_INSERT_BELOW_RIGHT
Constants.FF_INTERACTIVE
Constants.FF_INVALID_KEY
Constants.FF_OBJ_CROTATE
Constants.FF_OBJ_EXT
Constants.FF_OBJ_EXT_BOR
Constants.FF_OBJ_Q_COPY
Constants.FF_OBJ_ROTATE
Constants.FF_OBJ_SEL
Constants.FF_OPEN_BOOK_COMP
Constants.FF_PASTE_CLIP_OBJ
Constants.FF_PASTE_CLIP_TEXT
Constants.FF_PASTE_SEL_TEXT
Constants.FF_REPLACE_CELLS
Constants.FF_RES_ADD
Constants.FF_RES_DEL
Constants.FF_RES_MOVE
Constants.FF_RES_MOVE1
Constants.FF_RES_VERTEX
Constants.FF_SELECT_WHOLE_TABLE
Constants.FF_SHIFT_KEY
Constants.FF_STRIP_HYPERTEXT
Constants.FF_STRUCTURE_MENU
Constants.FF_TABLE_SELALL
Constants.FF_TEXT_EXT
Constants.FF_TEXT_Q_COPY
Constants.FF_TEXT_SEL
Constants.FF_UFF_ALL
Constants.FF_UFF_COLOR
Constants.FF_UFF_COMBINED_FONTS
Constants.FF_UFF_COND
Constants.FF_UFF_DOCUMENT_PROPS
Constants.FF_UFF_FBA
Constants.FF_UFF_FONT
Constants.FF_UFF_MATH
Constants.FF_UFF_PAGE
Constants.FF_UFF_PGF
Constants.FF_UFF_REFPAGE
Constants.FF_UFF_REMOVE_EXCEPTIONS
Constants.FF_UFF_REMOVE_PAGE_BREAKS
Constants.FF_UFF_STYLE
Constants.FF_UFF_TABLE
Constants.FF_UFF_VAR
Constants.FF_UFF_XREF
Constants.FF_UNTAGGED_ASK
Constants.FF_UNTAGGED_DELETE
Constants.FF_UNTAGGED_UNCOND
Constants.FF_VIEWER_MENU
Constants.FF_VISIBLE_ONLY
Constants.FF_XRUI_CLOSED_DOCS
Constants.FF_XRUI_EVERYTHING
Constants.FF_XRUI_FORCE_UPDATE
Constants.FF_XRUI_INTERNAL
Constants.FF_XRUI_OPEN_DOCS
Constants.FI_PLUGIN_DESCRIPTION
Constants.FI_PLUGIN_FACET
Constants.FI_PLUGIN_FORMATID
Constants.FI_PLUGIN_INFORMAT
Constants.FI_PLUGIN_NAME
Constants.FI_PLUGIN_OUTFORMAT
Constants.FI_PLUGIN_PRODUCTNAME
Constants.FI_PLUGIN_PRODUCTS
Constants.FI_PLUGIN_SUFFIX
Constants.FI_PLUGIN_TYPE
Constants.FI_PLUGIN_VENDOR
Constants.FMV_CMDSUPPORTED
Constants.FO_AFrame
Constants.FO_Alert
Constants.FO_AnchoredFrame
Constants.FO_Arc
Constants.FO_AttrCondExpr
Constants.FO_Bad
Constants.FO_BodyPage
Constants.FO_Book
Constants.FO_BookComponent
Constants.FO_CMSConnection
Constants.FO_CMSObject
Constants.FO_CMSObject2
Constants.FO_CMSRegistration
Constants.FO_CMSSession
Constants.FO_Cblock
Constants.FO_Cell
Constants.FO_CharFmt
Constants.FO_Color
Constants.FO_CombinedFontDefn
Constants.FO_Command
Constants.FO_CondFmt
Constants.FO_CursorResource
Constants.FO_DBGroup
Constants.FO_DialogResource
Constants.FO_DitaMap
Constants.FO_DlgBox
Constants.FO_DlgButton
Constants.FO_DlgCheckBox
Constants.FO_DlgDate
Constants.FO_DlgEditBox
Constants.FO_DlgImage
Constants.FO_DlgLabel
Constants.FO_DlgListView
Constants.FO_DlgPopUp
Constants.FO_DlgRadioButton
Constants.FO_DlgScrollBar
Constants.FO_DlgScrollBox
Constants.FO_DlgTriBox
Constants.FO_Doc
Constants.FO_Element
Constants.FO_ElementDef
Constants.FO_Ellipse
Constants.FO_First_Internal
Constants.FO_Flow
Constants.FO_FmtChangeList
Constants.FO_FmtRule
Constants.FO_FmtRuleClause
Constants.FO_Fn
Constants.FO_Frame
Constants.FO_Graphic
Constants.FO_GraphicsFmt
Constants.FO_Group
Constants.FO_HiddenPage
Constants.FO_Inset
Constants.FO_Iterator
Constants.FO_KeyCatalog
Constants.FO_Last_Graphic
Constants.FO_Last_Internal
Constants.FO_Last_Page
Constants.FO_Line
Constants.FO_Marker
Constants.FO_MarkerType
Constants.FO_MasterPage
Constants.FO_Math
Constants.FO_MathML
Constants.FO_Menu
Constants.FO_MenuCell
Constants.FO_MenuItemSeparator
Constants.FO_Num
Constants.FO_Page
Constants.FO_Pgf
Constants.FO_PgfFmt
Constants.FO_Polygon
Constants.FO_Polyline
Constants.FO_Rectangle
Constants.FO_RefPage
Constants.FO_RoundRect
Constants.FO_Row
Constants.FO_Rubi
Constants.FO_RulingFmt
Constants.FO_Session
Constants.FO_StringResource
Constants.FO_SubCell
Constants.FO_SubCol
Constants.FO_SubCond
Constants.FO_SubDash
Constants.FO_SubPblock
Constants.FO_SubStyle
Constants.FO_SubTbl
Constants.FO_SubTextDef
Constants.FO_Tbl
Constants.FO_TblFmt
Constants.FO_TextFrame
Constants.FO_TextInset
Constants.FO_TextLine
Constants.FO_TiApiClient
Constants.FO_TiFlow
Constants.FO_TiText
Constants.FO_TiTextTable
Constants.FO_UFrame
Constants.FO_UnanchoredFrame
Constants.FO_Var
Constants.FO_VarFmt
Constants.FO_XLast_Graphic
Constants.FO_XRef
Constants.FO_XRefFmt
Constants.FP_AFrameIsCropped
Constants.FP_AFrameIsFloating
Constants.FP_AcrobatBookmarkDisplayTags
Constants.FP_AcrobatLevel
Constants.FP_ActiveAlert
Constants.FP_ActiveBook
Constants.FP_ActiveDoc
Constants.FP_ActiveView
Constants.FP_AddMarkerTypeToStandardMarkers
Constants.FP_AdjHyphens
Constants.FP_AlertClientName
Constants.FP_AlertClientUnique
Constants.FP_AlertString
Constants.FP_AlertType
Constants.FP_Alignment
Constants.FP_AllowAsSpecialCase
Constants.FP_AllowBaseFamilyBoldedAndObliqued
Constants.FP_AllowNewFileURL
Constants.FP_AllowedDataRange
Constants.FP_AlsoInsert
Constants.FP_AlsoInserts
Constants.FP_AnchorType
Constants.FP_Angle
Constants.FP_ApplyEOPRules
Constants.FP_ApplyFormatRules
Constants.FP_ArrowBaseAngle
Constants.FP_ArrowLength
Constants.FP_ArrowScaleFactor
Constants.FP_ArrowScaleHead
Constants.FP_ArrowTipAngle
Constants.FP_ArrowType
Constants.FP_AttrCondExprIsActive
Constants.FP_AttrCondExprStr
Constants.FP_AttrDisplay
Constants.FP_AttributeDefs
Constants.FP_AttributeValueInvalid
Constants.FP_AttributeValueRequired
Constants.FP_Attributes
Constants.FP_AttributesEx
Constants.FP_AutoBackup
Constants.FP_AutoChangeBars
Constants.FP_AutoNumChar
Constants.FP_AutoNumString
Constants.FP_AutoSave
Constants.FP_AutoSaveSeconds
Constants.FP_BIBGetAddressProc
Constants.FP_BannerText
Constants.FP_BannerTextDisplay
Constants.FP_BaseFamily
Constants.FP_BasePointX
Constants.FP_BasePointY
Constants.FP_BaselineOffset
Constants.FP_BkColor
Constants.FP_BkGndColor
Constants.FP_Black
Constants.FP_BlockLines
Constants.FP_BookComponent
Constants.FP_BookComponentFileType
Constants.FP_BookComponentIsFolderWithTemplate
Constants.FP_BookComponentIsFolderWithoutTemplate
Constants.FP_BookComponentIsGeneratable
Constants.FP_BookComponentMissing
Constants.FP_BookComponentParent
Constants.FP_BookComponentSequenceLevel
Constants.FP_BookComponentTemplatePath
Constants.FP_BookComponentTitle
Constants.FP_BookComponentType
Constants.FP_BookDontUpdateReferences
Constants.FP_BookIsModified
Constants.FP_BookIsSelected
Constants.FP_BookIsViewOnly
Constants.FP_BookParent
Constants.FP_BooleanConditionExpression
Constants.FP_BooleanConditionExpressionTag
Constants.FP_BooleanConditionState
Constants.FP_BorderWidth
Constants.FP_BottomMargin
Constants.FP_BottomRowSelection
Constants.FP_BottomSepAtIndent
Constants.FP_BottomSeparator
Constants.FP_Box_BG_Color
Constants.FP_CMSItemProperty_ItemCheckedOutByCurrentUser
Constants.FP_CMSItemProperty_ItemFileType
Constants.FP_CMSItemProperty_ItemIsCheckedOut
Constants.FP_CMSItemProperty_ItemIsContainer
Constants.FP_CMSItemProperty_ItemLocalPath
Constants.FP_CMSItemProperty_ItemName
Constants.FP_CMSItemProperty_ItemServerPath
Constants.FP_CMSItemProperty_ItemType
Constants.FP_CMSItemProperty_ItemVersion
Constants.FP_CMSItemProperty_Max
Constants.FP_CMSItemProperty_Min
Constants.FP_CTFontContext
Constants.FP_CanHaveCheckMark
Constants.FP_Capitalization
Constants.FP_CellAboveInCol
Constants.FP_CellAngle
Constants.FP_CellBelowInCol
Constants.FP_CellBelowInTbl
Constants.FP_CellBottomMargin
Constants.FP_CellBottomMarginChange
Constants.FP_CellBottomMarginFixed
Constants.FP_CellColNum
Constants.FP_CellDefaultBottomRuling
Constants.FP_CellDefaultLeftRuling
Constants.FP_CellDefaultRightRuling
Constants.FP_CellDefaultTopRuling
Constants.FP_CellIsShown
Constants.FP_CellIsStraddled
Constants.FP_CellLeftMargin
Constants.FP_CellLeftMarginChange
Constants.FP_CellLeftMarginFixed
Constants.FP_CellMarginSpacingDelta
Constants.FP_CellMarginsFixed
Constants.FP_CellNumColsStraddled
Constants.FP_CellNumRowsStraddled
Constants.FP_CellOverrideBottomRuling
Constants.FP_CellOverrideFill
Constants.FP_CellOverrideLeftRuling
Constants.FP_CellOverrideRightRuling
Constants.FP_CellOverrideShading
Constants.FP_CellOverrideTopRuling
Constants.FP_CellRightMargin
Constants.FP_CellRightMarginChange
Constants.FP_CellRightMarginFixed
Constants.FP_CellRow
Constants.FP_CellTopMargin
Constants.FP_CellTopMarginChange
Constants.FP_CellTopMarginFixed
Constants.FP_CellUseOverrideBRuling
Constants.FP_CellUseOverrideFill
Constants.FP_CellUseOverrideLRuling
Constants.FP_CellUseOverrideRRuling
Constants.FP_CellUseOverrideShading
Constants.FP_CellUseOverrideTRuling
Constants.FP_CellVAlignment
Constants.FP_ChangeBar
Constants.FP_ChangeBarColor
Constants.FP_ChangeBarDistance
Constants.FP_ChangeBarPosition
Constants.FP_ChangeBarThickness
Constants.FP_ChapNumComputeMethod
Constants.FP_ChapterNumStyle
Constants.FP_ChapterNumText
Constants.FP_ChapterNumber
Constants.FP_CharTag
Constants.FP_CharacterReferencesOnXMLExport
Constants.FP_CheckMarkIsOn
Constants.FP_ColGap
Constants.FP_ColGapWidth
Constants.FP_Color
Constants.FP_ColorOverprint
Constants.FP_ColorPrintCtl
Constants.FP_ColorTintPercent
Constants.FP_ColorViewCtl
Constants.FP_ColumnsAreBalanced
Constants.FP_CombinedFontFamily
Constants.FP_CommandNum
Constants.FP_Comment
Constants.FP_ComponentDisplayText
Constants.FP_ComponentElement
Constants.FP_ComponentIsDitaMap
Constants.FP_ComponentIsSelected
Constants.FP_ComponentType
Constants.FP_CondFmtIsShown
Constants.FP_ContentHeight
Constants.FP_ContentIsLooselyValid
Constants.FP_ContentIsStrictlyValid
Constants.FP_ContentMustBeEmpty
Constants.FP_ContentNeededAtBegin
Constants.FP_ContentNeededAtEnd
Constants.FP_ContextForCSS
Constants.FP_ContextLabel
Constants.FP_CorrespondingXmlPath
Constants.FP_CountElements
Constants.FP_CurrentDoc
Constants.FP_CurrentInset
Constants.FP_CurrentMenuSet
Constants.FP_CurrentPage
Constants.FP_CursorData
Constants.FP_CursorTypes
Constants.FP_CustomDelimiter
Constants.FP_CustomDocPath
Constants.FP_CustomElementList
Constants.FP_Cyan
Constants.FP_DTheta
Constants.FP_Dash
Constants.FP_Day
Constants.FP_DbAttributes
Constants.FP_DbCancelButton
Constants.FP_DbCheckBoxState
Constants.FP_DbDefaultButton
Constants.FP_DbEditable
Constants.FP_DbFbCurrentDir
Constants.FP_DbFbScrollBox
Constants.FP_DbFbStatus
Constants.FP_DbFbTextBox
Constants.FP_DbFirstFocus
Constants.FP_DbIdentifier
Constants.FP_DbItemNum
Constants.FP_DbNoHelp
Constants.FP_DbOKButton
Constants.FP_DbRadioButtonGroup
Constants.FP_DbSbxNumLines
Constants.FP_DbStuffItem
Constants.FP_DbTitleLabel
Constants.FP_DbType
Constants.FP_DbVarLabelWidth
Constants.FP_DefaultExclusions
Constants.FP_DefaultFontAngle
Constants.FP_DefaultFontFamily
Constants.FP_DefaultFontVariation
Constants.FP_DefaultFontWeight
Constants.FP_DefaultInclusions
Constants.FP_DefaultKeyCatalog
Constants.FP_DefaultVectorFormatForXMLExport
Constants.FP_DescriptiveTag
Constants.FP_DesktopHeight
Constants.FP_DesktopWidth
Constants.FP_DesktopX
Constants.FP_DesktopY
Constants.FP_DialogEncodingName
Constants.FP_Dictionary
Constants.FP_DirectOLESupportInXml
Constants.FP_DisableAutofitAfterZoom
Constants.FP_DisplayName
Constants.FP_Displaying
Constants.FP_DitaMode
Constants.FP_DoNotExportInvalidXML
Constants.FP_DoNotGenerateErrorLog
Constants.FP_DoPostXSLTValidationOnExport
Constants.FP_DocAcrobatColumnArticleThreads
Constants.FP_DocAcrobatDefaultsChanged
Constants.FP_DocAcrobatElementList
Constants.FP_DocAcrobatElements
Constants.FP_DocAcrobatNoArticleThreads
Constants.FP_DocFluidFlow
Constants.FP_DocIsDoubleSided
Constants.FP_DocIsHelp
Constants.FP_DocIsInternal
Constants.FP_DocIsModified
Constants.FP_DocIsStructuredDummy
Constants.FP_DocIsViewOnly
Constants.FP_DocIsViewOnlyWinPalette
Constants.FP_DocOpenClientEncounteredErrors
Constants.FP_DocOpenType
Constants.FP_DocSaveFormat
Constants.FP_DocSaveType
Constants.FP_DocSequenceLevel
Constants.FP_DockDialog
Constants.FP_DontLoadStartupClients
Constants.FP_DontShowWelcomeScreen
Constants.FP_DontUpdateTextInsets
Constants.FP_DontUpdateXRefs
Constants.FP_DoubleClick
Constants.FP_DownloadFonts
Constants.FP_ElemPrefixSuffix
Constants.FP_Element
Constants.FP_ElementBoundaryDisplay
Constants.FP_ElementCatalog
Constants.FP_ElementCatalogDisplay
Constants.FP_ElementDataType
Constants.FP_ElementDef
Constants.FP_ElementDefType
Constants.FP_ElementDescription
Constants.FP_ElementInCatalog
Constants.FP_ElementIsCollapsed
Constants.FP_ElementIsExcludedInContext
Constants.FP_ElementIsInvalidInParent
Constants.FP_ElementIsInvalidInPosition
Constants.FP_ElementIsTopicGroup
Constants.FP_ElementIsTopicHead
Constants.FP_ElementIsTopicRef
Constants.FP_ElementIsUndefined
Constants.FP_ElementMarkedForNamedDestination
Constants.FP_ElementPgfFormat
Constants.FP_ElementSelection
Constants.FP_ElementType
Constants.FP_ElementTypeMismatch
Constants.FP_EnableAutoSpellCheck
Constants.FP_EnabledWhen
Constants.FP_EqnIntegralSizeLarge
Constants.FP_EqnIntegralSizeMed
Constants.FP_EqnIntegralSizeSmall
Constants.FP_EqnLevel1SizeLarge
Constants.FP_EqnLevel1SizeMed
Constants.FP_EqnLevel1SizeSmall
Constants.FP_EqnLevel2SizeLarge
Constants.FP_EqnLevel2SizeMed
Constants.FP_EqnLevel2SizeSmall
Constants.FP_EqnLevel3SizeLarge
Constants.FP_EqnLevel3SizeMed
Constants.FP_EqnLevel3SizeSmall
Constants.FP_EqnSigmaSizeLarge
Constants.FP_EqnSigmaSizeMed
Constants.FP_EqnSigmaSizeSmall
Constants.FP_ErrorInBookComponent
Constants.FP_ExcludeBookComponent
Constants.FP_Exclusions
Constants.FP_ExpandOMaticParent
Constants.FP_ExportFilters
Constants.FP_ExtractElementTags
Constants.FP_ExtractTags
Constants.FP_FMConsoleString
Constants.FP_FMInterfaceEncodingName
Constants.FP_FM_BinDir
Constants.FP_FM_CurrentDir
Constants.FP_FM_HelpDir
Constants.FP_FM_HomeDir
Constants.FP_FM_InitDir
Constants.FP_FM_SgmlDir
Constants.FP_FM_StructureDir
Constants.FP_FM_XmlDir
Constants.FP_FamilyName
Constants.FP_Fcode
Constants.FP_Fcodes
Constants.FP_FileExtensionOverride
Constants.FP_FileInfoPacket
Constants.FP_Fill
Constants.FP_FirstAFrame
Constants.FP_FirstAttrCondExprInDoc
Constants.FP_FirstBodyPageInDoc
Constants.FP_FirstCell
Constants.FP_FirstCellInRow
Constants.FP_FirstCharFmtInDoc
Constants.FP_FirstChildElement
Constants.FP_FirstColorInDoc
Constants.FP_FirstCombinedFontDefnInDoc
Constants.FP_FirstCommandInSession
Constants.FP_FirstComponentInBook
Constants.FP_FirstComponentInBookComponent
Constants.FP_FirstCondFmtInDoc
Constants.FP_FirstDITAConrefElementInDoc
Constants.FP_FirstDITALinkElementInDoc
Constants.FP_FirstDITATopicrefElementInDoc
Constants.FP_FirstDITATopicsetrefElementInDoc
Constants.FP_FirstDITAXrefElementInDoc
Constants.FP_FirstElementDefInDoc
Constants.FP_FirstFlowInDoc
Constants.FP_FirstFmtChangeListInDoc
Constants.FP_FirstFn
Constants.FP_FirstFnInDoc
Constants.FP_FirstGraphicInDoc
Constants.FP_FirstGraphicInFrame
Constants.FP_FirstGraphicInGroup
Constants.FP_FirstGraphicsFmtInDoc
Constants.FP_FirstIndent
Constants.FP_FirstIndentChange
Constants.FP_FirstIndentIsRelative
Constants.FP_FirstIndentRelPos
Constants.FP_FirstKeyCatalogInSession
Constants.FP_FirstMarkerInDoc
Constants.FP_FirstMarkerTypeInDoc
Constants.FP_FirstMasterPageInDoc
Constants.FP_FirstMenuItemInMenu
Constants.FP_FirstMenuItemInSession
Constants.FP_FirstOpenBook
Constants.FP_FirstOpenDoc
Constants.FP_FirstPageNum
Constants.FP_FirstPageVerso
Constants.FP_FirstPgf
Constants.FP_FirstPgfFmtInDoc
Constants.FP_FirstPgfInDoc
Constants.FP_FirstPgfRules
Constants.FP_FirstRefPageInDoc
Constants.FP_FirstRowInTbl
Constants.FP_FirstRubiInDoc
Constants.FP_FirstRulingFmtInDoc
Constants.FP_FirstSelectedComponentInBook
Constants.FP_FirstSelectedGraphicInDoc
Constants.FP_FirstSelectedTiInDoc
Constants.FP_FirstSubCol
Constants.FP_FirstTblFmtInDoc
Constants.FP_FirstTblInDoc
Constants.FP_FirstTextFrameInFlow
Constants.FP_FirstTiInDoc
Constants.FP_FirstVarFmtInDoc
Constants.FP_FirstVarInDoc
Constants.FP_FirstVis
Constants.FP_FirstXRefFmtInDoc
Constants.FP_FirstXRefInDoc
Constants.FP_Flow
Constants.FP_FlowIsAutoConnect
Constants.FP_FlowIsFeathered
Constants.FP_FlowIsPostScript
Constants.FP_FlowIsSynchronized
Constants.FP_Fmt
Constants.FP_FmtChangeList
Constants.FP_FmtChangeListInCatalog
Constants.FP_FmtChangeListTag
Constants.FP_FmtRule
Constants.FP_FmtRuleClause
Constants.FP_FmtRuleClauses
Constants.FP_FmtRuleType
Constants.FP_FnAnchorString
Constants.FP_FnCustNumString
Constants.FP_FnFirstNum
Constants.FP_FnFmt
Constants.FP_FnHeightPerCol
Constants.FP_FnInstancePosition
Constants.FP_FnInstancePrefix
Constants.FP_FnInstanceSuffix
Constants.FP_FnNum
Constants.FP_FnNumComputeMethod
Constants.FP_FnNumStyle
Constants.FP_FnNumberingPerPage
Constants.FP_FnRefPosition
Constants.FP_FnRefPrefix
Constants.FP_FnRefSuffix
Constants.FP_Focus
Constants.FP_FontAngle
Constants.FP_FontAngleNames
Constants.FP_FontEncodingName
Constants.FP_FontFamily
Constants.FP_FontFamilyAttributes
Constants.FP_FontFamilyFullNames
Constants.FP_FontFamilyNames
Constants.FP_FontPanoseName
Constants.FP_FontPlatformName
Constants.FP_FontPostScriptName
Constants.FP_FontSize
Constants.FP_FontSizeChange
Constants.FP_FontVariation
Constants.FP_FontVariationNames
Constants.FP_FontWeight
Constants.FP_FontWeightNames
Constants.FP_FormatOverride
Constants.FP_FormatTag
Constants.FP_FormattingLocked
Constants.FP_FrameParent
Constants.FP_Functions
Constants.FP_GeneralRule
Constants.FP_GeneralRuleErrorOffsets
Constants.FP_GenerateAcrobatInfo
Constants.FP_GenerateInclude
Constants.FP_GraphicCantBeSelected
Constants.FP_GraphicIsButton
Constants.FP_GraphicIsSelected
Constants.FP_Gravity
Constants.FP_GreekSize
Constants.FP_GroupDialog
Constants.FP_GroupParent
Constants.FP_HasShiftOrUnshiftCommand
Constants.FP_HeadArrow
Constants.FP_Height
Constants.FP_HelpLink
Constants.FP_HelpPending
Constants.FP_HiddenPage
Constants.FP_HighestLevelElement
Constants.FP_HoleAtEnd
Constants.FP_HoleBeforeElement
Constants.FP_HorizontalSpreadLarge
Constants.FP_HorizontalSpreadMed
Constants.FP_HorizontalSpreadSmall
Constants.FP_HostName
Constants.FP_HotspotCmdStr
Constants.FP_HotspotTitle
Constants.FP_Hypertext
Constants.FP_HypertextCommandText
Constants.FP_HypertextDoValidate
Constants.FP_HypertextParseBadParam
Constants.FP_HypertextParseErr
Constants.FP_HypertextParseErrMsg
Constants.FP_HypertextParsedArgs
Constants.FP_HypertextParsedClientName
Constants.FP_HypertextParsedCmdCode
Constants.FP_HypertextParsedCmdDest
Constants.FP_HypertextParsedCmdDestObjID
Constants.FP_HypertextParsedCmdDestObjType
Constants.FP_HypertextParsedCmdMatrixColumns
Constants.FP_HypertextParsedCmdMatrixRows
Constants.FP_HypertextParsedDIFileName
Constants.FP_HypertextParsedFlowName
Constants.FP_HypertextParsedLinkName
Constants.FP_HypertextParsedMessage
Constants.FP_HypertextParsedPageName
Constants.FP_HypertextParsedRangeName
Constants.FP_HypertextParsedTitle
Constants.FP_HypertextValidateErr
Constants.FP_HyphMinPrefix
Constants.FP_HyphMinSuffix
Constants.FP_HyphMinWord
Constants.FP_Hyphenate
Constants.FP_IDAttrValue
Constants.FP_INSETinfo
Constants.FP_Icon
Constants.FP_IconBarOn
Constants.FP_IconColorPref
Constants.FP_IconSizePref
Constants.FP_ImportFilters
Constants.FP_ImportFmtInclude
Constants.FP_ImportHint
Constants.FP_InCond
Constants.FP_InTableSortOperation
Constants.FP_InTextFrame
Constants.FP_InTextObj
Constants.FP_Inclusions
Constants.FP_IncrVal
Constants.FP_InitStructurePattern
Constants.FP_InkName
Constants.FP_InsertLinks
Constants.FP_InsetCuePointList
Constants.FP_InsetDpi
Constants.FP_InsetEditor
Constants.FP_InsetFile
Constants.FP_InsetFileOrigName
Constants.FP_InsetGenericData
Constants.FP_InsetGfxActiveInPdf
Constants.FP_InsetGfxName
Constants.FP_InsetGfxPlayWindowInPdf
Constants.FP_InsetIsFixedSize
Constants.FP_InsetIsFlippedSideways
Constants.FP_InsetIsInverted
Constants.FP_InsetJavaScriptAttached
Constants.FP_InsetJavaScriptFile
Constants.FP_InsetLinkToText
Constants.FP_InsetMonikerFilePath
Constants.FP_InsetMonikerPath
Constants.FP_InsetPosterFile
Constants.FP_InsetPosterFileOrigName
Constants.FP_InsetPosterIsExternal
Constants.FP_InsetRasterDpi
Constants.FP_InsetSaveDIBFacetToFile
Constants.FP_InsetSaveFacetToFile
Constants.FP_InsetU3dAnimationList
Constants.FP_InsetU3dPartList
Constants.FP_InsetU3dViewList
Constants.FP_InsetURL
Constants.FP_InsetUpdater
Constants.FP_InternalHeight
Constants.FP_InternalMathMLComposeDpi
Constants.FP_InternalMathMLFontSize
Constants.FP_InternalMathMLXmlData
Constants.FP_InternalWidth
Constants.FP_InvalidHighestLevel
Constants.FP_InvariantName
Constants.FP_IsDefault
Constants.FP_IsDialogDocked
Constants.FP_IsDialogVisible
Constants.FP_IsDitamapInResourceManager
Constants.FP_IsDocDita
Constants.FP_IsDocDitamap
Constants.FP_IsFMRunningAsServer
Constants.FP_IsFMRunningInTrialPeriod
Constants.FP_IsFateRun
Constants.FP_IsHotspot
Constants.FP_IsIconified
Constants.FP_IsInFront
Constants.FP_IsOnScreen
Constants.FP_IsRestoring
Constants.FP_IsStale
Constants.FP_IsTechnicalSuiteLicensed
Constants.FP_IsTempOpenSave
Constants.FP_IsTextRange
Constants.FP_KByteAllocationSize
Constants.FP_KeepWithNext
Constants.FP_KeepWithPrev
Constants.FP_KernX
Constants.FP_KernY
Constants.FP_KeyCatalog
Constants.FP_KeyCatalogClientName
Constants.FP_KeyCatalogType
Constants.FP_KeyCatalogWorkflow
Constants.FP_KeyCount
Constants.FP_KeyboardShortcutLabel
Constants.FP_KeyboardShortcuts
Constants.FP_Label
Constants.FP_LabelBold
Constants.FP_LabelColor
Constants.FP_Labels
Constants.FP_Language
Constants.FP_LastAFrame
Constants.FP_LastBodyPageInDoc
Constants.FP_LastCell
Constants.FP_LastChildElement
Constants.FP_LastFn
Constants.FP_LastGraphicInFrame
Constants.FP_LastGraphicInGroup
Constants.FP_LastMasterPageInDoc
Constants.FP_LastPgf
Constants.FP_LastPgfRules
Constants.FP_LastRefPageInDoc
Constants.FP_LastRowInTbl
Constants.FP_LastSubCol
Constants.FP_LastTextFrameInFlow
Constants.FP_LastUpdate
Constants.FP_Leading
Constants.FP_LeadingChange
Constants.FP_LeftColNum
Constants.FP_LeftIndent
Constants.FP_LeftIndentChange
Constants.FP_LeftMargin
Constants.FP_LeftMasterPage
Constants.FP_LetterSpace
Constants.FP_LineAscent
Constants.FP_LineBaseline
Constants.FP_LineBreakAfter
Constants.FP_LineCap
Constants.FP_LineDescent
Constants.FP_LineNumColor
Constants.FP_LineNumDistance
Constants.FP_LineNumFont
Constants.FP_LineNumRestart
Constants.FP_LineNumShow
Constants.FP_LineNumSize
Constants.FP_LineSpacing
Constants.FP_LineSpacingFactor
Constants.FP_LineSpacingFixed
Constants.FP_LoadStartupScripts
Constants.FP_LocX
Constants.FP_LocY
Constants.FP_Locked
Constants.FP_Magenta
Constants.FP_MagicMarker
Constants.FP_MainFlowInDoc
Constants.FP_MarkerNames
Constants.FP_MarkerText
Constants.FP_MarkerTypeId
Constants.FP_MarkerTypeNames
Constants.FP_MasterPage
Constants.FP_MatchesContextInUserString
Constants.FP_MatchingFirstPgfClauses
Constants.FP_MatchingLastPgfClauses
Constants.FP_MatchingObjectClauses
Constants.FP_MatchingPrefixClauses
Constants.FP_MatchingSuffixClauses
Constants.FP_MatchingTextClauses
Constants.FP_MathFullForm
Constants.FP_MathMLComposeDpi
Constants.FP_MathMLData
Constants.FP_MathMLDpi
Constants.FP_MathMLFile
Constants.FP_MathMLFontSize
Constants.FP_MathMLImportGraphicsDpi
Constants.FP_MathMLIsFixedSize
Constants.FP_MathMLIsFlippedSideways
Constants.FP_MathMLIsInverted
Constants.FP_MathMLNamespacePrefix
Constants.FP_MathMLXmlData
Constants.FP_MathSize
Constants.FP_MaxBottomMargin
Constants.FP_MaxFirstIndent
Constants.FP_MaxFontSize
Constants.FP_MaxInterPgfPadding
Constants.FP_MaxInterlinePadding
Constants.FP_MaxJLetSpace
Constants.FP_MaxJRomSpace
Constants.FP_MaxLeading
Constants.FP_MaxLeftIndent
Constants.FP_MaxLeftMargin
Constants.FP_MaxRightIndent
Constants.FP_MaxRightMargin
Constants.FP_MaxSize
Constants.FP_MaxSpace
Constants.FP_MaxSpaceAbove
Constants.FP_MaxSpaceBelow
Constants.FP_MaxSpread
Constants.FP_MaxStretch
Constants.FP_MaxTabPosition
Constants.FP_MaxTopMargin
Constants.FP_MaxVal
Constants.FP_MenuBar
Constants.FP_MenuItemIsEnabled
Constants.FP_MenuItemType
Constants.FP_MenuType
Constants.FP_Mif8bitOutput
Constants.FP_MifFileEntity
Constants.FP_MifFileName
Constants.FP_MifFileOrigFormat
Constants.FP_MinBottomMargin
Constants.FP_MinFirstIndent
Constants.FP_MinFontSize
Constants.FP_MinHang
Constants.FP_MinJLetSpace
Constants.FP_MinJRomSpace
Constants.FP_MinLeading
Constants.FP_MinLeftIndent
Constants.FP_MinLeftMargin
Constants.FP_MinRightIndent
Constants.FP_MinRightMargin
Constants.FP_MinSize
Constants.FP_MinSpace
Constants.FP_MinSpaceAbove
Constants.FP_MinSpaceBelow
Constants.FP_MinSpread
Constants.FP_MinStretch
Constants.FP_MinTabPosition
Constants.FP_MinTopMargin
Constants.FP_MinVal
Constants.FP_Mode
Constants.FP_ModelessDlgIconN
Constants.FP_ModelessDlgIconR
Constants.FP_Month
Constants.FP_MoveTabs
Constants.FP_Name
Constants.FP_Namespace
Constants.FP_NamespaceScope
Constants.FP_NarrowRubiSpaceForJapanese
Constants.FP_NarrowRubiSpaceForOther
Constants.FP_NewElemAttrDisplay
Constants.FP_NewElemAttrEditing
Constants.FP_NextAFrame
Constants.FP_NextAttrCondExprInDoc
Constants.FP_NextBookComponentInDFSOrder
Constants.FP_NextCell
Constants.FP_NextCellInRow
Constants.FP_NextCellInTbl
Constants.FP_NextCharFmtInDoc
Constants.FP_NextColorInDoc
Constants.FP_NextCombinedFontDefnInDoc
Constants.FP_NextCommandInSession
Constants.FP_NextComponentInBook
Constants.FP_NextCondFmtInDoc
Constants.FP_NextDITAConrefElementInDoc
Constants.FP_NextDITALinkElementInDoc
Constants.FP_NextDITATopicrefElementInDoc
Constants.FP_NextDITATopicsetrefElementInDoc
Constants.FP_NextDITAXrefElementInDoc
Constants.FP_NextElementDFS
Constants.FP_NextElementDefInDoc
Constants.FP_NextFlowInDoc
Constants.FP_NextFmtChangeListInDoc
Constants.FP_NextFn
Constants.FP_NextFnInDoc
Constants.FP_NextGraphicInDoc
Constants.FP_NextGraphicInFrame
Constants.FP_NextGraphicInGroup
Constants.FP_NextGraphicsFmtInDoc
Constants.FP_NextInvalidElement
Constants.FP_NextKeyCatalogInSession
Constants.FP_NextMarkerInDoc
Constants.FP_NextMarkerTypeInDoc
Constants.FP_NextMenuItemInMenu
Constants.FP_NextMenuItemInSession
Constants.FP_NextOpenBookInSession
Constants.FP_NextOpenDocInSession
Constants.FP_NextPgfFmtInDoc
Constants.FP_NextPgfInDoc
Constants.FP_NextPgfInFlow
Constants.FP_NextRowInTbl
Constants.FP_NextRubiInDoc
Constants.FP_NextRulingFmtInDoc
Constants.FP_NextSelectedComponentInBook
Constants.FP_NextSelectedGraphicInDoc
Constants.FP_NextSiblingElement
Constants.FP_NextSubCol
Constants.FP_NextTag
Constants.FP_NextTblFmtInDoc
Constants.FP_NextTblInDoc
Constants.FP_NextTextFrameInFlow
Constants.FP_NextTiInDoc
Constants.FP_NextVarFmtInDoc
Constants.FP_NextVarInDoc
Constants.FP_NextXRefFmtInDoc
Constants.FP_NextXRefInDoc
Constants.FP_No3DInPDF
Constants.FP_NoAppOutputPIFiltered
Constants.FP_NoFlashInPDF
Constants.FP_NoMultiMediaInPDF
Constants.FP_NotLoaded
Constants.FP_NumAtEnd
Constants.FP_NumCols
Constants.FP_NumColumns
Constants.FP_NumItems
Constants.FP_NumLines
Constants.FP_NumNamespaces
Constants.FP_NumPoints
Constants.FP_NumTabs
Constants.FP_Numbers
Constants.FP_Object
Constants.FP_ObjectAttributes
Constants.FP_ObjectFmtRules
Constants.FP_OldTypeNum
Constants.FP_OpenAndSaveXmlBookComponentDoc
Constants.FP_OpenDir
Constants.FP_OperatingSystem
Constants.FP_OptJLetSpace
Constants.FP_OptJRomSpace
Constants.FP_OptSpace
Constants.FP_OrphanRows
Constants.FP_Outline
Constants.FP_Overflowed
Constants.FP_Overline
Constants.FP_Overprint
Constants.FP_OyamojiTextRange
Constants.FP_PDFAllNamedDestinations
Constants.FP_PDFBookmark
Constants.FP_PDFBookmarksOpenLevel
Constants.FP_PDFConvertCMYKtoRGB
Constants.FP_PDFDestsMarked
Constants.FP_PDFDistillerAbsent
Constants.FP_PDFDocInfo
Constants.FP_PDFEndPage
Constants.FP_PDFGenerateForReview
Constants.FP_PDFJobOption
Constants.FP_PDFJobOptionsAbsent
Constants.FP_PDFOpenPage
Constants.FP_PDFPageHeight
Constants.FP_PDFPageNum
Constants.FP_PDFPageWidth
Constants.FP_PDFPrintPageRange
Constants.FP_PDFRegistrationMarks
Constants.FP_PDFSeparateFiles
Constants.FP_PDFStartPage
Constants.FP_PDFStructure
Constants.FP_PDFStructureLevel
Constants.FP_PDFViewPDF
Constants.FP_PDFZoomFactor
Constants.FP_PDFZoomType
Constants.FP_PageBackground
Constants.FP_PageFrame
Constants.FP_PageFramePage
Constants.FP_PageHeight
Constants.FP_PageIsRecto
Constants.FP_PageNext
Constants.FP_PageNum
Constants.FP_PageNumComputeMethod
Constants.FP_PageNumString
Constants.FP_PageNumStyle
Constants.FP_PagePrefix
Constants.FP_PagePrev
Constants.FP_PageRounding
Constants.FP_PageSide
Constants.FP_PageSuffix
Constants.FP_PageWidth
Constants.FP_PairKern
Constants.FP_Pantone
Constants.FP_ParentElement
Constants.FP_ParentTextFrame
Constants.FP_ParseFullSpecification
Constants.FP_ParsedGeneralRule
Constants.FP_ParsedSpecification
Constants.FP_PasswordStyle
Constants.FP_Path
Constants.FP_Pen
Constants.FP_PercentDone
Constants.FP_PgfAlignment
Constants.FP_PgfBoxColor
Constants.FP_PgfCatalogReference
Constants.FP_PgfIsAutoNum
Constants.FP_PgfMarkedForNamedDestination
Constants.FP_PgfNumComputeMethod
Constants.FP_PgfNumber
Constants.FP_PgfSpacingFactor
Constants.FP_PgfSpellChecked
Constants.FP_PgfSplit
Constants.FP_Placement
Constants.FP_Platform
Constants.FP_PointPageNum
Constants.FP_PointPageNumStyle
Constants.FP_Points
Constants.FP_PolyIsBezier
Constants.FP_Position
Constants.FP_PrefixRules
Constants.FP_PreserveFormattingInXml
Constants.FP_PrevAFrame
Constants.FP_PrevBookComponentInDFSOrder
Constants.FP_PrevCell
Constants.FP_PrevCellInRow
Constants.FP_PrevComponentInBook
Constants.FP_PrevElementDFS
Constants.FP_PrevFn
Constants.FP_PrevGraphicInFrame
Constants.FP_PrevGraphicInGroup
Constants.FP_PrevMenuItemInMenu
Constants.FP_PrevPgfInFlow
Constants.FP_PrevRowInTbl
Constants.FP_PrevSiblingElement
Constants.FP_PrevSubCol
Constants.FP_PrevTextFrameInFlow
Constants.FP_PreviewState
Constants.FP_PrintBlankPages
Constants.FP_PrintCollated
Constants.FP_PrintCols
Constants.FP_PrintDitavalFileName
Constants.FP_PrintDownloadAsianFonts
Constants.FP_PrintDownloadTrueTypeAsType1
Constants.FP_PrintEmulsion
Constants.FP_PrintEndPage
Constants.FP_PrintEndPageName
Constants.FP_PrintEndPoint
Constants.FP_PrintEvenPages
Constants.FP_PrintFileName
Constants.FP_PrintImaging
Constants.FP_PrintInclude
Constants.FP_PrintLastSheetFirst
Constants.FP_PrintLowRes
Constants.FP_PrintManualFeed
Constants.FP_PrintNumCopies
Constants.FP_PrintOddPages
Constants.FP_PrintPaperHeight
Constants.FP_PrintPaperWidth
Constants.FP_PrintRegMarkDate
Constants.FP_PrintRegistrationMarks
Constants.FP_PrintRows
Constants.FP_PrintScale
Constants.FP_PrintScope
Constants.FP_PrintSeps
Constants.FP_PrintSpotBW
Constants.FP_PrintStartPage
Constants.FP_PrintStartPageName
Constants.FP_PrintStartPoint
Constants.FP_PrintThumbnails
Constants.FP_PrintToFile
Constants.FP_PrintTomboMarks
Constants.FP_PrinterName
Constants.FP_ProcessNumber
Constants.FP_Product
Constants.FP_ProductFamily
Constants.FP_ProductIsDemo
Constants.FP_ProductIsStructured
Constants.FP_ProductName
Constants.FP_ProgId
Constants.FP_Public
Constants.FP_Radius
Constants.FP_RasterFilterDpi
Constants.FP_ReadOnly
Constants.FP_RectangleIsSmoothed
Constants.FP_Reformatting
Constants.FP_RememberMissingFontNames
Constants.FP_RemoveExtraWhiteSpacesOnXMLImport
Constants.FP_Required
Constants.FP_ReservedColor
Constants.FP_ResizeGripperPos
Constants.FP_RestartFrameAlertRequired
Constants.FP_RetainUndoState
Constants.FP_ReviewTime
Constants.FP_ReviewerName
Constants.FP_ReviewerNameList
Constants.FP_RightColNum
Constants.FP_RightIndent
Constants.FP_RightIndentChange
Constants.FP_RightMargin
Constants.FP_RightMasterPage
Constants.FP_RowIsShown
Constants.FP_RowKeepWithNext
Constants.FP_RowKeepWithPrev
Constants.FP_RowMaxHeight
Constants.FP_RowMinHeight
Constants.FP_RowStart
Constants.FP_RowTbl
Constants.FP_RowType
Constants.FP_RpcProgramNumber
Constants.FP_RpcPropertyName
Constants.FP_RubiAlignAtLineBounds
Constants.FP_RubiElement
Constants.FP_RubiFixedSize
Constants.FP_RubiOverhang
Constants.FP_RubiSize
Constants.FP_RubiTextRange
Constants.FP_RuleClauseType
Constants.FP_RulingGap
Constants.FP_RulingLines
Constants.FP_RulingPenWidth
Constants.FP_RulingSep
Constants.FP_RunInSeparator
Constants.FP_Runaround
Constants.FP_RunaroundGap
Constants.FP_ScreenCaptureDocToFile
Constants.FP_ScreenHeight
Constants.FP_ScreenWidth
Constants.FP_ScreenX
Constants.FP_ScreenY
Constants.FP_SecNumComputeMethod
Constants.FP_SectionNumStyle
Constants.FP_SectionNumText
Constants.FP_SectionNumber
Constants.FP_SelectedRowItems
Constants.FP_SelectedTbl
Constants.FP_Sensitivity
Constants.FP_SepOverride
Constants.FP_SeparateInclusions
Constants.FP_ServerState
Constants.FP_ServerUrl
Constants.FP_Shadow
Constants.FP_ShiftOrUnshiftCommand
Constants.FP_ShowAll
Constants.FP_ShowCondIndicators
Constants.FP_ShowElementDescriptiveNames
Constants.FP_SideHeadGap
Constants.FP_SideHeadPlacement
Constants.FP_SideHeadRoomInFlow
Constants.FP_SideHeadWidth
Constants.FP_SideOffset
Constants.FP_Size
Constants.FP_SkipBlankSeps
Constants.FP_SmallCapsSize
Constants.FP_SmallCapsStretch
Constants.FP_SmartQuotes
Constants.FP_SmartSpaces
Constants.FP_Snap
Constants.FP_SnapAngle
Constants.FP_SnapGridUnits
Constants.FP_SortingEnabled
Constants.FP_Source
Constants.FP_SourceType
Constants.FP_SpaceAbove
Constants.FP_SpaceAboveChange
Constants.FP_SpaceBelow
Constants.FP_SpaceBelowChange
Constants.FP_Spacing
Constants.FP_Specification
Constants.FP_SpecificationForCSS
Constants.FP_SpecifiedKeyCatalog
Constants.FP_SpotColorView
Constants.FP_Spread
Constants.FP_SpreadChange
Constants.FP_StackWarningLevel
Constants.FP_Start
Constants.FP_State
Constants.FP_StatusLine
Constants.FP_StopCountingAt
Constants.FP_Stretch
Constants.FP_StretchChange
Constants.FP_Strikethrough
Constants.FP_Strings
Constants.FP_StructAppAttrConfigFile
Constants.FP_StructAppsFile
Constants.FP_StructAppsFileId
Constants.FP_StructureCursorTypes
Constants.FP_StructuredApplication
Constants.FP_StructuredApplicationForOpen
Constants.FP_StructuredApplicationList
Constants.FP_StructuredDummyDocText
Constants.FP_StyleOverride
Constants.FP_StyleOverrides
Constants.FP_StyleTag
Constants.FP_SubFmtRule
Constants.FP_SubScriptShift
Constants.FP_SubScriptSize
Constants.FP_SubScriptStretch
Constants.FP_SubsecNumComputeMethod
Constants.FP_SubsectionNumStyle
Constants.FP_SubsectionNumText
Constants.FP_SubsectionNumber
Constants.FP_SuffixRules
Constants.FP_SuperScriptShift
Constants.FP_SuperScriptSize
Constants.FP_SuperScriptStretch
Constants.FP_SuppressXMLParserWarnings
Constants.FP_Symbols
Constants.FP_SymbolsList
Constants.FP_SystemVar
Constants.FP_TabStops
Constants.FP_TableTagging
Constants.FP_Tabs
Constants.FP_TailArrow
Constants.FP_TblAlignment
Constants.FP_TblBodyElement
Constants.FP_TblBodyFirstColor
Constants.FP_TblBodyFirstFill
Constants.FP_TblBodyFirstPeriod
Constants.FP_TblBodyNextColor
Constants.FP_TblBodyNextFill
Constants.FP_TblBodyNextPeriod
Constants.FP_TblBodyRowRuling
Constants.FP_TblBodyRowRulingPeriod
Constants.FP_TblBodyShadeBy
Constants.FP_TblBottomRuling
Constants.FP_TblCatalogEntry
Constants.FP_TblCellBottomMargin
Constants.FP_TblCellLeftMargin
Constants.FP_TblCellRightMargin
Constants.FP_TblCellTopMargin
Constants.FP_TblColRuling
Constants.FP_TblColRulingPeriod
Constants.FP_TblColWidths
Constants.FP_TblElement
Constants.FP_TblFnCellPosition
Constants.FP_TblFnCellPrefix
Constants.FP_TblFnCellSuffix
Constants.FP_TblFnCustNumString
Constants.FP_TblFnFmt
Constants.FP_TblFnNumComputeMethod
Constants.FP_TblFnNumStyle
Constants.FP_TblFnPosition
Constants.FP_TblFnPrefix
Constants.FP_TblFnSuffix
Constants.FP_TblFooterElement
Constants.FP_TblHFColor
Constants.FP_TblHFFill
Constants.FP_TblHFRowRuling
Constants.FP_TblHFSeparatorRuling
Constants.FP_TblHeaderElement
Constants.FP_TblInLockedTi
Constants.FP_TblInitNumBodyRows
Constants.FP_TblInitNumCols
Constants.FP_TblInitNumFRows
Constants.FP_TblInitNumHRows
Constants.FP_TblLastBodyRuling
Constants.FP_TblLeftIndent
Constants.FP_TblLeftRuling
Constants.FP_TblNumCols
Constants.FP_TblNumRows
Constants.FP_TblNumbering
Constants.FP_TblOtherBodyRowRuling
Constants.FP_TblOtherColRuling
Constants.FP_TblPlacement
Constants.FP_TblRightIndent
Constants.FP_TblRightRuling
Constants.FP_TblSpaceAbove
Constants.FP_TblSpaceBelow
Constants.FP_TblTag
Constants.FP_TblTitleElement
Constants.FP_TblTitleGap
Constants.FP_TblTitlePosition
Constants.FP_TblTitleSelected
Constants.FP_TblTopRuling
Constants.FP_TblWidth
Constants.FP_TechSuiteInternal
Constants.FP_TechSuiteInternal2
Constants.FP_TemplateDatas
Constants.FP_Text
Constants.FP_TextColor
Constants.FP_TextFmtRules
Constants.FP_TextIsInvalidInElement
Constants.FP_TextLineType
Constants.FP_TextLoc
Constants.FP_TextRange
Constants.FP_TextSelection
Constants.FP_Theta
Constants.FP_TiAutomaticUpdate
Constants.FP_TiByRows
Constants.FP_TiClientData
Constants.FP_TiClientName
Constants.FP_TiClientSource
Constants.FP_TiClientType
Constants.FP_TiClientUpdateSilent
Constants.FP_TiEOLisEOP
Constants.FP_TiFile
Constants.FP_TiFileModDate
Constants.FP_TiFlowName
Constants.FP_TiFlowPageSpace
Constants.FP_TiFormat
Constants.FP_TiHeadersEmpty
Constants.FP_TiIsNested
Constants.FP_TiIsUnresolved
Constants.FP_TiLocked
Constants.FP_TiMacEdition
Constants.FP_TiMainFlow
Constants.FP_TiNumCols
Constants.FP_TiNumHeaderRows
Constants.FP_TiNumSeparators
Constants.FP_TiRemoveOverrides
Constants.FP_TiRemovePageBreaks
Constants.FP_TiSeparator
Constants.FP_TiTblTag
Constants.FP_TiTextEncoding
Constants.FP_TintBaseColor
Constants.FP_TintPercent
Constants.FP_TmpDir
Constants.FP_ToolBar
Constants.FP_ToolTipText
Constants.FP_TopMargin
Constants.FP_TopRowSelection
Constants.FP_TopSepAtIndent
Constants.FP_TopSeparator
Constants.FP_TopicRefAbsoluteFilePath
Constants.FP_TrackChangesAddedColor
Constants.FP_TrackChangesDeletedColor
Constants.FP_TrackChangesOn
Constants.FP_Transient
Constants.FP_TrapwiseCompatibility
Constants.FP_Tsume
Constants.FP_TypeOfDisplayText
Constants.FP_UIColorBackground
Constants.FP_UIColorRuler
Constants.FP_Underlining
Constants.FP_UndoFDKRecording
Constants.FP_Unique
Constants.FP_Untouchable
Constants.FP_UpdatingStructure
Constants.FP_UseAFrameIsCropped
Constants.FP_UseAFrameIsFloating
Constants.FP_UseAlignment
Constants.FP_UseAnchorType
Constants.FP_UseAngle
Constants.FP_UseBaselineOffset
Constants.FP_UseBkColor
Constants.FP_UseBorderWidth
Constants.FP_UseCapitalization
Constants.FP_UseChangeBar
Constants.FP_UseColGapWidth
Constants.FP_UseColor
Constants.FP_UseColumnsAreBalanced
Constants.FP_UseDTheta
Constants.FP_UseFMConsoleForErrorLog
Constants.FP_UseFill
Constants.FP_UseFlowIsAutoConnect
Constants.FP_UseFlowIsPostScript
Constants.FP_UseFontAngle
Constants.FP_UseFontFamily
Constants.FP_UseFontSize
Constants.FP_UseFontVariation
Constants.FP_UseFontWeight
Constants.FP_UseHeight
Constants.FP_UseInitialStructure
Constants.FP_UseInitialStructureOfAutoInsertedElements
Constants.FP_UseInsetDpi
Constants.FP_UseKernX
Constants.FP_UseKernY
Constants.FP_UseLanguage
Constants.FP_UseLocX
Constants.FP_UseLocY
Constants.FP_UseMathMLComposeDpi
Constants.FP_UseMathMLDpi
Constants.FP_UseMathMLFontSize
Constants.FP_UseMathSize
Constants.FP_UseNextTag
Constants.FP_UseNumColumns
Constants.FP_UseOutline
Constants.FP_UseOverline
Constants.FP_UseOverprint
Constants.FP_UsePairKern
Constants.FP_UsePen
Constants.FP_UsePosition
Constants.FP_UseRadius
Constants.FP_UseRunaround
Constants.FP_UseRunaroundGap
Constants.FP_UseSepOverride
Constants.FP_UseShadow
Constants.FP_UseSideHeadGap
Constants.FP_UseSideHeadPlacement
Constants.FP_UseSideHeadWidth
Constants.FP_UseSideOffset
Constants.FP_UseSpread
Constants.FP_UseStretch
Constants.FP_UseStrikethrough
Constants.FP_UseTextLineType
Constants.FP_UseTheta
Constants.FP_UseTintPercent
Constants.FP_UseTsume
Constants.FP_UseUnderlining
Constants.FP_UseWidth
Constants.FP_UserHomeDir
Constants.FP_UserLogin
Constants.FP_UserName
Constants.FP_UserSettingsDir
Constants.FP_UserString
Constants.FP_ValidHighestLevel
Constants.FP_Validating
Constants.FP_ValidationFlags
Constants.FP_VarFmt
Constants.FP_Variables
Constants.FP_VersionMajor
Constants.FP_VersionMinor
Constants.FP_VersionRevision
Constants.FP_VerticalSpreadLarge
Constants.FP_VerticalSpreadMed
Constants.FP_VerticalSpreadSmall
Constants.FP_View
Constants.FP_ViewBorders
Constants.FP_ViewDisplayUnits
Constants.FP_ViewFontSizeUnits
Constants.FP_ViewGrid
Constants.FP_ViewGridUnits
Constants.FP_ViewHotspotIndicators
Constants.FP_ViewLinkBoundaries
Constants.FP_ViewNoGraphics
Constants.FP_ViewOnlyDeadCodes
Constants.FP_ViewOnlyMenuBar
Constants.FP_ViewOnlySelect
Constants.FP_ViewOnlyWinBorders
Constants.FP_ViewOnlyWinMenubar
Constants.FP_ViewOnlyWinPalette
Constants.FP_ViewOnlyWinPopup
Constants.FP_ViewOnlyXRef
Constants.FP_ViewPageScrolling
Constants.FP_ViewRulerUnits
Constants.FP_ViewRulers
Constants.FP_ViewTextSymbols
Constants.FP_Visibility
Constants.FP_VolNumComputeMethod
Constants.FP_VolumeNumStyle
Constants.FP_VolumeNumText
Constants.FP_VolumeNumber
Constants.FP_WesternFamily
Constants.FP_WesternFontPanoseName
Constants.FP_WesternFontPlatformName
Constants.FP_WesternFontPostScriptName
Constants.FP_WesternShift
Constants.FP_WesternSize
Constants.FP_WideRubiSpaceForJapanese
Constants.FP_WideRubiSpaceForOther
Constants.FP_Width
Constants.FP_Window
Constants.FP_WindowHandle
Constants.FP_WindowSystem
Constants.FP_XMLStructuredApplicationList
Constants.FP_XRefAltText
Constants.FP_XRefClientName
Constants.FP_XRefClientType
Constants.FP_XRefFile
Constants.FP_XRefFmt
Constants.FP_XRefIsUnresolved
Constants.FP_XRefResolvedWithKeyref
Constants.FP_XRefRetainKeydefText
Constants.FP_XRefSrcElemNonUniqueId
Constants.FP_XRefSrcIsElem
Constants.FP_XRefSrcText
Constants.FP_XSLTProcessors
Constants.FP_XSLTTransformationScenarioFile
Constants.FP_XmlApplicationForBookComponent
Constants.FP_XmlDocType
Constants.FP_XmlEncoding
Constants.FP_XmlFileEncoding
Constants.FP_XmlIsBook
Constants.FP_XmlLock
Constants.FP_XmlPublicId
Constants.FP_XmlStandAlone
Constants.FP_XmlStyleSheet
Constants.FP_XmlStyleSheetList
Constants.FP_XmlSystemId
Constants.FP_XmlUseBOM
Constants.FP_XmlVersion
Constants.FP_XmlWellFormed
Constants.FP_YakumonoType
Constants.FP_Year
Constants.FP_Yellow
Constants.FP_Zoom
Constants.FR_CancelInsertElementOperation
Constants.FR_CancelOperation
Constants.FR_ClosedXRefDialog
Constants.FR_CommandDisabled
Constants.FR_CommandEnabled
Constants.FR_DialogStayUp
Constants.FR_DisplayedModalDialogForNonContainerElem
Constants.FR_DisplayedModelessDialogForNonContainerElem
Constants.FR_DisplayedTiDialog
Constants.FR_DisplayedXRefDialog
Constants.FR_ECMImportSuccess
Constants.FR_HideDialogOnClose
Constants.FR_KeyCatalogLoaded
Constants.FR_ModalStayUp
Constants.FR_NoOperation
Constants.FR_SkipStep
Constants.FR_USE_EGREP
Constants.FR_USE_GREP
Constants.FR_USE_PERL
Constants.FR_UpdateDITAReferenceFailed
Constants.FR_UpdateDITAReferenceFailedCannotConvertToFMObject
Constants.FR_UpdateDITAReferenceFailedCannotFindReferencedFile
Constants.FR_UpdateDITAReferenceFailedCannotOpenReferencedFile
Constants.FR_UpdateDITAReferenceFailedCannotResolveReference
Constants.FR_UpdateDITAReferenceFailedInvalidElementType
Constants.FR_UpdateDITAReferenceSuccess
Constants.FR_YesOperation
Constants.FS_AlertUserAboutFailure
Constants.FS_AllowInconsistentNumProps
Constants.FS_AllowNonFMFiles
Constants.FS_AllowViewOnlyFiles
Constants.FS_AutoBackupOnSave
Constants.FS_BeefyDoc
Constants.FS_BookIsInUse
Constants.FS_CMSId
Constants.FS_CMSSessionId
Constants.FS_CellSeparator
Constants.FS_ClientUpdateSilent
Constants.FS_DisallowBookDoc
Constants.FS_DisallowBookMIF
Constants.FS_DisallowDoc
Constants.FS_DisallowFilterTypes
Constants.FS_DisallowGraphicTypes
Constants.FS_DisallowMIF
Constants.FS_DisallowMacEditions
Constants.FS_DisallowPlainText
Constants.FS_DisallowSgml
Constants.FS_DisallowXml
Constants.FS_DitaGenerateComponentsAtOneLoc
Constants.FS_DitaGenerateFlatBook
Constants.FS_DitaPostProcessingOnBook
Constants.FS_DitaSavePdfViaBook
Constants.FS_DitavalCondTag
Constants.FS_DitavalFile
Constants.FS_Doctype
Constants.FS_DontNotifyAPIClients
Constants.FS_Export
Constants.FS_ExportFileName
Constants.FS_ExportFileTypeHint
Constants.FS_ExportNativeError
Constants.FS_ExportObjectId
Constants.FS_ExportObjectNeedsDpi
Constants.FS_ExportStatus
Constants.FS_ExportTextRange
Constants.FS_ExportType
Constants.FS_Extension
Constants.FS_FileIsGraphic
Constants.FS_FileIsInUse
Constants.FS_FileIsMakerDoc
Constants.FS_FileIsOldVersion
Constants.FS_FileIsSgmlDoc
Constants.FS_FileIsStructured
Constants.FS_FileIsText
Constants.FS_FileIsXmlDoc
Constants.FS_FileType
Constants.FS_FileTypeHint
Constants.FS_FindCharFmt
Constants.FS_FindCharTag
Constants.FS_FindCondTextInCondTags
Constants.FS_FindCondTextNotInCondTags
Constants.FS_FindCustomizationFlags
Constants.FS_FindElementTag
Constants.FS_FindMarkerOfType
Constants.FS_FindMarkerText
Constants.FS_FindNamedVariable
Constants.FS_FindObject
Constants.FS_FindPgfTag
Constants.FS_FindStyleTag
Constants.FS_FindTableTag
Constants.FS_FindText
Constants.FS_FindWrap
Constants.FS_FindXRefWithFormat
Constants.FS_FitGraphicInSelectedRect
Constants.FS_FontChangedMetric
Constants.FS_FontNotFoundInCatalog
Constants.FS_FontNotFoundInDoc
Constants.FS_ForceImportAsText
Constants.FS_ForceOpenAsText
Constants.FS_FormatImportedText
Constants.FS_GraphicDpi
Constants.FS_HasUnsupportedHotspotShapes
Constants.FS_HowToImport
Constants.FS_ImportAsType
Constants.FS_ImportExportVersion
Constants.FS_ImportFlowPageSpace
Constants.FS_ImportFlowTag
Constants.FS_ImportNativeError
Constants.FS_ImportStatus
Constants.FS_ImportTblTag
Constants.FS_ImportedFileName
Constants.FS_InsetData
Constants.FS_InsetElementDef
Constants.FS_IsErrorDoc
Constants.FS_IterParamGetBookComponentFolder
Constants.FS_IterParamGetBookComponentGroup
Constants.FS_IterParamGetBookComponentRefBook
Constants.FS_IterParamGetBookComponentRefMap
Constants.FS_IterParamGetMapRef
Constants.FS_IterParamParseBookInBook
Constants.FS_IterParamParseMapInBook
Constants.FS_IterParamParseMapInMap
Constants.FS_IterParamSkipExcludedBookComponents
Constants.FS_IterParamSkipNonPrintTopicrefs
Constants.FS_IterParamSkipResourceOnlyTopicrefs
Constants.FS_IterParamSkipTopicsetrefs
Constants.FS_IteratorItemFieldBookId
Constants.FS_IteratorItemFieldDocId
Constants.FS_IteratorItemFieldObjId
Constants.FS_IteratorItemMaxFields
Constants.FS_LanguageNotAvailable
Constants.FS_LeaveHeadingRowsEmpty
Constants.FS_LockCantBeReset
Constants.FS_MakeIconic
Constants.FS_MakePageCount
Constants.FS_MakeVisible
Constants.FS_ManualUpdate
Constants.FS_MathMLNamespacePrefix
Constants.FS_ModDateChanged
Constants.FS_NameStripe
Constants.FS_NewDoc
Constants.FS_NoStructuredErrorLog
Constants.FS_NumCellSeparators
Constants.FS_NumColumns
Constants.FS_NumExportParams
Constants.FS_NumExportReturnParams
Constants.FS_NumImportParams
Constants.FS_NumImportReturnParams
Constants.FS_NumIteratorParams
Constants.FS_NumNewXMLParams
Constants.FS_NumOpenParams
Constants.FS_NumOpenReturnParams
Constants.FS_NumSaveParams
Constants.FS_NumSaveReturnParams
Constants.FS_NumSpellParams
Constants.FS_NumUpdateBookParams
Constants.FS_NumUpdateBookReturnParams
Constants.FS_OpenAsType
Constants.FS_OpenBookViewOnly
Constants.FS_OpenDocFluid
Constants.FS_OpenDocViewOnly
Constants.FS_OpenFileNotWritable
Constants.FS_OpenId
Constants.FS_OpenInNewWindow
Constants.FS_OpenNativeError
Constants.FS_OpenStatus
Constants.FS_OpenedFileName
Constants.FS_OutputFilePathName
Constants.FS_PDFPageNum
Constants.FS_PublicId
Constants.FS_RasterDpi
Constants.FS_RasterImageHeight
Constants.FS_RasterImageWidth
Constants.FS_RefFileNotFound
Constants.FS_RegexFlavour
Constants.FS_RemoveManualPageBreaks
Constants.FS_RemoveOverrides
Constants.FS_RetainNameStripe
Constants.FS_SaveAsModeName
Constants.FS_SaveFileNotWritable
Constants.FS_SaveFileTypeHint
Constants.FS_SaveMode
Constants.FS_SaveNativeError
Constants.FS_SaveStatus
Constants.FS_SaveTextExtraBlankLineAtEOP
Constants.FS_SaveTextTblSetting
Constants.FS_SavedFileName
Constants.FS_SgmlBookFileName
Constants.FS_ShowBookErrorLog
Constants.FS_ShowBrowser
Constants.FS_ShowRasterDpiDialog
Constants.FS_ShowSaveTextDialog
Constants.FS_SilentlyDisallowXML
Constants.FS_SpellAction
Constants.FS_SpellOptions
Constants.FS_SpellWrap
Constants.FS_StructuredApplication
Constants.FS_StructuredExportApplication
Constants.FS_StructuredImportApplication
Constants.FS_StructuredOpenApplication
Constants.FS_StructuredSaveApplication
Constants.FS_SystemId
Constants.FS_TblNumHeadingRows
Constants.FS_TemplateShouldInsertRoot
Constants.FS_TextAfterString
Constants.FS_TextBeforeString
Constants.FS_TextInsetName
Constants.FS_TreatParaAsRow
Constants.FS_TwoInARowString
Constants.FS_UNIXpermissions
Constants.FS_UpdateBookGeneratedFiles
Constants.FS_UpdateBookMasterPages
Constants.FS_UpdateBookNumbering
Constants.FS_UpdateBookOleLinks
Constants.FS_UpdateBookStatus
Constants.FS_UpdateBookTextReferences
Constants.FS_UpdateBookXRefs
Constants.FS_UpdateBrowserDirectory
Constants.FS_UpdateFRVList
Constants.FS_UpdateTemplateData
Constants.FS_UpdateTextReferences
Constants.FS_UpdateXRefs
Constants.FS_UseAutoSaveFile
Constants.FS_UseDefaultUNIXpermissions
Constants.FS_UseHTTP
Constants.FS_UseMainFlow
Constants.FS_UseRecoverFile
Constants.FS_VerifyInsets
Constants.FS_Visible
Constants.FS_WordContainString
Constants.FTF_ALL
Constants.FTF_ANGLE
Constants.FTF_CAPITALIZATION
Constants.FTF_CHANGEBAR
Constants.FTF_CHARTAG
Constants.FTF_COLOR
Constants.FTF_CONDITIONTAG
Constants.FTF_ENCODING
Constants.FTF_FAMILY
Constants.FTF_IIF
Constants.FTF_KERNX
Constants.FTF_KERNY
Constants.FTF_LANGUAGE
Constants.FTF_OUTLINE
Constants.FTF_OVERLINE
Constants.FTF_PAIRKERN
Constants.FTF_POSITION
Constants.FTF_SHADOW
Constants.FTF_SIZE
Constants.FTF_SPREAD
Constants.FTF_STRETCH
Constants.FTF_STRIKETHROUGH
Constants.FTF_TSUME
Constants.FTF_UNDERLINING
Constants.FTF_VARIATION
Constants.FTF_WEIGHT
Constants.FTI2_RubiCompositeBegin
Constants.FTI2_RubiCompositeEnd
Constants.FTI2_RubiTextBegin
Constants.FTI2_RubiTextEnd
Constants.FTI_CharPropsChange
Constants.FTI_ElemPrefixBegin
Constants.FTI_ElemPrefixEnd
Constants.FTI_ElemSuffixBegin
Constants.FTI_ElemSuffixEnd
Constants.FTI_ElementBegin
Constants.FTI_ElementEnd
Constants.FTI_FlowBegin
Constants.FTI_FlowEnd
Constants.FTI_FnAnchor
Constants.FTI_FrameAnchor
Constants.FTI_HardLineEnd
Constants.FTI_HyphenLineEnd
Constants.FTI_LineBegin
Constants.FTI_LineEnd
Constants.FTI_MarkerAnchor
Constants.FTI_PageBegin
Constants.FTI_PageEnd
Constants.FTI_PgfBegin
Constants.FTI_PgfEnd
Constants.FTI_String
Constants.FTI_SubColBegin
Constants.FTI_SubColEnd
Constants.FTI_TblAnchor
Constants.FTI_TextFrameBegin
Constants.FTI_TextFrameEnd
Constants.FTI_TextInsetBegin
Constants.FTI_TextInsetEnd
Constants.FTI_TextObjId
Constants.FTI_VarBegin
Constants.FTI_VarEnd
Constants.FTI_XRefBegin
Constants.FTI_XRefEnd
Constants.FT_AttributeDefs
Constants.FT_Attributes
Constants.FT_AttributesEx
Constants.FT_Bad
Constants.FT_ElementCatalog
Constants.FT_ElementRange
Constants.FT_FormatBranches
Constants.FT_Id
Constants.FT_Integer
Constants.FT_Ints
Constants.FT_Metric
Constants.FT_Metrics
Constants.FT_Num
Constants.FT_Points
Constants.FT_String
Constants.FT_Strings
Constants.FT_Tabs
Constants.FT_TemplateDatas
Constants.FT_TextLoc
Constants.FT_TextRange
Constants.FT_UBytes
Constants.FT_UInts
Constants.FT_Vals
Constants.FV_ACCESSBAR_CLOSE
Constants.FV_ACCESSBAR_OPEN
Constants.FV_AF_FIXED
Constants.FV_AF_HIDDEN
Constants.FV_AF_READ_ONLY
Constants.FV_ALIGN_CENTER
Constants.FV_ALIGN_INSIDE
Constants.FV_ALIGN_LEFT
Constants.FV_ALIGN_OUTSIDE
Constants.FV_ALIGN_RIGHT
Constants.FV_ALIGN_TBL_CENTER
Constants.FV_ALIGN_TBL_LEFT
Constants.FV_ALIGN_TBL_RIGHT
Constants.FV_ALTERNATIVE
Constants.FV_ANCHOR_BELOW
Constants.FV_ANCHOR_BOTTOM
Constants.FV_ANCHOR_INLINE
Constants.FV_ANCHOR_RUN_INTO_PARAGRAPH
Constants.FV_ANCHOR_SUBCOL_FARTHEST
Constants.FV_ANCHOR_SUBCOL_INSIDE
Constants.FV_ANCHOR_SUBCOL_LEFT
Constants.FV_ANCHOR_SUBCOL_NEAREST
Constants.FV_ANCHOR_SUBCOL_OUTSIDE
Constants.FV_ANCHOR_SUBCOL_RIGHT
Constants.FV_ANCHOR_TEXTFRAME_FARTHEST
Constants.FV_ANCHOR_TEXTFRAME_INSIDE
Constants.FV_ANCHOR_TEXTFRAME_LEFT
Constants.FV_ANCHOR_TEXTFRAME_NEAREST
Constants.FV_ANCHOR_TEXTFRAME_OUTSIDE
Constants.FV_ANCHOR_TEXTFRAME_RIGHT
Constants.FV_ANCHOR_TOP
Constants.FV_ANSI
Constants.FV_ARROW_FILLED
Constants.FV_ARROW_HOLLOW
Constants.FV_ARROW_STICK
Constants.FV_ASCII
Constants.FV_ATTR_DISP_ALL
Constants.FV_ATTR_DISP_NONE
Constants.FV_ATTR_DISP_REQSPEC
Constants.FV_ATTR_EDIT_ALWAYS
Constants.FV_ATTR_EDIT_NONE
Constants.FV_ATTR_EDIT_REQUIRED
Constants.FV_AT_CHOICES
Constants.FV_AT_INTEGER
Constants.FV_AT_INTEGERS
Constants.FV_AT_NUMTYPES
Constants.FV_AT_REAL
Constants.FV_AT_REALS
Constants.FV_AT_STRING
Constants.FV_AT_STRINGS
Constants.FV_AT_UNIQUE_ID
Constants.FV_AT_UNIQUE_IDREF
Constants.FV_AT_UNIQUE_IDREFS
Constants.FV_AUTORECOGNIZE
Constants.FV_AV_IDREF_UNRESOLVED
Constants.FV_AV_ID_DUPLICATE_IN_BOOK
Constants.FV_AV_ID_DUPLICATE_IN_DOC
Constants.FV_AV_INVALID_CHOICE
Constants.FV_AV_INVALID_FORMAT
Constants.FV_AV_OUT_OF_RANGE
Constants.FV_AV_REQUIRED
Constants.FV_AV_TOO_MANY_TOKENS
Constants.FV_AV_UNDEFINED
Constants.FV_Above
Constants.FV_AlertOneButton
Constants.FV_AlertThreeButton
Constants.FV_AlertTwoButton
Constants.FV_AllElements
Constants.FV_AllowAllRefFilesUnFindable
Constants.FV_ApiClientCanceledExport
Constants.FV_AutoSaveFileUsed
Constants.FV_BGD_DEFAULT
Constants.FV_BGD_NONE
Constants.FV_BGD_OTHER
Constants.FV_BIG5
Constants.FV_BK_BOOK
Constants.FV_BK_BOOKMAP
Constants.FV_BK_DITAMAP
Constants.FV_BK_FILE
Constants.FV_BK_FILENAME
Constants.FV_BK_FM
Constants.FV_BK_FOLDER
Constants.FV_BK_GENERAL
Constants.FV_BK_GROUP
Constants.FV_BK_INDEX_AUTHOR
Constants.FV_BK_INDEX_FORMATS
Constants.FV_BK_INDEX_MARKER
Constants.FV_BK_INDEX_REFERENCES
Constants.FV_BK_INDEX_STAN
Constants.FV_BK_INDEX_SUBJECT
Constants.FV_BK_LIST_FIGURE
Constants.FV_BK_LIST_FORMATS
Constants.FV_BK_LIST_MARKER
Constants.FV_BK_LIST_MARKER_ALPHA
Constants.FV_BK_LIST_PGF
Constants.FV_BK_LIST_PGF_ALPHA
Constants.FV_BK_LIST_REFERENCES
Constants.FV_BK_LIST_TABLE
Constants.FV_BK_MIF
Constants.FV_BK_NOT_GENERATABLE
Constants.FV_BK_NUM_BOOK_LIST
Constants.FV_BK_START_FROM_FILE
Constants.FV_BK_START_LEFT
Constants.FV_BK_START_NEXT_AVAILABLE
Constants.FV_BK_START_RIGHT
Constants.FV_BK_TEXT
Constants.FV_BK_TOC
Constants.FV_BK_XML
Constants.FV_BODY_PAGE
Constants.FV_BadEnclosingDocId
Constants.FV_BadExportDocId
Constants.FV_BadExportFileName
Constants.FV_BadExportObjectId
Constants.FV_BadExportScriptValue
Constants.FV_BadFileId
Constants.FV_BadFileName
Constants.FV_BadFileRefsWereMapped
Constants.FV_BadFileType
Constants.FV_BadImportFileName
Constants.FV_BadImportFileType
Constants.FV_BadImportScriptValue
Constants.FV_BadSaveFileName
Constants.FV_BadSaveObjectId
Constants.FV_BadSaveScriptValue
Constants.FV_BadScriptValue
Constants.FV_BadTemplate
Constants.FV_BadTextFileTypeHint
Constants.FV_BadUpdateBookFileId
Constants.FV_BadUpdateBookScriptValue
Constants.FV_BeefyDoc
Constants.FV_Below
Constants.FV_Body
Constants.FV_BodyPage
Constants.FV_BookNotSelfConsistent
Constants.FV_BrowseCmsOnly
Constants.FV_BrowseLocalOnly
Constants.FV_BrowseLocalWithWebdavOnly
Constants.FV_CAPITAL_CASE_LOWER
Constants.FV_CAPITAL_CASE_NORM
Constants.FV_CAPITAL_CASE_SMALL
Constants.FV_CAPITAL_CASE_UPPER
Constants.FV_CAP_BUTT
Constants.FV_CAP_ROUND
Constants.FV_CAP_SQUARE
Constants.FV_CB_COL_FURTHEST
Constants.FV_CB_COL_LEFT
Constants.FV_CB_COL_NEAREST
Constants.FV_CB_COL_RIGHT
Constants.FV_CB_DOUBLE_UNDERLINE
Constants.FV_CB_NO_UNDERLINE
Constants.FV_CB_NUMERIC_UNDERLINE
Constants.FV_CB_SINGLE_UNDERLINE
Constants.FV_CHAR_CATALOG
Constants.FV_CMSCheckinUI_Id_CheckinComment
Constants.FV_CMSCheckinUI_Id_Description
Constants.FV_CMSCheckinUI_Id_MajorVersion
Constants.FV_CMSCheckinUI_Id_MakeThisCurrentVersion
Constants.FV_CMSCheckinUI_Id_MinorVersion
Constants.FV_CMSCheckinUI_Id_SameVersion
Constants.FV_CMSCheckinUI_Id_VersionLabel
Constants.FV_CMSCheckoutUI_Id_ShowDependents
Constants.FV_CMSCommandAdvancedSearchStringId
Constants.FV_CMSCommandCheckinCommentId
Constants.FV_CMSCommandCheckinDescriptionId
Constants.FV_CMSCommandCheckinKeepLocalCopyId
Constants.FV_CMSCommandCheckinMakeCurrentVersionId
Constants.FV_CMSCommandCheckinMinorVersionId
Constants.FV_CMSCommandCheckinVersionLabelId
Constants.FV_CMSCommandCheckoutWithDescendentId
Constants.FV_CMSCommandConnTypeId
Constants.FV_CMSCommandDeleteAllDependentsId
Constants.FV_CMSCommandDeleteAllVersionId
Constants.FV_CMSCommandFilePathId
Constants.FV_CMSCommandId
Constants.FV_CMSCommandId_Max
Constants.FV_CMSCommandId_Min
Constants.FV_CMSCommandNameId
Constants.FV_CMSCommandOpenReadOnlyId
Constants.FV_CMSCommandPasswordId
Constants.FV_CMSCommandRepositoryId
Constants.FV_CMSCommandSearchStringId
Constants.FV_CMSCommandServerId
Constants.FV_CMSCommandSilentOpenId
Constants.FV_CMSCommandUserField1
Constants.FV_CMSCommandUserField2
Constants.FV_CMSCommandUserNameId
Constants.FV_CMSContextMenuId
Constants.FV_CMSContextMenuString
Constants.FV_CMSDeleteUI_DeleteAllDependents
Constants.FV_CMSDeleteUI_DeleteAllVersion
Constants.FV_CMSItemFileTypeValue_DitaMap
Constants.FV_CMSItemFileTypeValue_DitaTopic
Constants.FV_CMSItemFileTypeValue_FmBook
Constants.FV_CMSItemFileTypeValue_FmDoc
Constants.FV_CMSItemFileTypeValue_General
Constants.FV_CMSItemFileTypeValue_Img
Constants.FV_CMSItemFileTypeValue_Max
Constants.FV_CMSItemFileTypeValue_Mif
Constants.FV_CMSItemFileTypeValue_Min
Constants.FV_CMSItemFileTypeValue_Text
Constants.FV_CMSItemFileTypeValue_Xml
Constants.FV_CMSItemTypeValue_File
Constants.FV_CMSItemTypeValue_Folder
Constants.FV_CMSItemTypeValue_General
Constants.FV_CMSItemTypeValue_Max
Constants.FV_CMSItemTypeValue_Min
Constants.FV_CMSItemTypeValue_Root
Constants.FV_CMSMajorVersion
Constants.FV_CMSMenu_Is_Disabled
Constants.FV_CMSMenu_Is_Item
Constants.FV_CMSMenu_Is_Separator
Constants.FV_CMSMenu_Is_SubMenu
Constants.FV_CMSMenu_Max
Constants.FV_CMSMenu_Min
Constants.FV_CMSMinorVersion
Constants.FV_CMSOpChildAdded
Constants.FV_CMSOpDependentsDeleted
Constants.FV_CMSOpDependentsUpdated
Constants.FV_CMSOpItemDeleted
Constants.FV_CMSOpItemUpdated
Constants.FV_CMSOpNone
Constants.FV_CMSOpRootUpdated
Constants.FV_CMSSameVersion
Constants.FV_CMSSilentOperation
Constants.FV_CMSVersion_Max
Constants.FV_CMSVersion_Min
Constants.FV_CN_CHANGEBAR
Constants.FV_CN_DOUBLE_UNDERLINE
Constants.FV_CN_NMRIC_AND_CHNGBAR
Constants.FV_CN_NO_OVERRIDE
Constants.FV_CN_NUMERIC_UNDERLINE
Constants.FV_CN_OVERLINE
Constants.FV_CN_SINGLE_UNDERLINE
Constants.FV_CN_STRIKETHROUGH
Constants.FV_COLOR_BLACK
Constants.FV_COLOR_BLUE
Constants.FV_COLOR_CYAN
Constants.FV_COLOR_DARKGREY
Constants.FV_COLOR_DARKYELLOW
Constants.FV_COLOR_FORESTGREEN
Constants.FV_COLOR_GREEN
Constants.FV_COLOR_KNOCKOUT
Constants.FV_COLOR_LIGHTSALMON
Constants.FV_COLOR_MAGENTA
Constants.FV_COLOR_MAUVE
Constants.FV_COLOR_NOT_RESERVED
Constants.FV_COLOR_OVERPRINT
Constants.FV_COLOR_PALEGREEN
Constants.FV_COLOR_RED
Constants.FV_COLOR_ROYALBLUE
Constants.FV_COLOR_SALMON
Constants.FV_COLOR_WHITE
Constants.FV_COLOR_YELLOW
Constants.FV_CONTEXT_RULE
Constants.FV_CS_CHANGEBAR
Constants.FV_CS_DOUBLE_UNDERLINE
Constants.FV_CS_NO_OVERRIDE
Constants.FV_CS_NUMERIC_UNDERLINE
Constants.FV_CS_OVERLINE
Constants.FV_CS_SINGLE_UNDERLINE
Constants.FV_CS_STRIKETHROUGH
Constants.FV_CancelBeefyDoc
Constants.FV_CancelBook
Constants.FV_CancelBookMIF
Constants.FV_CancelFileBrowser
Constants.FV_CancelFileDoc
Constants.FV_CancelFileFilterable
Constants.FV_CancelFileGraphic
Constants.FV_CancelFileHasStructure
Constants.FV_CancelFileIsDoc
Constants.FV_CancelFileIsFilterable
Constants.FV_CancelFileIsInUse
Constants.FV_CancelFileIsMIF
Constants.FV_CancelFileIsMacEdition
Constants.FV_CancelFileIsOldVersion
Constants.FV_CancelFileIsSgml
Constants.FV_CancelFileIsText
Constants.FV_CancelFileIsXml
Constants.FV_CancelFileMIF
Constants.FV_CancelFileSgml
Constants.FV_CancelFileText
Constants.FV_CancelFileXml
Constants.FV_CancelFontMetricsChanged
Constants.FV_CancelFontsMapped
Constants.FV_CancelFontsMappedInCatalog
Constants.FV_CancelFontsWithUnavailableEncodings
Constants.FV_CancelImportBrowser
Constants.FV_CancelInconsistentNumPropsInFileInBook
Constants.FV_CancelLanguagesNotFound
Constants.FV_CancelNonFMFileInBook
Constants.FV_CancelOpenFileNotWritable
Constants.FV_CancelReferencedFilesNotFound
Constants.FV_CancelSaveExportedFileInvalid
Constants.FV_CancelSaveFileIsInUse
Constants.FV_CancelSaveFileNotWritable
Constants.FV_CancelSaveModDateChanged
Constants.FV_CancelTempDiskFull
Constants.FV_CancelUseAutoSaveFile
Constants.FV_CancelUseRecoverFile
Constants.FV_CancelViewOnlyFileInBook
Constants.FV_CancelWrongProduct
Constants.FV_CancelWrongView
Constants.FV_CanceledExportObjectNeedsDpi
Constants.FV_CantForceImportAsText
Constants.FV_CantForceOpenAsText
Constants.FV_CantNewBooks
Constants.FV_CantOpenBooksFluid
Constants.FV_CantOpenBooksViewOnly
Constants.FV_ChangePersonalDictionary
Constants.FV_CheckCurrentPage
Constants.FV_CheckDocument
Constants.FV_ChecksumDamage
Constants.FV_ChooseMultiOpen
Constants.FV_ChooseMultiSelect
Constants.FV_ChooseOpen
Constants.FV_ChooseOpenDir
Constants.FV_ChooseSave
Constants.FV_ChooseSelect
Constants.FV_ClearDocDictionary
Constants.FV_CmdAlert
Constants.FV_CmdAlertTitle
Constants.FV_CmdApplyMathRules
Constants.FV_CmdBeginRange
Constants.FV_CmdEndRange
Constants.FV_CmdError
Constants.FV_CmdExit
Constants.FV_CmdFCodes
Constants.FV_CmdGoToLink
Constants.FV_CmdGoToLinkFitWin
Constants.FV_CmdGoToNew
Constants.FV_CmdGoToObjectId
Constants.FV_CmdGoToObjectIdFitWin
Constants.FV_CmdGoToPage
Constants.FV_CmdHelpLink
Constants.FV_CmdInCodes
Constants.FV_CmdMatrix
Constants.FV_CmdMessage
Constants.FV_CmdMultiMedia
Constants.FV_CmdNative
Constants.FV_CmdNewLink
Constants.FV_CmdNextPage
Constants.FV_CmdNoop
Constants.FV_CmdNotTyped
Constants.FV_CmdOpenLink
Constants.FV_CmdOpenLinkFitWin
Constants.FV_CmdOpenNew
Constants.FV_CmdOpenObjectId
Constants.FV_CmdOpenObjectIdFitWin
Constants.FV_CmdOpenPage
Constants.FV_CmdOpenXmlElementId
Constants.FV_CmdOutCodes
Constants.FV_CmdPopup
Constants.FV_CmdPreviousLink
Constants.FV_CmdPreviousLinkFitWin
Constants.FV_CmdPreviousPage
Constants.FV_CmdQuit
Constants.FV_CmdQuitAll
Constants.FV_CmdThesaurusLookup
Constants.FV_CmdUnknown
Constants.FV_DIALOG_DOCK_ALL
Constants.FV_DIALOG_DOCK_BOTTOM
Constants.FV_DIALOG_DOCK_LEFT
Constants.FV_DIALOG_DOCK_NONE
Constants.FV_DIALOG_DOCK_RIGHT
Constants.FV_DIALOG_DOCK_TOP
Constants.FV_DIALOG_GROUP_ALL
Constants.FV_DIALOG_GROUP_ALLPANELS
Constants.FV_DIALOG_GROUP_ATTRIBUTES
Constants.FV_DIALOG_GROUP_CATALOGS
Constants.FV_DIALOG_GROUP_DESIGNERS
Constants.FV_DIALOG_GROUP_EDIT
Constants.FV_DIALOG_GROUP_NONE
Constants.FV_DIALOG_GROUP_PODS
Constants.FV_DIALOG_GROUP_PODSRIGHT
Constants.FV_DIALOG_GROUP_RMKITS
Constants.FV_DIALOG_GROUP_SPECIAL
Constants.FV_DIALOG_RESIZEGRIPPERPOS_BELOW
Constants.FV_DIALOG_RESIZEGRIPPERPOS_FRONT
Constants.FV_DIALOG_RESIZEGRIPPERPOS_NONE
Constants.FV_DITAObjTypeAuto
Constants.FV_DITAObjTypeConref
Constants.FV_DITAObjTypeLink
Constants.FV_DITAObjTypeMax
Constants.FV_DITAObjTypeTopicref
Constants.FV_DITAObjTypeTopicsetref
Constants.FV_DITAObjTypeXref
Constants.FV_DITA_TYPE_ANCHOR
Constants.FV_DITA_TYPE_GENERAL
Constants.FV_DITA_TYPE_KEYDEF
Constants.FV_DITA_TYPE_MAPREF
Constants.FV_DITA_TYPE_NAVREF
Constants.FV_DITA_TYPE_RELTABLE
Constants.FV_DITA_TYPE_TITLE
Constants.FV_DITA_TYPE_TOPICGROUP
Constants.FV_DITA_TYPE_TOPICHEAD
Constants.FV_DITA_TYPE_TOPICREF
Constants.FV_DITA_TYPE_TOPICSET
Constants.FV_DITA_TYPE_TOPICSETREF
Constants.FV_DOC_ISNOT_DITAMAP
Constants.FV_DOC_TYPE_BINARY
Constants.FV_DOC_TYPE_FILTER
Constants.FV_DOC_TYPE_MIF
Constants.FV_DOC_TYPE_TEXT
Constants.FV_DT_FLOAT
Constants.FV_DT_INTEGER
Constants.FV_DT_NUMTYPES
Constants.FV_DT_UNSPECIFIED
Constants.FV_DeleteEmptyPages
Constants.FV_DestFirstPage
Constants.FV_DestFluidFlow
Constants.FV_DestLastPage
Constants.FV_DestMarker
Constants.FV_DestMarkerNewLink
Constants.FV_DestNowhere
Constants.FV_DestObjectId
Constants.FV_DestPageNum
Constants.FV_DestXRef
Constants.FV_DisallowedImportType
Constants.FV_DisallowedType
Constants.FV_DlgClose
Constants.FV_DlgEnter
Constants.FV_DlgHide
Constants.FV_DlgInit
Constants.FV_DlgNeedsUpdate
Constants.FV_DlgNextPage
Constants.FV_DlgNoChange
Constants.FV_DlgOptActive
Constants.FV_DlgOptDontCare
Constants.FV_DlgOptNotActive
Constants.FV_DlgPrefCommit
Constants.FV_DlgPrefSetInitialState
Constants.FV_DlgPrefVerify
Constants.FV_DlgPrevPage
Constants.FV_DlgReset
Constants.FV_DlgResize
Constants.FV_DlgShow
Constants.FV_DlgUndo
Constants.FV_DoByCopy
Constants.FV_DoByRef
Constants.FV_DoCancel
Constants.FV_DoImportAsTable
Constants.FV_DoNo
Constants.FV_DoOK
Constants.FV_DoShowDialog
Constants.FV_DoUserChoice
Constants.FV_DoUserPreference
Constants.FV_DoYes
Constants.FV_DocDamagedByTextFilter
Constants.FV_DocHeadersDamaged
Constants.FV_DocKeyCatalogTypeDefault
Constants.FV_DocKeyCatalogTypeMax
Constants.FV_DocKeyCatalogTypeNone
Constants.FV_DocKeyCatalogTypeSpecified
Constants.FV_DocWrongSize
Constants.FV_DocumentDictionary
Constants.FV_DontChangePageCount
Constants.FV_DuplicateFileInBook
Constants.FV_EDT_AFTER
Constants.FV_EDT_ALL
Constants.FV_EDT_ANY
Constants.FV_EDT_ATTRGRPO
Constants.FV_EDT_BEFORE
Constants.FV_EDT_BETWEEN
Constants.FV_EDT_ELEMENT
Constants.FV_EDT_FIRST
Constants.FV_EDT_INSERTPAR
Constants.FV_EDT_LAST
Constants.FV_EDT_MIDDLE
Constants.FV_EDT_NOTFIRST
Constants.FV_EDT_NOTLAST
Constants.FV_EDT_ONLY
Constants.FV_EDT_TEXT
Constants.FV_EDT_TEXTONLY
Constants.FV_ELCAT_ALL
Constants.FV_ELCAT_CHILDREN
Constants.FV_ELCAT_CUSTOM
Constants.FV_ELCAT_LOOSE
Constants.FV_ELCAT_STRICT
Constants.FV_ELEMENT_CATALOG
Constants.FV_ELEM_ATTRVAL_INVALID
Constants.FV_ELEM_ATTRVAL_REQUIRED
Constants.FV_ELEM_BOOK_COMP_INVALID
Constants.FV_ELEM_BOOK_COMP_MISSING
Constants.FV_ELEM_CONTENT_LOOSELY_VALID
Constants.FV_ELEM_CONTENT_MUST_BE_EMPTY
Constants.FV_ELEM_CONTENT_STRICTLY_VALID
Constants.FV_ELEM_DISP_BRACKETS
Constants.FV_ELEM_DISP_NONE
Constants.FV_ELEM_DISP_TAGS
Constants.FV_ELEM_EXCLUDED
Constants.FV_ELEM_HAS_TEXT_INVALID
Constants.FV_ELEM_INVALID_AT_POSITION
Constants.FV_ELEM_INVALID_IN_PARENT
Constants.FV_ELEM_INVISIBLE_ATTRVAL_INVALID
Constants.FV_ELEM_INVISIBLE_ATTRVAL_REQUIRED
Constants.FV_ELEM_MISSING_CONTENT_AT_BEG
Constants.FV_ELEM_MISSING_CONTENT_AT_END
Constants.FV_ELEM_MISSING_CONTENT_BEFORE
Constants.FV_ELEM_NOT_VALID_AS_ROOT
Constants.FV_ELEM_TYPE_MISMATCH
Constants.FV_ELEM_UNDEFINED
Constants.FV_EMUL_DOWN
Constants.FV_EMUL_UP
Constants.FV_ENABLE_ALWAYS_DISABLE
Constants.FV_ENABLE_ALWAYS_ENABLE
Constants.FV_ENABLE_BOOK_HAS_SELECTION
Constants.FV_ENABLE_CAN_PASTE
Constants.FV_ENABLE_COPY
Constants.FV_ENABLE_COPY_FONT
Constants.FV_ENABLE_DOC_OR_BOOK_HAS_SELECTION
Constants.FV_ENABLE_IN_CELL_TEXT
Constants.FV_ENABLE_IN_FLOW
Constants.FV_ENABLE_IN_MATH
Constants.FV_ENABLE_IN_PARA_TEXT
Constants.FV_ENABLE_IN_TABLE
Constants.FV_ENABLE_IN_TABLE_TITLE
Constants.FV_ENABLE_IN_TEXT
Constants.FV_ENABLE_IN_TEXT_LINE
Constants.FV_ENABLE_IS_AFRAME
Constants.FV_ENABLE_IS_CELL
Constants.FV_ENABLE_IS_CELLS
Constants.FV_ENABLE_IS_GRAPHIC_INSET
Constants.FV_ENABLE_IS_OBJ
Constants.FV_ENABLE_IS_OR_IN_FRAME
Constants.FV_ENABLE_IS_TABLE
Constants.FV_ENABLE_IS_TEXT_FRAME
Constants.FV_ENABLE_IS_TEXT_INSET
Constants.FV_ENABLE_IS_TEXT_SEL
Constants.FV_ENABLE_IS_VIEW_ONLY
Constants.FV_ENABLE_NEEDS_BOOKP_ONLY
Constants.FV_ENABLE_NEEDS_DOCP_ONLY
Constants.FV_ENABLE_NEEDS_DOCP_OR_BOOKP
Constants.FV_ENABLE_OBJ_PROPS
Constants.FV_ENUMERATE_BOOKCOMP_FOLDER
Constants.FV_ENUMERATE_BOOKCOMP_GROUP
Constants.FV_ENUMERATE_COMPFILE_BOOKBINARY
Constants.FV_ENUMERATE_COMPFILE_BOOKMIF
Constants.FV_ENUMERATE_COMPFILE_FMBINARY
Constants.FV_ENUMERATE_COMPFILE_FMMIF
Constants.FV_ENUMERATE_COMPFILE_XML
Constants.FV_ENUMERATE_COMP_CHILDBOOK_COMPONENTS
Constants.FV_ENUMERATE_COMP_CHILDMAP_COMPONENTS
Constants.FV_ENUMERATE_COMP_FOLDER_COMPONENTS
Constants.FV_ENUMERATE_COMP_GROUP_COMPONENTS
Constants.FV_ENUMERATE_DITACOMP_KEYDEF
Constants.FV_ENUMERATE_DITACOMP_MAPREF
Constants.FV_ENUMERATE_DITACOMP_TOPICREF
Constants.FV_ENUMERATE_DITACOMP_TOPICSET
Constants.FV_ENUMERATE_DITACOMP_TOPICSETREF
Constants.FV_EUC
Constants.FV_EUC_CNS
Constants.FV_EditableCopyOpened
Constants.FV_Element
Constants.FV_ElementsOfType
Constants.FV_EnclosingDoc
Constants.FV_EvCaps
Constants.FV_EvCommand
Constants.FV_EvControl
Constants.FV_EvMax
Constants.FV_EvMeta
Constants.FV_EvOption
Constants.FV_EvShift
Constants.FV_ExportDocument
Constants.FV_ExportFileHasNewName
Constants.FV_ExportFileNotWritable
Constants.FV_ExportObject
Constants.FV_ExportProductIsViewer
Constants.FV_FAMILY_MAPPED
Constants.FV_FAMILY_SELECTABLE
Constants.FV_FAMILY_SURROGATE
Constants.FV_FAMILY_VISIBLE
Constants.FV_FILL_BLACK
Constants.FV_FILL_CLEAR
Constants.FV_FILL_WHITE
Constants.FV_FIT_WINDOW_TO_PAGE
Constants.FV_FIXED_YAKUMONO
Constants.FV_FLOATING_YAKUMONO
Constants.FV_FN_NUM_ALPHA_LC
Constants.FV_FN_NUM_ALPHA_UC
Constants.FV_FN_NUM_CHINESE_NUMERIC
Constants.FV_FN_NUM_CUSTOM
Constants.FV_FN_NUM_DAIJI
Constants.FV_FN_NUM_FULL_WIDTH
Constants.FV_FN_NUM_FULL_WIDTH_LC
Constants.FV_FN_NUM_FULL_WIDTH_UC
Constants.FV_FN_NUM_KANJI
Constants.FV_FN_NUM_KANJI_KAZU
Constants.FV_FN_NUM_NUMERIC
Constants.FV_FN_NUM_ROMAN_LC
Constants.FV_FN_NUM_ROMAN_UC
Constants.FV_FN_NUM_ZENKAKU
Constants.FV_FN_NUM_ZENKAKU_LC
Constants.FV_FN_NUM_ZENKAKU_UC
Constants.FV_FN_POS_BASELINE
Constants.FV_FN_POS_SUB
Constants.FV_FN_POS_SUPER
Constants.FV_FORMATBAR_CLOSE
Constants.FV_FORMATBAR_OPEN
Constants.FV_FO_CONTAINER
Constants.FV_FO_EQN
Constants.FV_FO_FOOTNOTE
Constants.FV_FO_GRAPHIC
Constants.FV_FO_MARKER
Constants.FV_FO_MMLEQN
Constants.FV_FO_NUMTYPES
Constants.FV_FO_RUBI
Constants.FV_FO_RUBI_GROUP
Constants.FV_FO_SYS_VAR
Constants.FV_FO_TBL
Constants.FV_FO_TBL_BODY
Constants.FV_FO_TBL_CELL
Constants.FV_FO_TBL_FOOTING
Constants.FV_FO_TBL_HEADING
Constants.FV_FO_TBL_ROW
Constants.FV_FO_TBL_TITLE
Constants.FV_FO_TEXTNODE
Constants.FV_FO_UNSPECIFIED
Constants.FV_FO_XREF
Constants.FV_FROMCOLOR
Constants.FV_FileAlreadyOpen
Constants.FV_FileAlreadyOpenThisSession
Constants.FV_FileHadStructure
Constants.FV_FileHasNewName
Constants.FV_FileInBookNotOpened
Constants.FV_FileInBookNotSaved
Constants.FV_FileIsNotWritable
Constants.FV_FileIsOldVersion
Constants.FV_FileIsText
Constants.FV_FileIsViewOnly
Constants.FV_FileModDateChanged
Constants.FV_FileNotReadable
Constants.FV_FileNotWritable
Constants.FV_FileStructureStripped
Constants.FV_FileTypeBinaryBook
Constants.FV_FileTypeBinaryDoc
Constants.FV_FileTypeCompositeDoc
Constants.FV_FileTypeEquation
Constants.FV_FileTypeErrorDoc
Constants.FV_FileTypeFilter
Constants.FV_FileTypeFolder
Constants.FV_FileTypeGeneral
Constants.FV_FileTypeMif
Constants.FV_FileTypeSgml
Constants.FV_FileTypeSummaryDoc
Constants.FV_FileTypeText
Constants.FV_FileTypeThesaurus
Constants.FV_FileTypeXml
Constants.FV_FileWasExported
Constants.FV_FileWasFiltered
Constants.FV_FileWasInUse
Constants.FV_FilterFailed
Constants.FV_FindAnchoredFrame
Constants.FV_FindAnyMarker
Constants.FV_FindAnyPub
Constants.FV_FindAnyRubi
Constants.FV_FindAnyTable
Constants.FV_FindAnyTextInset
Constants.FV_FindAnyVariable
Constants.FV_FindAnyXRef
Constants.FV_FindAttrName
Constants.FV_FindAttrValue
Constants.FV_FindAutomaticHyphen
Constants.FV_FindCharacterFormatOverride
Constants.FV_FindElemTag
Constants.FV_FindFootnote
Constants.FV_FindPgfFormatOverride
Constants.FV_FindStyleFormatOverride
Constants.FV_FindTableFormatOverride
Constants.FV_FindUnresolvedTextInset
Constants.FV_FindUnresolvedXRef
Constants.FV_FlowUnstructured
Constants.FV_FontMetricsChanged
Constants.FV_FontsMappedInCatalog
Constants.FV_FontsWereMapped
Constants.FV_FontsWithUnavailableEncodingsUsed
Constants.FV_Footing
Constants.FV_GB
Constants.FV_GRAPHIC
Constants.FV_GRAPHICS_CATALOG
Constants.FV_GetDictionaryStrings
Constants.FV_HELP_CONTEXT
Constants.FV_HELP_HYPERTEXT
Constants.FV_HELP_INDEX
Constants.FV_HELP_INIT_CONTEXT
Constants.FV_HELP_KEYS
Constants.FV_HELP_ONLINE_MANUALS
Constants.FV_HELP_OVERVIEW
Constants.FV_HELP_SAMPLES
Constants.FV_HELP_WEBWORKS
Constants.FV_HIST
Constants.FV_HZ
Constants.FV_Heading
Constants.FV_Hint_FilterName
Constants.FV_Hint_FilterVersion
Constants.FV_Hint_FormatId
Constants.FV_Hint_HintVersion
Constants.FV_Hint_Platform
Constants.FV_Hint_VendorId
Constants.FV_HypertextBadMatrixSize
Constants.FV_HypertextBadSyntaxPathSpec
Constants.FV_HypertextCantOpenDestFile
Constants.FV_HypertextCommandIllegalWithinPopup
Constants.FV_HypertextDestinationLinkNotFound
Constants.FV_HypertextDuplicateLinkName
Constants.FV_HypertextEmptyCommand
Constants.FV_HypertextEmptyLineInMiddleOfPopup
Constants.FV_HypertextExpectedANumberParam
Constants.FV_HypertextExtraArguments
Constants.FV_HypertextFcodeInvalid
Constants.FV_HypertextFileNotMakerDoc
Constants.FV_HypertextFileNotRegular
Constants.FV_HypertextFlowMissingLines
Constants.FV_HypertextHelpDirNotFound
Constants.FV_HypertextMatrixCommandInvalid
Constants.FV_HypertextMissingArguments
Constants.FV_HypertextMissingPopupLabelItem
Constants.FV_HypertextMissingPopupMarker
Constants.FV_HypertextNoNamedFlow
Constants.FV_HypertextObjectIDNotFound
Constants.FV_HypertextPageNameNotFound
Constants.FV_HypertextRecursiveFlow
Constants.FV_HypertextSyntaxOK
Constants.FV_HypertextUnanchoredPartialPath
Constants.FV_HypertextUnrecognizedCommand
Constants.FV_HypertextUnrecognizedObjectType
Constants.FV_HypertextUsesDefaultText
Constants.FV_HypertextValid
Constants.FV_IMG_NEGATIVE
Constants.FV_IMG_POSITIVE
Constants.FV_INCLUSION
Constants.FV_INTERACT_ROTATE
Constants.FV_INTERACT_ROTATE_CONSTRAIN
Constants.FV_ITEM_HAS_NO_SHIFT_OR_UNSHIFT_COMMAND
Constants.FV_ITEM_HAS_SHIFT_COMMAND
Constants.FV_ITEM_HAS_UNSHIFT_COMMAND
Constants.FV_ImportFileNotReadable
Constants.FV_ImportedByCopy
Constants.FV_ImportedFilteredFile
Constants.FV_ImportedGraphicFile
Constants.FV_ImportedMIF
Constants.FV_ImportedMacEdition
Constants.FV_ImportedMakerDoc
Constants.FV_ImportedSgmlDoc
Constants.FV_ImportedText
Constants.FV_ImportedTextTable
Constants.FV_ImportedXmlDoc
Constants.FV_InsertionPointInFootnote
Constants.FV_InsertionPointInTableCell
Constants.FV_InsertionPointNotInText
Constants.FV_InsufficientMem
Constants.FV_InsufficientMemory
Constants.FV_InvalidExportFilter
Constants.FV_InvalidSaveFilter
Constants.FV_InvalidTextRange
Constants.FV_IsoLatin
Constants.FV_JIS
Constants.FV_KNOCKOUT
Constants.FV_KeyCatalogWorkflowAuthoring
Constants.FV_KeyCatalogWorkflowMax
Constants.FV_KeyCatalogWorkflowPublishing
Constants.FV_KeyCatalogWorkflowSearching
Constants.FV_KeyDefFieldSize
Constants.FV_KeyDefFieldsTypeAll
Constants.FV_KeyDefFieldsTypeMax
Constants.FV_KeyDefFieldsTypePrimary
Constants.FV_KeyDefMaxFields
Constants.FV_KeyDefMaxPrimaryFields
Constants.FV_KeySrcTypeDitamap
Constants.FV_KeySrcTypeNone
Constants.FV_KeydefKeyAttrs
Constants.FV_KeydefKeyAttrsType
Constants.FV_KeydefKeyDefaultText
Constants.FV_KeydefKeyDefaultTextType
Constants.FV_KeydefKeyDuplicate
Constants.FV_KeydefKeyDuplicateType
Constants.FV_KeydefKeyFoundInRefFile
Constants.FV_KeydefKeyFoundInRefFileType
Constants.FV_KeydefKeyInValid
Constants.FV_KeydefKeyInValidType
Constants.FV_KeydefKeySrcFile
Constants.FV_KeydefKeySrcFileType
Constants.FV_KeydefKeySrcType
Constants.FV_KeydefKeySrcTypeType
Constants.FV_KeydefKeyTag
Constants.FV_KeydefKeyTagType
Constants.FV_KeydefKeyTarget
Constants.FV_KeydefKeyTargetType
Constants.FV_KeydefKeyVarList
Constants.FV_KeydefKeyVarListType
Constants.FV_KeydefVariableInfoLen
Constants.FV_KeydefVariableInfoTagPrimary
Constants.FV_KeydefVariableInfoTagSecondary
Constants.FV_KeydefVariableInfoText
Constants.FV_Korean
Constants.FV_LANG_BRAZILIAN
Constants.FV_LANG_BRITISH
Constants.FV_LANG_BULGARIAN
Constants.FV_LANG_CANADIAN_FRENCH
Constants.FV_LANG_CATALAN
Constants.FV_LANG_CROATIAN
Constants.FV_LANG_CZECH
Constants.FV_LANG_DANISH
Constants.FV_LANG_DUTCH
Constants.FV_LANG_ENGLISH
Constants.FV_LANG_ESTONIAN
Constants.FV_LANG_FINNISH
Constants.FV_LANG_FRENCH
Constants.FV_LANG_GERMAN
Constants.FV_LANG_GREEK
Constants.FV_LANG_HUNGARIAN
Constants.FV_LANG_ITALIAN
Constants.FV_LANG_JAPANESE
Constants.FV_LANG_KOREAN
Constants.FV_LANG_LATVIAN
Constants.FV_LANG_LITHUANIAN
Constants.FV_LANG_NEW_DUTCH
Constants.FV_LANG_NEW_GERMAN
Constants.FV_LANG_NEW_SWISS_GERMAN
Constants.FV_LANG_NOLANGUAGE
Constants.FV_LANG_NORWEGIAN
Constants.FV_LANG_NUM
Constants.FV_LANG_NYNORSK
Constants.FV_LANG_POLISH
Constants.FV_LANG_PORTUGUESE
Constants.FV_LANG_ROMANIAN
Constants.FV_LANG_RUSSIAN
Constants.FV_LANG_SIMPLIFIED_CHINESE
Constants.FV_LANG_SLOVAK
Constants.FV_LANG_SLOVENIAN
Constants.FV_LANG_SPANISH
Constants.FV_LANG_SWEDISH
Constants.FV_LANG_SWISS_GERMAN
Constants.FV_LANG_TRADITIONAL_CHINESE
Constants.FV_LANG_TURKISH
Constants.FV_LEVEL_RULE
Constants.FV_LOOSELY_VALID
Constants.FV_LanguagesWerentFound
Constants.FV_Left
Constants.FV_ListViewActionMax
Constants.FV_ListViewAddColumn
Constants.FV_ListViewAddColumnNumParams
Constants.FV_ListViewAddColumnParam1
Constants.FV_ListViewAddColumnParam2
Constants.FV_ListViewAddColumnParam3
Constants.FV_ListViewAddColumnParam4
Constants.FV_ListViewAddRow
Constants.FV_ListViewAddRowNumParams
Constants.FV_ListViewAddRowParam1
Constants.FV_ListViewDeleteAllRows
Constants.FV_ListViewDeleteAllRowsNumParams
Constants.FV_ListViewInit
Constants.FV_ListViewInitNumParams
Constants.FV_ListViewReSortAllRows
Constants.FV_ListViewReSortAllRowsNumParams
Constants.FV_ListViewSetSortEnabled
Constants.FV_LockCouldntBeReset
Constants.FV_LockNotReset
Constants.FV_LockWasInvalid
Constants.FV_LockWasReset
Constants.FV_MATH
Constants.FV_MATH_LARGE
Constants.FV_MATH_MEDIUM
Constants.FV_MATH_SMALL
Constants.FV_MENUITEM_API
Constants.FV_MENUITEM_EXPANDOMATIC
Constants.FV_MENUITEM_FRAME
Constants.FV_MENUITEM_MACRO
Constants.FV_MENU_ADHOCRULER
Constants.FV_MENU_COMPLETE
Constants.FV_MENU_CUSTOM
Constants.FV_MENU_DEFAULT
Constants.FV_MENU_MENUBAR
Constants.FV_MENU_POPUP
Constants.FV_MENU_QUICK
Constants.FV_MODE_ALL
Constants.FV_MODE_MATH
Constants.FV_MODE_NONMATH
Constants.FV_MONOSPACE_YAKUMONO
Constants.FV_MacANSI
Constants.FV_MakePageCountEven
Constants.FV_MakePageCountOdd
Constants.FV_MergeDictionaryContents
Constants.FV_MissingExportScript
Constants.FV_MissingImportScript
Constants.FV_MissingScript
Constants.FV_ModeSave
Constants.FV_ModeSaveAs
Constants.FV_NARROW
Constants.FV_NO_BASE_COLOR
Constants.FV_NO_ZOOM_MANGLING
Constants.FV_NUMSTYLE_ALPHA_LC
Constants.FV_NUMSTYLE_ALPHA_UC
Constants.FV_NUMSTYLE_CHINESE_NUMERIC
Constants.FV_NUMSTYLE_DAIJI
Constants.FV_NUMSTYLE_FULLWIDTH
Constants.FV_NUMSTYLE_FULLWIDTH_LC
Constants.FV_NUMSTYLE_FULLWIDTH_UC
Constants.FV_NUMSTYLE_KANJI
Constants.FV_NUMSTYLE_KANJI_KAZU
Constants.FV_NUMSTYLE_NUMERIC
Constants.FV_NUMSTYLE_ROMAN_LC
Constants.FV_NUMSTYLE_ROMAN_UC
Constants.FV_NUMSTYLE_TEXT
Constants.FV_NUMSTYLE_ZENKAKU
Constants.FV_NUMSTYLE_ZENKAKU_LC
Constants.FV_NUMSTYLE_ZENKAKU_UC
Constants.FV_NUM_CONTINUE
Constants.FV_NUM_PERPAGE
Constants.FV_NUM_READ_FROM_FILE
Constants.FV_NUM_RESTART
Constants.FV_NUM_SAME
Constants.FV_NoFlowWithSpecifiedName
Constants.FV_NoMainFlow
Constants.FV_NoNonGeneratedFilesInBook
Constants.FV_NonPortableFileRefs
Constants.FV_NonPortableSaveName
Constants.FV_NumExportStatusFields
Constants.FV_NumFindElementItems
Constants.FV_NumImportStatusFields
Constants.FV_NumOpenStatusFields
Constants.FV_NumSaveStatusFields
Constants.FV_NumUpdateBookStatusFields
Constants.FV_OBJ_END_OFFSET
Constants.FV_OVERPRINT
Constants.FV_OVERRIDDEN_CONREF_DUCT
Constants.FV_OVERRIDDEN_DEFAULT
Constants.FV_OVERRIDDEN_KEYDEF_TO_KEYREF
Constants.FV_OVERRIDDEN_NOVALUE
Constants.FV_ObjectDataLink
Constants.FV_ObjectElement
Constants.FV_ObjectGraphic
Constants.FV_ObjectMarker
Constants.FV_ObjectPgf
Constants.FV_ObjectTextInset
Constants.FV_ObjectUnknown
Constants.FV_ObjectXref
Constants.FV_OpenEditableCopy
Constants.FV_OpenViewOnly
Constants.FV_OpenedFluid
Constants.FV_OpenedViewOnly
Constants.FV_PAGE_NUM_ALPHA_LC
Constants.FV_PAGE_NUM_ALPHA_UC
Constants.FV_PAGE_NUM_CHINESE_NUMERIC
Constants.FV_PAGE_NUM_DAIJI
Constants.FV_PAGE_NUM_FULLWIDTH
Constants.FV_PAGE_NUM_FULLWIDTH_LC
Constants.FV_PAGE_NUM_FULLWIDTH_UC
Constants.FV_PAGE_NUM_KANJI
Constants.FV_PAGE_NUM_KANJI_KAZU
Constants.FV_PAGE_NUM_NUMERIC
Constants.FV_PAGE_NUM_ROMAN_LC
Constants.FV_PAGE_NUM_ROMAN_UC
Constants.FV_PAGE_NUM_ZENKAKU
Constants.FV_PAGE_NUM_ZENKAKU_LC
Constants.FV_PAGE_NUM_ZENKAKU_UC
Constants.FV_PDFBookmarksOpenAllLevels
Constants.FV_PDFBookmarksOpenDefaultLevel
Constants.FV_PDFBookmarksOpenNoneLevel
Constants.FV_PDFRegistrationMarksMax
Constants.FV_PDFRegistrationMarksNone
Constants.FV_PDFRegistrationMarksTombo
Constants.FV_PDFRegistrationMarksWestern
Constants.FV_PDFZoomDefault
Constants.FV_PDFZoomHeight
Constants.FV_PDFZoomMaxValue
Constants.FV_PDFZoomNone
Constants.FV_PDFZoomPage
Constants.FV_PDFZoomWidth
Constants.FV_PGF_ANYWHERE
Constants.FV_PGF_CATALOG
Constants.FV_PGF_CENTER
Constants.FV_PGF_FIXED
Constants.FV_PGF_FIXED_B_MARGIN
Constants.FV_PGF_FIXED_L_MARGIN
Constants.FV_PGF_FIXED_R_MARGIN
Constants.FV_PGF_FIXED_T_MARGIN
Constants.FV_PGF_FLOATING
Constants.FV_PGF_JUSTIFIED
Constants.FV_PGF_LEFT
Constants.FV_PGF_PROPORTIONAL
Constants.FV_PGF_RIGHT
Constants.FV_PGF_RUN_IN
Constants.FV_PGF_SIDEBODY
Constants.FV_PGF_SIDEHEAD_FIRST_BASELINE
Constants.FV_PGF_SIDEHEAD_LAST_BASELINE
Constants.FV_PGF_SIDEHEAD_TOP
Constants.FV_PGF_STRADDLE
Constants.FV_PGF_STRADDLE_NORMAL_ONLY
Constants.FV_PGF_TOP_OF_COL
Constants.FV_PGF_TOP_OF_LEFT_PAGE
Constants.FV_PGF_TOP_OF_PAGE
Constants.FV_PGF_TOP_OF_RIGHT_PAGE
Constants.FV_PGF_V_ALIGN_BOTTOM
Constants.FV_PGF_V_ALIGN_MIDDLE
Constants.FV_PGF_V_ALIGN_TOP
Constants.FV_POINT_PAGE_CHINESE_NUMERIC
Constants.FV_POINT_PAGE_FULLWIDTH
Constants.FV_POINT_PAGE_FULLWIDTH_LC
Constants.FV_POINT_PAGE_FULLWIDTH_UC
Constants.FV_POINT_PAGE_NUM_ALPHA_LC
Constants.FV_POINT_PAGE_NUM_ALPHA_UC
Constants.FV_POINT_PAGE_NUM_DAIJI
Constants.FV_POINT_PAGE_NUM_KANJI
Constants.FV_POINT_PAGE_NUM_KANJI_KAZU
Constants.FV_POINT_PAGE_NUM_NUMERIC
Constants.FV_POINT_PAGE_NUM_ROMAN_LC
Constants.FV_POINT_PAGE_NUM_ROMAN_UC
Constants.FV_POINT_PAGE_NUM_ZENKAKU
Constants.FV_POINT_PAGE_NUM_ZENKAKU_LC
Constants.FV_POINT_PAGE_NUM_ZENKAKU_UC
Constants.FV_POS_NORM
Constants.FV_POS_SUB
Constants.FV_POS_SUPER
Constants.FV_PREVIEW_OFF_TRACK_CHANGE
Constants.FV_PREVIEW_ON_FINAL
Constants.FV_PREVIEW_ON_ORIGINAL
Constants.FV_PRINT_NO
Constants.FV_PRINT_PROCESS
Constants.FV_PRINT_SPOT
Constants.FV_PRODUCT_ALL
Constants.FV_PRODUCT_STRUCTURED
Constants.FV_PRODUCT_UNSTRUCTURED
Constants.FV_PRODUCT_XMLAUTHOR
Constants.FV_PROPORTIONAL
Constants.FV_PR_ALL
Constants.FV_PR_DEL_EMPTY
Constants.FV_PR_DONT_CHANGE
Constants.FV_PR_DOWNLOAD_ALL
Constants.FV_PR_DOWNLOAD_ALL_BUT_STANDARD_13
Constants.FV_PR_DOWNLOAD_ALL_BUT_STANDARD_35
Constants.FV_PR_DOWNLOAD_NONE
Constants.FV_PR_KEEP_NUM_EVEN
Constants.FV_PR_KEEP_NUM_ODD
Constants.FV_PR_RANGE
Constants.FV_PlainText
Constants.FV_ProductIsMaker
Constants.FV_ProductIsViewer
Constants.FV_RC_CHANGELIST
Constants.FV_RC_CHANGELIST_TAG
Constants.FV_RC_SUB_FMTRULE
Constants.FV_RC_TAG
Constants.FV_REFERENCE_PAGE
Constants.FV_ROW_ANYWHERE
Constants.FV_ROW_BODY
Constants.FV_ROW_FOOTING
Constants.FV_ROW_HEADING
Constants.FV_ROW_TOP_OF_COL
Constants.FV_ROW_TOP_OF_LEFT_PAGE
Constants.FV_ROW_TOP_OF_PAGE
Constants.FV_ROW_TOP_OF_RIGHT_PAGE
Constants.FV_RecoverFileUsed
Constants.FV_RedoAll
Constants.FV_ReferencePage
Constants.FV_ReferencedFilesWerentFound
Constants.FV_ResetLockAndContinue
Constants.FV_Right
Constants.FV_SCROLL_FACING
Constants.FV_SCROLL_HORIZONTAL
Constants.FV_SCROLL_VARIABLE
Constants.FV_SCROLL_VERTICAL
Constants.FV_SEP_NONE
Constants.FV_SEP_NORMAL
Constants.FV_SEP_WHITE
Constants.FV_SH_INSIDE
Constants.FV_SH_LEFT
Constants.FV_SH_OUTSIDE
Constants.FV_SH_RIGHT
Constants.FV_STRICTLY_VALID
Constants.FV_SaveAsNameAskUser
Constants.FV_SaveAsNameProvided
Constants.FV_SaveAsUseFileName
Constants.FV_SaveFmtBinary
Constants.FV_SaveFmtBinary100
Constants.FV_SaveFmtBinary110
Constants.FV_SaveFmtBinary120
Constants.FV_SaveFmtBinary60
Constants.FV_SaveFmtBinary70
Constants.FV_SaveFmtBinary80
Constants.FV_SaveFmtBinary90
Constants.FV_SaveFmtBookWithFm
Constants.FV_SaveFmtBookWithXml
Constants.FV_SaveFmtCompositeDoc
Constants.FV_SaveFmtFilter
Constants.FV_SaveFmtInterchange
Constants.FV_SaveFmtInterchange100
Constants.FV_SaveFmtInterchange110
Constants.FV_SaveFmtInterchange120
Constants.FV_SaveFmtInterchange70
Constants.FV_SaveFmtInterchange80
Constants.FV_SaveFmtInterchange90
Constants.FV_SaveFmtPdf
Constants.FV_SaveFmtSgml
Constants.FV_SaveFmtStationery
Constants.FV_SaveFmtText
Constants.FV_SaveFmtViewOnly
Constants.FV_SaveFmtXml
Constants.FV_SaveNoAutoBackup
Constants.FV_SaveSkipTbls
Constants.FV_SaveTblColsAsPgfs
Constants.FV_SaveTblRowsAsPgfs
Constants.FV_SaveTblUserPref
Constants.FV_SaveUserPrefAutoBackup
Constants.FV_SaveYesAutoBackup
Constants.FV_SessionId
Constants.FV_SetDictionaryToNoneDictionary
Constants.FV_Shitf_JIS
Constants.FV_SourceDoc
Constants.FV_SpellCapitalization
Constants.FV_SpellExtraSpace
Constants.FV_SpellHyphenation
Constants.FV_SpellMisspelling
Constants.FV_SpellRepeatedLetter
Constants.FV_SpellRepeatedWord
Constants.FV_SpellSpaceAfter
Constants.FV_SpellSpaceBefore
Constants.FV_SpellStraightQuotes
Constants.FV_StripStructureAndOpen
Constants.FV_TAB_CENTER
Constants.FV_TAB_DECIMAL
Constants.FV_TAB_LEFT
Constants.FV_TAB_RELATIVE_CENTER
Constants.FV_TAB_RELATIVE_DECIMAL
Constants.FV_TAB_RELATIVE_LEFT
Constants.FV_TAB_RELATIVE_RIGHT
Constants.FV_TAB_RIGHT
Constants.FV_TBL_ANYWHERE
Constants.FV_TBL_CATALOG
Constants.FV_TBL_FLOAT
Constants.FV_TBL_NO_TITLE
Constants.FV_TBL_NUM_BY_COL
Constants.FV_TBL_NUM_BY_ROW
Constants.FV_TBL_TITLE_ABOVE
Constants.FV_TBL_TITLE_BELOW
Constants.FV_TBL_TOP_OF_COL
Constants.FV_TBL_TOP_OF_LEFT_PAGE
Constants.FV_TBL_TOP_OF_PAGE
Constants.FV_TBL_TOP_OF_RIGHT_PAGE
Constants.FV_TEMPLATE_BROWSER
Constants.FV_TEXTLINE_CENTER
Constants.FV_TEXTLINE_LEFT
Constants.FV_TEXTLINE_MATH
Constants.FV_TEXTLINE_RIGHT
Constants.FV_THESAURUS
Constants.FV_TR_BBOX
Constants.FV_TR_CONTOUR
Constants.FV_TR_NONE
Constants.FV_TYPE_BINARY
Constants.FV_TYPE_FILTER
Constants.FV_TYPE_MIF
Constants.FV_TYPE_SGML
Constants.FV_TYPE_TEXT
Constants.FV_TYPE_XML
Constants.FV_TextFile_EOLisEOP
Constants.FV_TextFile_EOLisNotEOP
Constants.FV_TooManyWindows
Constants.FV_TooManyWindowsUpdateBook
Constants.FV_URL_CHECKED_IN
Constants.FV_URL_CHECKED_OUT
Constants.FV_UndoAll
Constants.FV_UnresolvedTextInsets
Constants.FV_UnresolvedXRefs
Constants.FV_Unstructured
Constants.FV_UpdateAllAutomaticClientTi
Constants.FV_UpdateAllClientTi
Constants.FV_UpdateAllManualClientTi
Constants.FV_UseCurrentSetting
Constants.FV_UserCanceled
Constants.FV_UserCanceledExport
Constants.FV_UserCanceledImport
Constants.FV_UserCanceledSave
Constants.FV_UserCanceledUpdateBook
Constants.FV_UserDictionary
Constants.FV_VAR_CREATION_DATE_LONG
Constants.FV_VAR_CREATION_DATE_SHORT
Constants.FV_VAR_CURRENT_DATE_LONG
Constants.FV_VAR_CURRENT_DATE_SHORT
Constants.FV_VAR_CURRENT_PAGE_NUM
Constants.FV_VAR_FILE_NAME_LONG
Constants.FV_VAR_FILE_NAME_SHORT
Constants.FV_VAR_HEADER_FOOTER_1
Constants.FV_VAR_HEADER_FOOTER_10
Constants.FV_VAR_HEADER_FOOTER_11
Constants.FV_VAR_HEADER_FOOTER_12
Constants.FV_VAR_HEADER_FOOTER_13
Constants.FV_VAR_HEADER_FOOTER_14
Constants.FV_VAR_HEADER_FOOTER_15
Constants.FV_VAR_HEADER_FOOTER_16
Constants.FV_VAR_HEADER_FOOTER_17
Constants.FV_VAR_HEADER_FOOTER_18
Constants.FV_VAR_HEADER_FOOTER_2
Constants.FV_VAR_HEADER_FOOTER_3
Constants.FV_VAR_HEADER_FOOTER_4
Constants.FV_VAR_HEADER_FOOTER_5
Constants.FV_VAR_HEADER_FOOTER_6
Constants.FV_VAR_HEADER_FOOTER_7
Constants.FV_VAR_HEADER_FOOTER_8
Constants.FV_VAR_HEADER_FOOTER_9
Constants.FV_VAR_MODIFICATION_DATE_LONG
Constants.FV_VAR_MODIFICATION_DATE_SHORT
Constants.FV_VAR_PAGE_COUNT
Constants.FV_VAR_TABLE_CONTINUATION
Constants.FV_VAR_TABLE_SHEET
Constants.FV_VAR_USER_VARIABLE
Constants.FV_VIEW_ALL
Constants.FV_VIEW_AUTHOR
Constants.FV_VIEW_WYSIWYG
Constants.FV_VIEW_XML
Constants.FV_VOS_NONE
Constants.FV_VOS_USER_ONLY
Constants.FV_VOS_YES
Constants.FV_VOX_ALERT
Constants.FV_VOX_GOTO_BEHAVIOR
Constants.FV_VOX_NOT_ACTIVE
Constants.FV_VOX_OPEN_BEHAVIOR
Constants.FV_WIDE
Constants.FV_WINDOW_ALL
Constants.FV_WINDOW_BOOK
Constants.FV_WINDOW_DITAMAP
Constants.FV_WINDOW_DOC
Constants.FV_WarnAlways
Constants.FV_WarnNever
Constants.FV_WarnOnce
Constants.FV_WriteDictionaryToFile
Constants.FV_WriteUnknownWordsToFile
Constants.FV_XML_STANDALONE_NO
Constants.FV_XML_STANDALONE_NODEC
Constants.FV_XML_STANDALONE_NONE
Constants.FV_XML_STANDALONE_YES
Constants.FV_XML_USEBOM_NO
Constants.FV_XML_USEBOM_UTF16BE
Constants.FV_XML_USEBOM_UTF16LE
Constants.FV_XML_USEBOM_UTF32BE
Constants.FV_XML_USEBOM_UTF32LE
Constants.FV_XML_USEBOM_UTF8
Constants.FV_XML_USEBOM_YES
Constants.FV_XML_WELLFORMED_NO
Constants.FV_XML_WELLFORMED_YES
Constants.FV_ZOOM_TO_FIT_TO_WINDOW
Constants.oldFT_ElementFmts
Usage
Jongware,18-Jan-2015v1.0 Contents::Index
Doc
QuickLinks AddNewBuildExpr,AddTableVariables,AddText,CenterOnTextClose,Compare,Copy,Cut,DeleteBuildExpr,DeleteText,DeleteUndefinedAttributeDeleteUnusedCharFmt,DeleteUnusedFmts,DeleteUnusedGraphicsFmtDeleteUnusedTblFmt,DemoteElement,ElementLocToTextLoc,GetActiveBuildExpr,GetBuildExpr,GetBuildExprCatalog,GetDependenciesGetNamedAttrCondExpr,GetNamedCharFmt,GetNamedColor,GetNamedCombinedFontDefn,GetNamedCondFmt,GetNamedElementDefGetNamedFmtChangeList,GetNamedGraphicsFmt,GetNamedMarkerTypeGetNamedMasterPage,GetNamedObject,GetNamedPgfFmt,GetNamedRefPageGetNamedRulingFmt,GetNamedTblFmt,GetNamedUnanchoredFrameGetNamedXRefFmt,GetProps,GetTextForRange,GetTextForRange2GetTextProps,GetTextVal,GetUniqueObject,HypertextCommandMergeIntoLast,NewAnchoredAFrame,NewAnchoredFn,NewAnchoredFormattedObjectNewAnchoredFormattedTbl,NewAnchoredFormattedVar,NewAnchoredFormattedXRefNewAnchoredMarker,NewAnchoredObject,NewAnchoredTbl,NewArc,NewEllipse,NewFlow,NewGraphicObject,NewGroupNewLine,NewMath,NewMathML,NewNamedAttrCondExpr,NewNamedColor,NewNamedCombinedFontDefn,NewNamedCondFmtNewNamedElementDef,NewNamedFmtChangeList,NewNamedGraphicsFmtNewNamedMarkerType,NewNamedMasterPage,NewNamedObjectNewNamedRefPage,NewNamedRulingFmt,NewNamedTblFmtNewNamedXRefFmt,NewPolygon,NewPolyline,NewRectangleNewSeriesBodyPage,NewSeriesObject,NewSeriesPgf,NewTableNewTextLine,NewUnanchoredFrame,ObjectValid,Paste,PromoteElementRedisplay,Reformat,Rehyphenate,ResetEqnSettings,ResetReferenceFramesRestartPgfNumbering,Save,ScrollToText,SetActiveBuildExpr,SetElementRange,SetProps,SetTextPropVal,SetTextProps,SetTextValSimpleImportElementDefs,SimpleImportFormats,SimpleSave,TextLocToElementLoc,TrackChangesAcceptAll,TrackChangesRejectAllUndoCancel,UndoEndCheckPoint,UndoStartCheckPoint,UpdateDITAReferencesUpdateVariables,UpdateXRef,UpdateXRefs
Properties Property Type
AcrobatBookmarkDisplayTags int
AutoChangeBars int
BannerTextDisplay bool
BooleanConditionExpression string
BooleanConditionExpressionTag string
BooleanConditionState int
BottomMargin int
Capitalization int
ChangeBar int
ChangeBarColor Color
ChangeBarDistance int
ChangeBarPosition int
ChangeBarThickness int
ChapNumComputeMethod int
ChapterNumStyle int
ChapterNumText string
ChapterNumber int
CharTag string
ColGap int
Color Color
CombinedFontFamily CombinedFontDefn
CondFmtIsShown int
CurrentPage FMObject
CustomElementList Strings String
DefaultExclusions Strings String
DefaultInclusions Strings String
Dictionary Strings String
DocAcrobatColumnArticleThreads int
DocAcrobatDefaultsChanged int
DocAcrobatElementList Strings String
DocAcrobatElements int
DocAcrobatNoArticleThreads int
DocFluidFlow Flow
DocIsDoubleSided int
DocIsModified int
DocIsViewOnly int
DocOpenType int
DocSaveType int
DontUpdateTextInsets int
DontUpdateXRefs int
DownloadFonts int
ElementBoundaryDisplay int
ElementCatalog ElementCatalogEntriesElementCatalogEntry
ElementCatalogDisplay int
ElementSelection ElementRange
EqnIntegralSizeLarge int
EqnIntegralSizeMed int
EqnIntegralSizeSmall int
EqnLevel1SizeLarge int
EqnLevel1SizeMed int
EqnLevel1SizeSmall int
EqnLevel2SizeLarge int
EqnLevel2SizeMed int
EqnLevel2SizeSmall int
EqnLevel3SizeLarge int
EqnLevel3SizeMed int
EqnLevel3SizeSmall int
EqnSigmaSizeLarge int
EqnSigmaSizeMed int
EqnSigmaSizeSmall int
FirstAttrCondExprInDoc AttrCondExpr
FirstBodyPageInDoc BodyPage
FirstCharFmtInDoc CharFmt
FirstColorInDoc Color
FirstCombinedFontDefnInDoc CombinedFontDefn
FirstCondFmtInDoc CondFmt
FirstDITAConrefElementInDoc Element
FirstDITALinkElementInDoc Element
FirstDITATopicrefElementInDoc Element
FirstDITATopicsetrefElementInDoc Element
FirstDITAXrefElementInDoc Element
FirstElementDefInDoc ElementDef
FirstFlowInDoc Flow
FirstFmtChangeListInDoc FmtChangeList
FirstFnInDoc Fn
FirstGraphicInDoc FMObject
FirstGraphicsFmtInDoc GraphicsFmt
FirstMarkerInDoc Marker
FirstMarkerTypeInDoc MarkerType
FirstMasterPageInDoc MasterPage
FirstPageNum int
FirstPageVerso int
FirstPgfFmtInDoc PgfFmt
FirstPgfInDoc Pgf
FirstRefPageInDoc RefPage
FirstRubiInDoc Rubi
FirstRulingFmtInDoc RulingFmt
FirstSelectedGraphicInDoc FMObject
FirstSelectedTiInDoc FMObject
FirstTblFmtInDoc TblFmt
FirstTblInDoc Tbl
FirstTiInDoc FMObject
FirstVarFmtInDoc VarFmt
FirstVarInDoc Var
FirstXRefFmtInDoc XRefFmt
FirstXRefInDoc XRef
FnCustNumString string
FnFirstNum int
FnFmt string
FnHeightPerCol int
FnInstancePosition int
FnInstancePrefix string
FnInstanceSuffix string
FnNumComputeMethod int
FnNumStyle int
FnNumberingPerPage int
FnRefPosition int
FnRefPrefix string
FnRefSuffix string
FontAngle int
FontEncodingName string
FontFamily int
FontPlatformName string
FontPostScriptName string
FontSize int
FontVariation int
FontWeight int
FormatOverride int
Functions string
GenerateAcrobatInfo int
HiddenPage HiddenPage
HypertextCommandText string
HypertextDoValidate bool
HypertextParseBadParam int
HypertextParseErr int
HypertextParseErrMsg string
HypertextParsedClientName string
HypertextParsedCmdCode int
HypertextParsedCmdDest int
HypertextParsedCmdDestObjID int
HypertextParsedCmdDestObjType int
HypertextParsedCmdMatrixColumns int
HypertextParsedCmdMatrixRows int
HypertextParsedDIFileName string
HypertextParsedFlowName string
HypertextParsedLinkName string
HypertextParsedMessage string
HypertextParsedPageName string
HypertextParsedTitle string
HypertextValidateErr int
InCond Objects
IsIconified int
IsInFront int
IsOnScreen int
KernX int
KernY int
KeyCatalog KeyCatalog
KeyCatalogType int
Label string
LastBodyPageInDoc BodyPage
LastMasterPageInDoc MasterPage
LastRefPageInDoc RefPage
LeftMargin int
LeftMasterPage MasterPage
LineBreakAfter string
LineNumDistance int
LineNumRestart bool
LineNumShow bool
MainFlowInDoc Flow
MarkerTypeNames Strings String
MaxBottomMargin int
MaxFirstIndent int
MaxFontSize int
MaxLeading int
MaxLeftIndent int
MaxLeftMargin int
MaxRightIndent int
MaxRightMargin int
MaxSpaceAbove int
MaxSpaceBelow int
MaxSpread int
MaxStretch int
MaxTabPosition int
MaxTopMargin int
MenuBar Menu
MinBottomMargin int
MinFirstIndent int
MinFontSize int
MinLeading int
MinLeftIndent int
MinLeftMargin int
MinRightIndent int
MinRightMargin int
MinSpaceAbove int
MinSpaceBelow int
MinSpread int
MinStretch int
MinTabPosition int
MinTopMargin int
Name string
NarrowRubiSpaceForOther int
NewElemAttrDisplay int
NewElemAttrEditing int
NextOpenDocInSession Doc
NumCols int
Numbers string
Overline int
PDFAllNamedDestinations int
PDFBookmark bool
PDFBookmarksOpenLevel int
PDFConvertCMYKtoRGB int
PDFDestsMarked int
PDFDistillerAbsent int
PDFDocInfo Strings String
PDFEndPage string
PDFGenerateForReview int
PDFJobOption string
PDFJobOptionsAbsent int
PDFOpenPage string
PDFPageHeight int
PDFPageWidth int
PDFPrintPageRange int
PDFRegistrationMarks int
PDFSeparateFiles int
PDFStartPage string
PDFStructure int
PDFViewPDF int
PDFZoomFactor int
PDFZoomType int
PageHeight int
PageNumComputeMethod int
PageNumStyle int
PageRounding int
PageWidth int
PairKern int
PgfNumComputeMethod int
PointPageNumStyle int
Position int
PreviewState int
PrintBlankPages int
PrintCollated int
PrintCols int
PrintDitavalFileName string
PrintEmulsion int
PrintEndPage int
PrintEndPageName int
PrintEndPoint int
PrintEvenPages int
PrintFileName string
PrintImaging int
PrintLastSheetFirst int
PrintLowRes int
PrintManualFeed int
PrintNumCopies int
PrintOddPages int
PrintPaperHeight int
PrintPaperWidth int
PrintRegistrationMarks int
PrintRows int
PrintScale int
PrintScope int
PrintSeps int
PrintStartPage int
PrintStartPageName int
PrintStartPoint int
PrintThumbnails int
PrintToFile int
PrinterName string
ReviewerName string
ReviewerNameList Strings String
RightMargin int
RightMasterPage MasterPage
RubiFixedSize int
RubiOverhang int
RubiSize int
ScreenHeight int
ScreenWidth int
ScreenX int
ScreenY int
SecNumComputeMethod int
SectionNumStyle int
SectionNumText string
SectionNumber int
SelectedTbl Tbl
SepOverride Color
SeparateInclusions int
ShowAll int
ShowCondIndicators int
ShowElementDescriptiveNames bool
SkipBlankSeps int
SmallCapsSize int
SmallCapsStretch int
SmartQuotes int
SmartSpaces int
SnapAngle int
SnapGridUnits int
SpecifiedKeyCatalog KeyCatalog
SpotColorView int
Spread int
StatusLine string
Stretch int
Strikethrough int
Strings string
StructuredApplication string
StructuredApplicationForOpen string
StyleOverrides int
SubScriptShift int
SubScriptSize int
SubScriptStretch int
SubsecNumComputeMethod int
SubsectionNumStyle int
SubsectionNumText string
SubsectionNumber int
SuperScriptShift int
SuperScriptSize int
SuperScriptStretch int
Symbols string
SymbolsList Strings String
TblFnCellPosition int
TblFnCellPrefix string
TblFnCellSuffix string
TblFnCustNumString string
TblFnFmt string
TblFnNumStyle int
TblFnPosition int
TblFnPrefix string
TblFnSuffix string
TextSelection TextRange
TopMargin int
TrackChangesAddedColor Color
TrackChangesDeletedColor Color
TrackChangesOn bool
TrapwiseCompatibility bool
Underlining int
Untouchable int
UseInitialStructure int
UseInitialStructureOfAutoInsertedElements bool
UseSepOverride int
UserString string
Variables string
ViewBorders int
ViewDisplayUnits int
ViewFontSizeUnits int
ViewGrid int
ViewGridUnits int
ViewHotspotIndicators int
ViewNoGraphics int
ViewOnlyDeadCodes UInts
ViewOnlyMenuBar Menu
ViewOnlySelect int
ViewOnlyWinBorders int
ViewOnlyWinMenubar int
ViewOnlyWinPalette int
ViewOnlyWinPopup int
ViewOnlyXRef int
ViewPageScrolling int
ViewRulerUnits int
ViewRulers int
ViewTextSymbols int
VolNumComputeMethod int
VolumeNumStyle int
VolumeNumText string
VolumeNumber int
WideRubiSpaceForOther int
XmlDocType string
XmlEncoding string
XmlFileEncoding string
XmlPublicId string
XmlStandAlone int
XmlStyleSheet string
XmlStyleSheetList Strings String
XmlSystemId string
XmlUseBOM int
XmlVersion string
XmlWellFormed int
Zoom int
Methods InstancesintAddNewBuildExpr(exprName:string,exprCondition:stringParameter Type Description
exprName string
exprCondition string
intAddTableVariables(tblFormatOrTblId:Object,allTables:boolinsertSheetVariable:bool)Parameter Type
tblFormatOrTblId Object
allTables bool
insertContVariable bool
insertSheetVariable bool
TextLocAddText(textLoc:TextLoc,text:string)Parameter Type Description
textLoc TextLoc
text string
intCenterOnText(textRange:TextRange)Parameter Type Description
textRange TextRange
intClear(flags:int)Parameter Type Description
flags int
intClearAllChangebars()
intClose(flags:int)Parameter Type Description
flags int
CompareRetCompare(newerDoc:Doc,flags:int,insertCondTagstring,replaceText:string,compareThreshold:int)Parameter Type
newerDoc Doc
flags int
insertCondTag string
deleteCondTag string
replaceText string
compareThreshold int
intCopy(flags:int)Parameter Type Description
flags int
intCut(flags:int)Parameter Type Description
flags int
intDeleteBuildExpr(exprName:string)Parameter Type Description
exprName string
intDeleteText(textRange:TextRange)Parameter Type Description
textRange TextRange
intDeleteUndefinedAttribute(attrName:string,scope:int,objIdParameter Type Description
attrName string
scope int
objId Object
intDeleteUnusedCharFmt()
intDeleteUnusedFmts(objType:int)Parameter Type Description
objType int
intDeleteUnusedGraphicsFmt()
intDeleteUnusedPgfFmt()
intDeleteUnusedTblFmt()
voidDemoteElement()
TextLocElementLocToTextLoc(eloc:ElementLoc)Parameter Type Description
eloc ElementLoc
intExport(fileName:string,exportParams:PropVals,exportReturnParamsParameter Type
fileName string
exportParams PropVals
exportReturnParams PropVals
TextRangeFind(textLoc:TextLoc,findParams:PropVals)Parameter Type Description
textLoc TextLoc
findParams PropVals
stringGetActiveBuildExpr()
stringGetBuildExpr(exprName:string)Parameter Type Description
exprName string
StringsGetBuildExprCatalog()
TypedValsGetDependencies(depMode:int)Parameter Type Description
depMode int
AttrCondExprGetNamedAttrCondExpr(name:string)Parameter Type Description
name string
CharFmtGetNamedCharFmt(name:string)Parameter Type Description
name string
ColorGetNamedColor(name:string)Parameter Type Description
name string
CombinedFontDefnGetNamedCombinedFontDefn(name:stringParameter Type Description
name string
CondFmtGetNamedCondFmt(name:string)Parameter Type Description
name string
ElementDefGetNamedElementDef(name:string)Parameter Type Description
name string
FmtChangeListGetNamedFmtChangeList(name:string)Parameter Type Description
name string
GraphicsFmtGetNamedGraphicsFmt(name:string)Parameter Type Description
name string
MarkerTypeGetNamedMarkerType(name:string)Parameter Type Description
name string
MasterPageGetNamedMasterPage(name:string)Parameter Type Description
name string
ObjectGetNamedObject(objType:int,name:string)
Parameter Type Description
objType int
name string
PgfFmtGetNamedPgfFmt(name:string)Parameter Type Description
name string
RefPageGetNamedRefPage(name:string)Parameter Type Description
name string
RulingFmtGetNamedRulingFmt(name:string)Parameter Type Description
name string
TblFmtGetNamedTblFmt(name:string)Parameter Type Description
name string
UnanchoredFrameGetNamedUnanchoredFrame(name:stringParameter Type Description
name string
VarFmtGetNamedVarFmt(name:string)Parameter Type Description
name string
XRefFmtGetNamedXRefFmt(name:string)Parameter Type Description
name string
PropValsGetProps()
TextItemsGetTextForRange(tr:TextRange,flags:int)Parameter Type Description
tr TextRange
flags int
TextItemsGetTextForRange2(tr:TextRange,flags:int,flags2:Parameter Type Description
tr TextRange
flags int
flags2 int
PropValGetTextPropVal(textLoc:TextLoc,propNum:int)Parameter Type Description
textLoc TextLoc
propNum int
PropValsGetTextProps(textLoc:TextLoc)Parameter Type Description
textLoc TextLoc
TypedValGetTextVal(textLoc:TextLoc,propNum:int)Parameter Type Description
textLoc TextLoc
propNum int
ObjectGetUniqueObject(objType:int,unique:int)Parameter Type Description
objType int
unique int
intHypertextCommand(hypertext:string)
Parameter Type Description
hypertext string
ObjectImport(textLocP:TextLoc,filename:string,importParamsimportReturnParams:PropVals)Parameter Type
textLocP TextLoc
filename string
importParams PropVals
importReturnParams PropVals
voidMergeIntoFirst()
voidMergeIntoLast()
AFrameNewAnchoredAFrame(textloc:TextLoc)Parameter Type Description
textloc TextLoc
FnNewAnchoredFn(textloc:TextLoc)Parameter Type Description
textloc TextLoc
ObjectNewAnchoredFormattedObject(objType:int,format:Parameter Type Description
objType int
format string
textLoc TextLoc
TblNewAnchoredFormattedTbl(format:string,textLoc:TextLocParameter Type Description
format string
textLoc TextLoc
VarNewAnchoredFormattedVar(format:string,textLoc:TextLocParameter Type Description
format string
textLoc TextLoc
XRefNewAnchoredFormattedXRef(format:string,textLoc:TextLocParameter Type Description
format string
textLoc TextLoc
MarkerNewAnchoredMarker(textloc:TextLoc)Parameter Type Description
textloc TextLoc
ObjectNewAnchoredObject(objType:int,textloc:TextLoc)Parameter Type Description
objType int
textloc TextLoc
TblNewAnchoredTbl(textloc:TextLoc)Parameter Type Description
textloc TextLoc
TiApiClientNewAnchoredTiApiClient(textloc:TextLoc)Parameter Type Description
textloc TextLoc
ArcNewArc(parent:FrameObject)Parameter Type
parent FrameObject
EllipseNewEllipse(parent:FrameObject)
Parameter Type
parent FrameObject
FlowNewFlow(parent:FrameObject)Parameter Type
parent FrameObject
ObjectNewGraphicObject(objType:int,parent:FrameObject)GraphicObjectcouldbeanyFMgraphicobject,i.e,AFrame,UnanchoredFrameParameter Type
objType int
parent FrameObject
GroupNewGroup(parent:FrameObject)Parameter Type
parent FrameObject
InsetNewInset(parent:FrameObject)Parameter Type
parent FrameObject
ObjectNewIterator(paramsp:PropVals)Parameter Type Description
paramsp PropVals
LineNewLine(parent:FrameObject)Parameter Type
parent FrameObject
MathNewMath(parent:FrameObject)Parameter Type
parent FrameObject
MathMLNewMathML(parent:FrameObject)
Parameter Type
parent FrameObject
AttrCondExprNewNamedAttrCondExpr(name:string)Parameter Type Description
name string
CharFmtNewNamedCharFmt(name:string)Parameter Type Description
name string
ColorNewNamedColor(name:string)Parameter Type Description
name string
CombinedFontDefnNewNamedCombinedFontDefn(name:stringParameter Type Description
name string
CondFmtNewNamedCondFmt(name:string)Parameter Type Description
name string
ElementDefNewNamedElementDef(name:string)Parameter Type Description
name string
FmtChangeListNewNamedFmtChangeList(name:string)Parameter Type Description
name string
GraphicsFmtNewNamedGraphicsFmt(name:string)Parameter Type Description
name string
MarkerTypeNewNamedMarkerType(name:string)Parameter Type Description
name string
MasterPageNewNamedMasterPage(name:string)Parameter Type Description
name string
ObjectNewNamedObject(objType:int,name:string)Parameter Type Description
objType int
name string
PgfFmtNewNamedPgfFmt(name:string)Parameter Type Description
name string
RefPageNewNamedRefPage(name:string)Parameter Type Description
name string
RulingFmtNewNamedRulingFmt(name:string)Parameter Type Description
name string
TblFmtNewNamedTblFmt(name:string)Parameter Type Description
name string
VarFmtNewNamedVarFmt(name:string)Parameter Type Description
name string
XRefFmtNewNamedXRefFmt(name:string)Parameter Type Description
name string
PolygonNewPolygon(parent:FrameObject)Parameter Type
parent FrameObject
PolylineNewPolyline(parent:FrameObject)Parameter Type
parent FrameObject
RectangleNewRectangle(parent:FrameObject)Parameter Type
parent FrameObject
RoundRectNewRoundRect(parent:FrameObject)Parameter Type
parent FrameObject
BodyPageNewSeriesBodyPage(previous:Object)Parameter Type Description
previous Object
ObjectNewSeriesObject(objType:int,previous:Object)Parameter Type Description
objType int
previous Object
PgfNewSeriesPgf(previous:Object)Parameter Type Description
previous Object
TblNewTable(format:string,numCols:int,numBodyRows:intnumFooterRows:int,textLoc:TextLoc)Parameter Type
format string
numCols int
numBodyRows int
numHeaderRows int
numFooterRows int
textLoc TextLoc
TextFrameNewTextFrame(parent:FrameObject)Parameter Type
parent FrameObject
TextLineNewTextLine(parent:FrameObject)Parameter Type
parent FrameObject
UnanchoredFrameNewUnanchoredFrame(parent:FrameObjectParameter Type
parent FrameObject
intObjectValid()
intPaste(flags:int)Parameter Type Description
flags int
voidPromoteElement()
intQuickSelect(prompt:string,stringlist:Strings)Parameter Type Description
prompt string
stringlist Strings
intRedisplay()
intReformat()
intRehyphenate()
intResetEqnSettings()
intResetReferenceFrames()
intRestartPgfNumbering()
ObjectSave(saveAsName:string,saveParams:PropVals,saveReturnParamsParameter Type
saveAsName string
saveParams PropVals
saveReturnParams PropVals
intScrollToText(textRange:TextRange)Parameter Type Description
textRange TextRange
intSetActiveBuildExpr(exprName:string)Parameter Type Description
exprName string
intSetAttributeSimple(attrName:string,attrValStr:string,scopeParameter Type Description
attrName string
attrValStr string
scope int
objId Object
voidSetElementRange(propNum:int,setVal:ElementRange)Parameter Type
propNum int
setVal ElementRange
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
voidSetTextPropVal(textRange:TextRange,setVal:PropVal)Parameter Type Description
textRange TextRange
setVal PropVal
voidSetTextProps(textRange:TextRange,setVal:PropVals)Parameter Type Description
textRange TextRange
setVal PropVals
voidSetTextVal(textRange:TextRange,propNum:int,setVal:TypedValParameter Type Description
textRange TextRange
propNum int
setVal TypedVal
intSilentPrintDoc()
intSimpleImportElementDefs(fromDocOrBook:Doc|Book,importFlagsParameter Type
fromDocOrBook Doc|Book
importFlags int
intSimpleImportFormats(fromDoc:Doc,formatFlags:int)Parameter Type Description
fromDoc Doc
formatFlags int
DocSimpleSave(saveAsName:string,interactive:int)Parameter Type Description
saveAsName string
interactive int
voidSplitElement()
ElementLocTextLocToElementLoc(tloc:TextLoc)Parameter Type Description
tloc TextLoc
intTrackChangesAcceptAll()
intTrackChangesRejectAll()
voidUnWrapElement()
voidUndoCancel()
voidUndoEndCheckPoint()
voidUndoStartCheckPoint(description:string)Parameter Type Description
description string
voidUpdateDITAReferences(flag:int)Parameter Type Description
flag int
intUpdateVariables()
intUpdateXRef(srcDoc:Doc,xref:XRef)Parameter Type Description
srcDoc Doc
xref XRef
intUpdateXRefs(updateXRefFlags:int)Parameter Type Description
updateXRefFlags int
Elementof CompareRet.compCompareRet.sumDoc.NextOpenDocInSessionapp.ActiveDocapp.FirstOpenDoc
Usedin: CompareRetBook.Compare(newerDoc:Doc,flags:int,insertCondTagdeleteCondTag:string,replaceText:string,compareThreshold
intBook.SimpleImportFormats(fromDoc:Doc,formatFlags:intCompareRetCompareRet.CompareRet(sum:Doc,comp:Doc)CompareRetDoc.Compare(newerDoc:Doc,flags:int,insertCondTag
string,replaceText:string,compareThreshold:int)intDoc.SimpleImportFormats(fromDoc:Doc,formatFlags:int)intDoc.UpdateXRef(srcDoc:Doc,xref:XRef)
Return DocDoc.SimpleSave(saveAsName:string,interactive:int)DocGlobals.CustomDoc(width:int,height:int,numCols:int,columnGap
botMargin:int,leftinsideMargin:int,rightoutsideMargin:intbool)
DocGlobals.SimpleNewDoc(templateName:string,interactive
Jongware,18-Jan-2015v1.0 Contents::Index
Element
QuickLinks Delete,GetAttributes,GetProps,GetText,ObjectValid,SetPropsUpdateDITAReference
Properties Property Type Access
AllowAsSpecialCase int readwrite
AttrDisplay int readwrite
AttributeValueInvalid int readwrite
Attributes AttributesAttribute
readwrite
AttributesEx AttributesEx readwrite
BookComponent BookComponent readonly
BookComponentMissing int readonly
ContentIsLooselyValid int readonly
ContentIsStrictlyValid int readonly
ContentMustBeEmpty int readonly
ContentNeededAtBegin int readonly
ContentNeededAtEnd int readonly
ContextLabel string readonly
ElementDef ElementDef readwrite
ElementIsCollapsed int readwrite
ElementIsExcludedInContext int readonly
ElementIsInvalidInParent int readonly
ElementIsInvalidInPosition int readonly
ElementIsTopicGroup bool readonly
ElementIsTopicHead bool readonly
ElementIsTopicRef bool readonly
ElementIsUndefined int readonly
ElementMarkedForNamedDestination int readwrite
ElementType int readonly
ErrorInBookComponent int readonly
FirstChildElement Element readonly
FormatOverride int readonly
HoleBeforeElement int readonly
InvalidHighestLevel int readonly
LastChildElement Element readonly
MatchingFirstPgfClauses Objects readonly
MatchingLastPgfClauses Objects readonly
MatchingObjectClauses Objects readonly
MatchingPrefixClauses Objects readonly
MatchingSuffixClauses Objects readonly
MatchingTextClauses Objects readonly
Namespace Strings String readwrite
NamespaceScope Element readonly
NextDITAConrefElementInDoc Element readonly
NextDITALinkElementInDoc Element readonly
NextDITATopicrefElementInDoc Element readonly
NextDITATopicsetrefElementInDoc Element readonly
NextDITAXrefElementInDoc Element readonly
NextElementDFS Element readonly
NextInvalidElement Element readonly
NextSiblingElement Element readonly
NumNamespaces int readonly
Object FMObject readonly
ParentElement Element readonly
PrevElementDFS Element readonly
PrevSiblingElement Element readonly
TextIsInvalidInElement int readonly
TextRange TextRange readonly
TopicRefAbsoluteFilePath string readonly
Unique int readonly
UserString string readwrite
ValidationFlags int readonly
Methods InstancesintDelete()
AttributesGetAttributes()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
voidUpdateDITAReference(objType:int)
Parameter Type Description
objType int
Elementof AFrame.ElementBook.HighestLevelElementBookComponent.ComponentElementCell.ElementCell.HighestLevelElementDoc.FirstDITAConrefElementInDocDoc.FirstDITALinkElementInDocDoc.FirstDITATopicrefElementInDocDoc.FirstDITATopicsetrefElementInDocDoc.FirstDITAXrefElementInDocElement.FirstChildElementElement.LastChildElementElement.NamespaceScopeElement.NextDITAConrefElementInDocElement.NextDITALinkElementInDocElement.NextDITATopicrefElementInDocElement.NextDITATopicsetrefElementInDocElement.NextDITAXrefElementInDocElement.NextElementDFSElement.NextInvalidElementElement.NextSiblingElementElement.ParentElementElement.PrevElementDFSElement.PrevSiblingElementElementLoc.childElementLoc.parentFlow.HighestLevelElementFn.ElementMarker.ElementRow.ElementRubi.ElementRubi.RubiElementTbl.ElementTbl.HighestLevelElementTbl.TblBodyElement
Tbl.TblElementTbl.TblFooterElementTbl.TblHeaderElementTbl.TblTitleElementVar.ElementXRef.Element
Usedin: ElementLocElementLoc.ElementLoc(parent:Element,childint)
Return ElementBook.NewBookComponentInHierarchy(compNameElementLoc)
ElementElementDef.NewElement(textLoc:TextLoc)ElementElementDef.NewElementInHierarchy(elemLoc:ElementLoc
Jongware,18-Jan-2015v1.0 Contents::Index
ElementCatalogEntries AnArrayofElementCatalogEntry
integerindexingandalengthSeealsoElementCatalogEntry
QuickLinks concat,pop,push
Properties Property Type Access
length number r/w
Methods InstancesElementCatalogEntriesconcatElementCatalogEntries)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.providedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type
value ElementCatalogEntries
ElementCatalogEntrypop()Removesthelastelementfromthearray.
numberpush(value:ElementCatalogEntryPlacesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type
value ElementCatalogEntry
Elementof Book.ElementCatalogDoc.ElementCatalogTypedVal.csval
Usedin: ElementCatalogEntriesElementCatalogEntries.concatElementCatalogEntries
Return ElementCatalogEntriesElementCatalogEntriesElementCatalogEntries
Jongware,18-Jan-2015v1.0 Contents::Index
ElementCatalogEntry
QuickLinks ElementCatalogEntry
Properties Property Type Access
flags uint readwrite
obj ElementDef readwrite
Methods ConstructorElementCatalogEntryElementCatalogEntry(obj:ElementDef,flags:uint)Parameter Type
obj ElementDef
flags uint
Example newElementCatalogEntry()
Usedin: numberElementCatalogEntries.pushElementCatalogEntry)
Return ElementCatalogEntryElementCatalogEntries.pop
ElementCatalogEntryElementCatalogEntry.ElementCatalogEntry(obj:ElementDef,flags:uint
Jongware,18-Jan-2015v1.0 Contents::Index
ElementDef
QuickLinks Delete,ElementDefIsText,GetAttributeDefs,GetPropsNewElement,NewElementInHierarchy,NewFirstPgfRulesNewLastPgfRules,NewObjectFmtRules,NewPrefixRulesNewSuffixRules,NewTextFmtRules,ObjectValid,SetPropsWrapElement
Properties Property Type Access
AlsoInsert Strings String readwrite
AlsoInserts TypedVal readwrite
AttributeDefs AttributeDefsAttributeDef
readwrite
BannerText string readwrite
Comment string readwrite
DescriptiveTag string readwrite
ElementDataType int readwrite
ElementDefType int readwrite
ElementDescription string readwrite
ElementInCatalog int readwrite
ElementPgfFormat string readwrite
Exclusions Strings String readwrite
FirstPgfRules Objects readonly
GeneralRule string readwrite
GeneralRuleErrorOffsets Ints readonly
Inclusions Strings String readwrite
InitStructurePattern string readwrite
LastPgfRules Objects readonly
Name string readonly
NextElementDefInDoc ElementDef readonly
ObjectFmtRules Objects readonly
PrefixRules Objects readonly
SuffixRules Objects readonly
TextFmtRules Objects readonly
ValidHighestLevel int readwrite
Methods InstancesintDelete()
intElementDefIsText()
AttributeDefsGetAttributeDefs()
PropValsGetProps()
ElementNewElement(textLoc:TextLoc)Parameter Type Description
textLoc TextLoc
ElementNewElementInHierarchy(elemLoc:ElementLocParameter Type Description
elemLoc ElementLoc
FmtRuleNewFirstPgfRules()
FmtRuleNewLastPgfRules()
FmtRuleNewObjectFmtRules()
FmtRuleNewPrefixRules()
FmtRuleNewSuffixRules()
FmtRuleNewTextFmtRules()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
voidWrapElement()
Elementof Book.FirstElementDefInDocDoc.FirstElementDefInDocElement.ElementDefElementCatalogEntry.objElementDef.NextElementDefInDocFmtRule.ElementDef
Usedin: ElementCatalogEntryElementCatalogEntry.ElementCatalogEntry(obj:ElementDef,flags:uint)
Return ElementDefDoc.GetNamedElementDef(name:stringElementDefDoc.NewNamedElementDef(name:string
Jongware,18-Jan-2015v1.0 Contents::Index
ElementLoc
QuickLinks ElementLoc
Properties Property Type Access Description
child Element readwrite
offset int readwrite
parent Element readwrite
Methods ConstructorElementLocElementLoc(parent:Element,child:Element,offset:int)Parameter Type Description
parent Element
child Element
offset int
Example newElementLoc()
Elementof ElementRange.begElementRange.end
Usedin: ElementBook.NewBookComponentInHierarchy(compName:string,elemLoc:ElementLoc)
BookComponentBook.NewBookComponentOfTypeInHierarchy(compName:string,compType:int,elemLoc:ElementLoc)
TextLocDoc.ElementLocToTextLoc(eloc:ElementLoc)
ElementElementDef.NewElementInHierarchy(elemLoc:ElementLoc)
ElementRangeElementRange.ElementRange(beg:ElementLoc,end:ElementLoc)
Return ElementLocDoc.TextLocToElementLoc(tloc:TextLoc)
ElementLocElementLoc.ElementLoc(parent:Element,child:Element,offset:int)
Jongware,18-Jan-2015v1.0 Contents::Index
ElementRange
QuickLinks ElementRange
Properties Property Type Access Description
beg ElementLoc readwrite
end ElementLoc readwrite
Methods ConstructorElementRangeElementRange(beg:ElementLoc,end:ElementLoc)Parameter Type Description
beg ElementLoc
end ElementLoc
Example newElementRange()
Elementof Book.ElementSelectionDoc.ElementSelection
Usedin: voidDoc.SetElementRange(propNum:int,setVal:ElementRange)
Return ElementRangeElementRange.ElementRange(beg:ElementLoc,end:ElementLoc)
Jongware,18-Jan-2015v1.0 Contents::Index
Ellipse
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
RectangleIsSmoothed int readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return EllipseDoc.NewEllipse(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
FCodes
Value Name Description
FCodes.ALT_GFX_INSET
FCodes.ALT_TXT_INSET
FCodes.AMT_DEACTIVATION
FCodes.AMT_REGISRATION
FCodes.AMT_UPDATES
FCodes.CHAR_APPLY_CAT_TO_SEL
FCodes.CHAR_APPLY_TAG
FCodes.CHAR_DESIGNKIT_APPLY
FCodes.CHAR_DESIGNKIT_NEWFORMAT
FCodes.CHAR_DESIGNKIT_RESET
FCodes.CHAR_DESIGNKIT_UPDATEALL
FCodes.CHAR_DESIGNKIT_UPDATEOPTIONS
FCodes.CHAR_DESIGN_CAT
FCodes.CMD_OPEN_DITAMAP_COMPONENT
FCodes.CONDTEXT_KIT_APPLY
FCodes.CSR_BEFORE_ELEMENT
FCodes.CSR_BOE
FCodes.CSR_BOL
FCodes.CSR_BOP
FCodes.CSR_BOS
FCodes.CSR_BOT
FCodes.CSR_BOTR
FCodes.CSR_BOW
FCodes.CSR_DOWN
FCodes.CSR_EOE
FCodes.CSR_EOL
FCodes.CSR_EOP
FCodes.CSR_EOS
FCodes.CSR_EOW
FCodes.CSR_FIRST_COL
FCodes.CSR_HOME
FCodes.CSR_INTO_CHILD
FCodes.CSR_LEFT
FCodes.CSR_NEXT_BOP
FCodes.CSR_NEXT_BOS
FCodes.CSR_NEXT_BOW
FCodes.CSR_NEXT_COL
FCodes.CSR_NEXT_ELEMENT
FCodes.CSR_PREV_ELEMENT
FCodes.CSR_PREV_EOS
FCodes.CSR_PREV_EOW
FCodes.CSR_RIGHT
FCodes.CSR_TOP
FCodes.CSR_TOTR
FCodes.CSR_UP
FCodes.DEL_BOL
FCodes.DEL_BOS
FCodes.DEL_BOW
FCodes.DEL_CHARBWD
FCodes.DEL_CHARFWD
FCodes.DEL_EOL
FCodes.DEL_EOS
FCodes.DEL_EOW
FCodes.DEL_NEXT_SS
FCodes.DEL_SEL
FCodes.DEL_WORD_END
FCodes.DEL_WORD_START
FCodes.ELEM_BAM
FCodes.ELEM_CHANGE_CAT_AT_SEL
FCodes.ELEM_INSERT_CUSTOM_1
FCodes.ELEM_INSERT_CUSTOM_10
FCodes.ELEM_INSERT_CUSTOM_2
FCodes.ELEM_INSERT_CUSTOM_3
FCodes.ELEM_INSERT_CUSTOM_4
FCodes.ELEM_INSERT_CUSTOM_5
FCodes.ELEM_INSERT_CUSTOM_6
FCodes.ELEM_INSERT_CUSTOM_7
FCodes.ELEM_INSERT_CUSTOM_8
FCodes.ELEM_INSERT_CUSTOM_9
FCodes.ELEM_INS_CAT_AT_SEL
FCodes.ELEM_WRAP_CAT_AT_SEL
FCodes.END_DIALOG
FCodes.END_WINDOW
FCodes.EXTEND_SEL
FCodes.FM_RPT_CMDS_BY_SHORTCUT
FCodes.FM_RPT_CMDS_BY_TAG
FCodes.FM_SEPARATOR
FCodes.FM_TERMINATE
FCodes.FOCUS_INPUT_ATTREDITOR
FCodes.FOCUS_INPUT_CELLFMT
FCodes.FOCUS_INPUT_COND
FCodes.FOCUS_INPUT_CUSTRS
FCodes.FOCUS_INPUT_DOC
FCodes.FOCUS_INPUT_ELEM_CTX
FCodes.FOCUS_INPUT_FONTFMT
FCodes.FOCUS_INPUT_HYPERTEXT
FCodes.FOCUS_INPUT_MARKER
FCodes.FOCUS_INPUT_PGFFMT
FCodes.FOCUS_INPUT_SEARCH
FCodes.FOCUS_INPUT_SPELL
FCodes.FOCUS_INPUT_STRWIN
FCodes.FOCUS_INPUT_TBLFMT
FCodes.FOCUS_INPUT_VALIDATION
FCodes.HIGH_CHAR
FCodes.HIGH_CHAR_NEXT
FCodes.HIGH_CHAR_PREV
FCodes.HIGH_CLEAR
FCodes.HIGH_COL_BOT
FCodes.HIGH_COL_TOP
FCodes.HIGH_ELEMENT
FCodes.HIGH_ELEMENT_NEXT
FCodes.HIGH_ELEMENT_PREV
FCodes.HIGH_FLOW
FCodes.HIGH_FLOW_BEG
FCodes.HIGH_FLOW_END
FCodes.HIGH_HYPERTEXT
FCodes.HIGH_LINE
FCodes.HIGH_LINE_BEG
FCodes.HIGH_LINE_DOWN
FCodes.HIGH_LINE_END
FCodes.HIGH_LINE_NEXT
FCodes.HIGH_LINE_PREV
FCodes.HIGH_LINE_UP
FCodes.HIGH_PARENT
FCodes.HIGH_PGF
FCodes.HIGH_PGF_NEXT
FCodes.HIGH_PGF_PREV
FCodes.HIGH_SAMECB
FCodes.HIGH_SAMECOND
FCodes.HIGH_SENT
FCodes.HIGH_SENT_NEXT
FCodes.HIGH_SENT_PREV
FCodes.HIGH_SHL
FCodes.HIGH_SHR
FCodes.HIGH_SIBLINGS
FCodes.HIGH_WORD
FCodes.HIGH_WORD_NEXT
FCodes.HIGH_WORD_PREV
FCodes.INIT_DIALOG
FCodes.INLINE_TYPEIN
FCodes.KBD_ABORT
FCodes.KBD_ABORT_DLGS
FCodes.KBD_ABOUTPRODUCT
FCodes.KBD_ACCEPTALLCHANGE
FCodes.KBD_ACCEPTCHANGE
FCodes.KBD_ACCEPTCHANGEANDNEXT
FCodes.KBD_ACROBAT_SETUP
FCodes.KBD_ACTIVATE_IN_PDF_BYDEFAULT
FCodes.KBD_ADDAUTOCORR
FCodes.KBD_ADDDOCDICT
FCodes.KBD_ADDMARKERTYPE
FCodes.KBD_ADDPAGE
FCodes.KBD_ADDUSRDICT
FCodes.KBD_ALIGN
FCodes.KBD_ALIGN_BOTTOM
FCodes.KBD_ALIGN_MIDDLE
FCodes.KBD_ALIGN_TOP
FCodes.KBD_ALLCAP
FCodes.KBD_ALLCAPH
FCodes.KBD_ALLLOWER
FCodes.KBD_ALLLOWERH
FCodes.KBD_ALLSELECT
FCodes.KBD_ANCHOR
FCodes.KBD_ANTIPUTINLINE
FCodes.KBD_API
FCodes.KBD_API_SHORTCUT
FCodes.KBD_ARCTOOL
FCodes.KBD_ASC_ADDDOCDICT
FCodes.KBD_ASC_ADDUSRDICT
FCodes.KBD_ASC_CORRECT
FCodes.KBD_ASC_ENABLE_AUTO_SPELL_CHECK
FCodes.KBD_ASSIGN_ELEMENT_ID
FCodes.KBD_ATOMIZE_INSET
FCodes.KBD_ATTRCOND
FCodes.KBD_ATTREDITQUICK
FCodes.KBD_ATTRIBUTE_EDIT
FCodes.KBD_ATTR_CONFIG_FILE_MAKER
FCodes.KBD_ATTR_DISP_OPTS
FCodes.KBD_BACK
FCodes.KBD_BACKSTACK
FCodes.KBD_BACKTAB
FCodes.KBD_BANNER_TEXT
FCodes.KBD_BODYPAGE
FCodes.KBD_BOOKADDFILE
FCodes.KBD_BOOKADDFOLDER
FCodes.KBD_BOOKADDGROUP
FCodes.KBD_BOOKCOMP_EXCLUDE
FCodes.KBD_BOOKCOMP_FILENAME
FCodes.KBD_BOOKCOMP_TEXT
FCodes.KBD_BOOKDISPLAYFILENAME
FCodes.KBD_BOOKDISPLAYTEXT
FCodes.KBD_BOOKEDITDEFINE
FCodes.KBD_BOOKRENAMEFILE
FCodes.KBD_BORDERS
FCodes.KBD_BROWSE_URL
FCodes.KBD_CACHE_STATS
FCodes.KBD_CAPITAL
FCodes.KBD_CAPTURE
FCodes.KBD_CAPTURE_LIVE_DIALOG
FCodes.KBD_CBARPRO
FCodes.KBD_CELLFMTQUICK
FCodes.KBD_CHANGEDICT
FCodes.KBD_CHANGEQUICK
FCodes.KBD_CHARFMT_DELETE
FCodes.KBD_CHARFMT_DELETE_UNUSED
FCodes.KBD_CHECKBATCH
FCodes.KBD_CHECKDOC
FCodes.KBD_CHECKPAGE
FCodes.KBD_CHECKSEL
FCodes.KBD_CLEAR
FCodes.KBD_CLEARAUTO
FCodes.KBD_CLOPWIN
FCodes.KBD_CLOSEWIN
FCodes.KBD_CLOSE_ATTREDITOR
FCodes.KBD_CLOSE_CHARACTER_CATALOG
FCodes.KBD_CLOSE_CHARACTER_DESIGNER
FCodes.KBD_CLOSE_COMPONENTS
FCodes.KBD_CLOSE_COND
FCodes.KBD_CLOSE_CUSTRS
FCodes.KBD_CLOSE_ELEMENT_CATALOG
FCodes.KBD_CLOSE_ELEM_CTX
FCodes.KBD_CLOSE_EQUATIONS_PALETTE
FCodes.KBD_CLOSE_FONTFMT
FCodes.KBD_CLOSE_HYPERTEXT
FCodes.KBD_CLOSE_MARKER
FCodes.KBD_CLOSE_PARAGRAPH_CATALOG
FCodes.KBD_CLOSE_PARAGRAPH_DESIGNER
FCodes.KBD_CLOSE_PGFFMT
FCodes.KBD_CLOSE_SEARCH
FCodes.KBD_CLOSE_SPELL
FCodes.KBD_CLOSE_STRWIN
FCodes.KBD_CLOSE_TABLE_CATALOG
FCodes.KBD_CLOSE_TABLE_DESIGNER
FCodes.KBD_CLOSE_TBLFMT
FCodes.KBD_CLOSE_TOOLS_PALETTE
FCodes.KBD_CLOSE_TOP_PALETTE
FCodes.KBD_CLOSE_VALIDATION
FCodes.KBD_CMS_CONNECTION_MGR
FCodes.KBD_CMS_UPLOAD_DOC_OR_BOOK
FCodes.KBD_COLLAPSE_ALL
FCodes.KBD_COLLAYOUT
FCodes.KBD_COLOR
FCodes.KBD_COMBINED_FONTS
FCodes.KBD_COMPARE
FCodes.KBD_COMPONENT_PROPERTIES
FCodes.KBD_CONDINDICATOR
FCodes.KBD_CONDINQUICK
FCodes.KBD_CONDNOTINQUICK
FCodes.KBD_CONDTEXT
FCodes.KBD_CONDTOGGLEOVERR
FCodes.KBD_CONDVISIBILITY
FCodes.KBD_CONDVISONLYQUICK
FCodes.KBD_CONFIGURE_TC_COLOR
FCodes.KBD_CONNECT_TEXT_FRAME
FCodes.KBD_CONSTRAIN
FCodes.KBD_CONTEXTMENU
FCodes.KBD_COPY
FCodes.KBD_COPYATTRS
FCodes.KBD_COPYCELLFMT
FCodes.KBD_COPYCOLW
FCodes.KBD_COPYCOND
FCodes.KBD_COPYFONT
FCodes.KBD_COPYPGF
FCodes.KBD_COPYRIGHT
FCodes.KBD_CORRECT
FCodes.KBD_COUNT_SBLOCKS
FCodes.KBD_CREATE_MULTIMEDIA_LINK
FCodes.KBD_CREATE_MULTIMEDIA_LINK_TBL
FCodes.KBD_CREATE_PUBLISHER
FCodes.KBD_CSHELPMODE
FCodes.KBD_CURTAIL
FCodes.KBD_CUSTOMNEW
FCodes.KBD_CUST_TEXT_FRAME
FCodes.KBD_CUT
FCodes.KBD_CUTBOTH
FCodes.KBD_CUTHEAD
FCodes.KBD_DASH0
FCodes.KBD_DASH1
FCodes.KBD_DASHOPTION
FCodes.KBD_DECDASH
FCodes.KBD_DECFILL
FCodes.KBD_DECPEN
FCodes.KBD_DECWIDTH
FCodes.KBD_DELDOCDICT
FCodes.KBD_DELETEMARKER
FCodes.KBD_DELETEPAGE
FCodes.KBD_DELETE_FILE
FCodes.KBD_DELINKHOTSPOT
FCodes.KBD_DELMARKERTYPE
FCodes.KBD_DELUSRDICT
FCodes.KBD_DEREFREF
FCodes.KBD_DFN_LIB_obsolete
FCodes.KBD_DFN_WEB_obsolete
FCodes.KBD_DISTRIBUTE
FCodes.KBD_DOCINFO
FCodes.KBD_DOC_REPORT
FCodes.KBD_DONTHYPHEN
FCodes.KBD_DOUBLE_QUOTE
FCodes.KBD_DRE_MODE_M
FCodes.KBD_DRE_MODE_W
FCodes.KBD_DRE_MODE_X
FCodes.KBD_DSEXIT
FCodes.KBD_DUMMY_FCODE
FCodes.KBD_DUMPHYPERTEXT
FCodes.KBD_ECAPTURE
FCodes.KBD_EDITHOTSPOT
FCodes.KBD_EDITLINKS
FCodes.KBD_EDITMARKERTYPE
FCodes.KBD_EDITVARIABLE
FCodes.KBD_EDIT_MATHML_EQUATION
FCodes.KBD_ELEMENTWIN
FCodes.KBD_ELEM_BORDER
FCodes.KBD_ELEM_CAT_OPTS
FCodes.KBD_ELEM_DEMOTE
FCodes.KBD_ELEM_MERGE_1ST
FCodes.KBD_ELEM_MERGE_LAST
FCodes.KBD_ELEM_PROMOTE
FCodes.KBD_ELEM_SPLIT
FCodes.KBD_ELEM_TAGS
FCodes.KBD_ELEM_TRANSPOSE_NEXT
FCodes.KBD_ELEM_TRANSPOSE_PREV
FCodes.KBD_ELEM_UNWRAP
FCodes.KBD_EMBEDDED00
FCodes.KBD_EMBEDDED01
FCodes.KBD_EMBEDDED02
FCodes.KBD_EMBEDDED03
FCodes.KBD_EMBEDDED04
FCodes.KBD_EMBEDDED05
FCodes.KBD_EMBEDDED06
FCodes.KBD_EMBEDDED07
FCodes.KBD_EMBEDDED08
FCodes.KBD_EMBEDDED09
FCodes.KBD_EMBEDDED10
FCodes.KBD_EMBEDDED11
FCodes.KBD_EMBEDDED12
FCodes.KBD_EMBEDDED13
FCodes.KBD_EMBEDDED14
FCodes.KBD_EMBEDDED15
FCodes.KBD_EMBEDDED16
FCodes.KBD_EMBEDDED17
FCodes.KBD_EMBEDDED18
FCodes.KBD_EMBEDDED19
FCodes.KBD_EMBEDDEDMAX
FCodes.KBD_EMSPACE
FCodes.KBD_ENSPACE
FCodes.KBD_EQUATION
FCodes.KBD_EVACUATE
FCodes.KBD_EXPAND_ALL
FCodes.KBD_EXPORT_DOCUMENT
FCodes.KBD_EXPORT_GRAPHIC
FCodes.KBD_EXPOSEWIN
FCodes.KBD_FB_EDIT_PREFS
FCodes.KBD_FILL0
FCodes.KBD_FILL1
FCodes.KBD_FINDNEXT
FCodes.KBD_FINDPREV
FCodes.KBD_FIRSTPAGE
FCodes.KBD_FIRSTTAB
FCodes.KBD_FLIPLR
FCodes.KBD_FLIPUD
FCodes.KBD_FMPIP
FCodes.KBD_FNEXT
FCodes.KBD_FONTDESIGN
FCodes.KBD_FONTPOD
FCodes.KBD_FONTQUICK
FCodes.KBD_FONTREPLACEPOD
FCodes.KBD_FONTWIN
FCodes.KBD_FOOTNOTE
FCodes.KBD_FOOTNOTEPRO
FCodes.KBD_FPREV
FCodes.KBD_FRAMETOOL
FCodes.KBD_FREETOOL
FCodes.KBD_FREEZE
FCodes.KBD_FRONT
FCodes.KBD_FULLRULERS
FCodes.KBD_GBL_END
FCodes.KBD_GBL_START
FCodes.KBD_GENERATE
FCodes.KBD_GETTRIGGER
FCodes.KBD_GOTOIP
FCodes.KBD_GOTOLINEN
FCodes.KBD_GOTOPAGE
FCodes.KBD_GOTOPAGEN
FCodes.KBD_GRAPHIC_SET_NAME
FCodes.KBD_GRAVITY
FCodes.KBD_GRAVITY_0
FCodes.KBD_GRAVITY_1
FCodes.KBD_GRID
FCodes.KBD_GROUP
FCodes.KBD_HARDHYPHEN
FCodes.KBD_HARDRETURN
FCodes.KBD_HARDSPACE
FCodes.KBD_HEATREF
FCodes.KBD_HELP
FCodes.KBD_HELP_INDEX
FCodes.KBD_HELP_KEYS
FCodes.KBD_HELP_ONLINEMANUALS
FCodes.KBD_HELP_OVERVIEW
FCodes.KBD_HELP_SAMPLES
FCodes.KBD_HELP_WEBWORKS
FCodes.KBD_HEROIC_OPEN
FCodes.KBD_HIDEWIN
FCodes.KBD_HIDE_BORDERS
FCodes.KBD_HIDE_COND_IND
FCodes.KBD_HIDE_ELEM_BORDER
FCodes.KBD_HIDE_GRAPHICS
FCodes.KBD_HIDE_GRID
FCodes.KBD_HIDE_HOTSPOTINDICATORS
FCodes.KBD_HIDE_LINK_BOUNDARIES
FCodes.KBD_HIDE_RULERS
FCodes.KBD_HIDE_SYMBOLS
FCodes.KBD_HISHWIN
FCodes.KBD_HIST
FCodes.KBD_HOTSPOT
FCodes.KBD_HOTSPOTINDICATORS
FCodes.KBD_HOTSPOTSPOD
FCodes.KBD_HSCROLL
FCodes.KBD_HYPERTEXT
FCodes.KBD_HYPHENATE
FCodes.KBD_HYPRTXT_SHTCUT
FCodes.KBD_IMPORT
FCodes.KBD_INCDASH
FCodes.KBD_INCFILL
FCodes.KBD_INCPEN
FCodes.KBD_INCWIDTH
FCodes.KBD_INDEX_AUTHOR
FCodes.KBD_INDEX_MARKER
FCodes.KBD_INDEX_REFERENCES
FCodes.KBD_INDEX_STANDARD
FCodes.KBD_INDEX_SUBJECT
FCodes.KBD_INFO
FCodes.KBD_INITCAP
FCodes.KBD_INITCAPH
FCodes.KBD_INLINE_ATTREDTR
FCodes.KBD_INPUT
FCodes.KBD_INSERTOBJECT
FCodes.KBD_INSERTQUICK
FCodes.KBD_INSET
FCodes.KBD_INSETPOD
FCodes.KBD_Item1stLogical
FCodes.KBD_ItemDown
FCodes.KBD_ItemFirstFocus
FCodes.KBD_ItemLeft
FCodes.KBD_ItemNextLogical
FCodes.KBD_ItemNextPhysical
FCodes.KBD_ItemPrevLogical
FCodes.KBD_ItemPrevPhysical
FCodes.KBD_ItemRight
FCodes.KBD_ItemSelect
FCodes.KBD_ItemUp
FCodes.KBD_JOINCURVES
FCodes.KBD_KBMACRO
FCodes.KBD_KEEPTOOL
FCodes.KBD_KERNDOWN
FCodes.KBD_KERNDOWN6
FCodes.KBD_KERNHOME
FCodes.KBD_KERNLEFT
FCodes.KBD_KERNLEFT6
FCodes.KBD_KERNRIGHT
FCodes.KBD_KERNRIGHT6
FCodes.KBD_KERNUP
FCodes.KBD_KERNUP6
FCodes.KBD_LASTPAGE
FCodes.KBD_LASTTOOL
FCodes.KBD_LGEQN
FCodes.KBD_LINELAYOUT
FCodes.KBD_LINENUMPRO
FCodes.KBD_LINENUMTOGGLE
FCodes.KBD_LINETOOL
FCodes.KBD_LINK_BOUNDARIES
FCodes.KBD_LIST_FIGURE
FCodes.KBD_LIST_MARKER
FCodes.KBD_LIST_MARKER_ALPHA
FCodes.KBD_LIST_PGF
FCodes.KBD_LIST_PGF_ALPHA
FCodes.KBD_LIST_REFERENCES
FCodes.KBD_LIST_TABLE
FCodes.KBD_MANCOND
FCodes.KBD_MARKERS
FCodes.KBD_MARKERSPOD
FCodes.KBD_MASTERPAGE
FCodes.KBD_MATHML_EQUATION
FCodes.KBD_MATHWIN
FCodes.KBD_MATH_BASE
FCodes.KBD_MAXIMIZE
FCodes.KBD_MEDEQN
FCodes.KBD_MEMFAIL
FCodes.KBD_MEM_STATS
FCodes.KBD_MENUBARFOCUS
FCodes.KBD_MENUCOMPLETE
FCodes.KBD_MENUCUSTOM
FCodes.KBD_MENUMODIFY
FCodes.KBD_MENUQUICK
FCodes.KBD_MENURESET
FCodes.KBD_MINIMIZE
FCodes.KBD_MODE_ROTATE_TOOL
FCodes.KBD_MOVEWIN
FCodes.KBD_MOVE_DOWN
FCodes.KBD_MOVE_LEFT
FCodes.KBD_MOVE_RIGHT
FCodes.KBD_MOVE_UP
FCodes.KBD_MUTATE
FCodes.KBD_NAMESPACES
FCodes.KBD_NEW
FCodes.KBD_NEWAFRAME
FCodes.KBD_NEWBOOK
FCodes.KBD_NEWHYPERTEXT
FCodes.KBD_NEWMARKER
FCodes.KBD_NEWMASTER
FCodes.KBD_NEWVAR
FCodes.KBD_NEW_XML
FCodes.KBD_NEXTPAGE
FCodes.KBD_NOCHANGEDB
FCodes.KBD_NORMALIZE_TAGS
FCodes.KBD_NUMBERING
FCodes.KBD_NUMLOCK
FCodes.KBD_NUMSPACE
FCodes.KBD_OBALIGN_BOTTOM
FCodes.KBD_OBALIGN_CENTER
FCodes.KBD_OBALIGN_LEFT
FCodes.KBD_OBALIGN_MIDDLE
FCodes.KBD_OBALIGN_RIGHT
FCodes.KBD_OBALIGN_TOP
FCodes.KBD_OBJDOWN
FCodes.KBD_OBJLEFT
FCodes.KBD_OBJPROPS
FCodes.KBD_OBJRIGHT
FCodes.KBD_OBJSELECT
FCodes.KBD_OBJSELECT_NOPREF
FCodes.KBD_OBJUP
FCodes.KBD_OPEN
FCodes.KBD_OPENALL
FCodes.KBD_OPENLINE
FCodes.KBD_OPENWIN
FCodes.KBD_OPEN_COMPONENTS
FCodes.KBD_OPEN_IN_POPUP_WIN_IN_PDF
FCodes.KBD_OPEN_REPOSITORY
FCodes.KBD_OPTIONS
FCodes.KBD_OVALTOOL
FCodes.KBD_OVERPRINT
FCodes.KBD_OVERPRINT_NONE
FCodes.KBD_PAGEBACK
FCodes.KBD_PAGEBREAK
FCodes.KBD_PAGELAYOUT
FCodes.KBD_PAGESETUP
FCodes.KBD_PAGESIZE
FCodes.KBD_PAGESTATUS
FCodes.KBD_PAGEUPDATE
FCodes.KBD_PAGINATION
FCodes.KBD_PASTE
FCodes.KBD_PASTESPECIAL
FCodes.KBD_PASTE_RTF
FCodes.KBD_PAUSE_0x01
FCodes.KBD_PAUSE_0x10
FCodes.KBD_PAUSE_1x00
FCodes.KBD_PEN0
FCodes.KBD_PEN1
FCodes.KBD_PGFDESIGN
FCodes.KBD_PGFFMT_DELETE
FCodes.KBD_PGFFMT_DELETE_UNUSED
FCodes.KBD_PGFQUICK
FCodes.KBD_PGFWIN
FCodes.KBD_PICKOBJPROPS
FCodes.KBD_PODLOCATION
FCodes.KBD_POLYGTOOL
FCodes.KBD_POLYLTOOL
FCodes.KBD_POPUP_MENU
FCodes.KBD_PREVIEWFBA
FCodes.KBD_PREVIEW_ACCEPTALL
FCodes.KBD_PREVIEW_OFF
FCodes.KBD_PREVIEW_REJECTALL
FCodes.KBD_PREVPAGE
FCodes.KBD_PRINT
FCodes.KBD_PRINTSETUP
FCodes.KBD_PRINT_COMPONENTS
FCodes.KBD_PURIFY_ALL_LEAKS
FCodes.KBD_PURIFY_CLEAR_LEAKS
FCodes.KBD_PURIFY_NEW_LEAKS
FCodes.KBD_PUTINLINE
FCodes.KBD_QUIETCLOSEWIN
FCodes.KBD_QUITALL
FCodes.KBD_QUITWIN
FCodes.KBD_RANDF
FCodes.KBD_RECORD
FCodes.KBD_RECTTOOL
FCodes.KBD_REDO
FCodes.KBD_REFERENCE
FCodes.KBD_REFORMATDOC
FCodes.KBD_REFPAGE
FCodes.KBD_REFRESHWIN
FCodes.KBD_REFRESH_DITAMAP_RMVIEW
FCodes.KBD_REJECTALLCHANGE
FCodes.KBD_REJECTCHANGE
FCodes.KBD_REJECTCHANGEANDNEXT
FCodes.KBD_REMOVEPOSTER
FCodes.KBD_REMOVE_STRUCT
FCodes.KBD_RENAMEFRAME
FCodes.KBD_RENAMEMARKERTYPE
FCodes.KBD_RENAMEORPLAIN
FCodes.KBD_RENAMEPAGE
FCodes.KBD_REORDERMASTER
FCodes.KBD_REPEAT
FCodes.KBD_REPEATNEW
FCodes.KBD_REROTATE
FCodes.KBD_RESETDB
FCodes.KBD_RESHAPE
FCodes.KBD_RESIZEBOX
FCodes.KBD_RESIZEBOXM
FCodes.KBD_RESIZELOCK
FCodes.KBD_RESIZEUNLOCK
FCodes.KBD_RESTORE
FCodes.KBD_RESTOREFONT
FCodes.KBD_RESTORE_SESSION
FCodes.KBD_RETURN
FCodes.KBD_REVERT
FCodes.KBD_REWRAP_INLINE_MATH
FCodes.KBD_RGLOBAL
FCodes.KBD_RM_MODE
FCodes.KBD_RONCE
FCodes.KBD_ROTATE
FCodes.KBD_ROTATE_AGAIN
FCodes.KBD_ROTATE_CCW
FCodes.KBD_ROTATE_CCW_SMALL
FCodes.KBD_ROTATE_CW
FCodes.KBD_ROTATE_CW_SMALL
FCodes.KBD_ROTATE_NATURAL
FCodes.KBD_ROTATE_RESET0
FCodes.KBD_ROTPAGE_MINUS
FCodes.KBD_ROTPAGE_NORM
FCodes.KBD_ROTPAGE_PLUS
FCodes.KBD_ROT_MINUS
FCodes.KBD_ROT_PLUS
FCodes.KBD_ROUNDRECT
FCodes.KBD_RUBIPROPS
FCodes.KBD_RULERS
FCodes.KBD_RUN_BBOX
FCodes.KBD_RUN_CONTOUR
FCodes.KBD_RUN_GAP
FCodes.KBD_RUN_OFF
FCodes.KBD_RUN_PROPS
FCodes.KBD_SAVE
FCodes.KBD_SAVEALL
FCodes.KBD_SAVEAS
FCodes.KBD_SAVEASDBRE
FCodes.KBD_SAVEASPDF
FCodes.KBD_SAVEASPDFREVIEW
FCodes.KBD_SAVEASPDFREVIEW2
FCodes.KBD_SAVEASPDFSHARE
FCodes.KBD_SAVEASPDFUBIQ
FCodes.KBD_SAVEASXML
FCodes.KBD_SAVEDBRE
FCodes.KBD_SAVEFMX
FCodes.KBD_SAVEMETA
FCodes.KBD_SAVESAS
FCodes.KBD_SAVE_COMPONENTS
FCodes.KBD_SCALE
FCodes.KBD_SCREENMODE_FULLSCREEN
FCodes.KBD_SCREENMODE_FULLSCREEN_UI
FCodes.KBD_SCREENMODE_STANDARD
FCodes.KBD_SCREENMODE_TOGGLE
FCodes.KBD_SEARCH
FCodes.KBD_SEARCHREFS
FCodes.KBD_SELECTALL
FCodes.KBD_SELECT_CHAPTER_COMPONENTS
FCodes.KBD_SELECT_EXCLUDED_FILE
FCodes.KBD_SELECT_FM_FILES
FCodes.KBD_SELECT_FM_XMLAUTHOR_FILES
FCodes.KBD_SELECT_GENERATED_FILES
FCodes.KBD_SELECT_NONEXCLUDED_FILE
FCodes.KBD_SELECT_NON_GENERATED_FILES
FCodes.KBD_SELECT_PRINTABLE_FILES
FCodes.KBD_SELECT_SECTION_COMPONENTS
FCodes.KBD_SELECT_SUBSECTION_COMPONENTS
FCodes.KBD_SEPARATIONS
FCodes.KBD_SESSION
FCodes.KBD_SETALIGN_PROPS
FCodes.KBD_SETCAP
FCodes.KBD_SETCAP_0
FCodes.KBD_SETCAP_1
FCodes.KBD_SETCAP_2
FCodes.KBD_SETCAP_3
FCodes.KBD_SETCAP_OPTION
FCodes.KBD_SETDASH
FCodes.KBD_SETDASH_0
FCodes.KBD_SETDASH_1
FCodes.KBD_SETDASH_2
FCodes.KBD_SETDASH_3
FCodes.KBD_SETDASH_4
FCodes.KBD_SETDASH_5
FCodes.KBD_SETDASH_6
FCodes.KBD_SETDASH_7
FCodes.KBD_SETDASH_8
FCodes.KBD_SETDASH_OPTION
FCodes.KBD_SETDISTRIBUTE_PROPS
FCodes.KBD_SETELCATALL
FCodes.KBD_SETELCATCHILD
FCodes.KBD_SETELCATFREQ
FCodes.KBD_SETELCATLOOSE
FCodes.KBD_SETELCATSTRICT
FCodes.KBD_SETFILL
FCodes.KBD_SETFILL_0
FCodes.KBD_SETFILL_1
FCodes.KBD_SETFILL_2
FCodes.KBD_SETFILL_3
FCodes.KBD_SETFILL_4
FCodes.KBD_SETFILL_5
FCodes.KBD_SETFILL_6
FCodes.KBD_SETFILL_7
FCodes.KBD_SETFILL_8
FCodes.KBD_SETFILL_9
FCodes.KBD_SETFILL_A
FCodes.KBD_SETFILL_B
FCodes.KBD_SETFILL_C
FCodes.KBD_SETFILL_D
FCodes.KBD_SETFILL_E
FCodes.KBD_SETFILL_F
FCodes.KBD_SETFROMCOLOR
FCodes.KBD_SETKNOCKOUT
FCodes.KBD_SETOVERPRINT
FCodes.KBD_SETPEN
FCodes.KBD_SETPEN_0
FCodes.KBD_SETPEN_1
FCodes.KBD_SETPEN_2
FCodes.KBD_SETPEN_3
FCodes.KBD_SETPEN_4
FCodes.KBD_SETPEN_5
FCodes.KBD_SETPEN_6
FCodes.KBD_SETPEN_7
FCodes.KBD_SETPEN_8
FCodes.KBD_SETPEN_9
FCodes.KBD_SETPEN_A
FCodes.KBD_SETPEN_B
FCodes.KBD_SETPEN_C
FCodes.KBD_SETPEN_D
FCodes.KBD_SETPEN_E
FCodes.KBD_SETPEN_F
FCodes.KBD_SETPOSTER
FCodes.KBD_SETRUN_PROPS
FCodes.KBD_SETSEARCH
FCodes.KBD_SETSEP
FCodes.KBD_SETSEP_ALL
FCodes.KBD_SETSEP_KEEP
FCodes.KBD_SETSEP_RESET_TINT_OVERPRINT
FCodes.KBD_SETSIDES
FCodes.KBD_SETSOLID
FCodes.KBD_SETTINT
FCodes.KBD_SETWIDTH
FCodes.KBD_SETWIDTH_0
FCodes.KBD_SETWIDTH_1
FCodes.KBD_SETWIDTH_2
FCodes.KBD_SETWIDTH_3
FCodes.KBD_SETWIDTH_OPTION
FCodes.KBD_SETWIDTH_SLIDE
FCodes.KBD_SET_TEXTFRAME_GRID
FCodes.KBD_SHFTSPACE
FCodes.KBD_SHOWFILELISTPOD
FCodes.KBD_SHOWNEXT
FCodes.KBD_SHOWPREV
FCodes.KBD_SHOW_BORDERS
FCodes.KBD_SHOW_COND_IND
FCodes.KBD_SHOW_ELEM_BORDER
FCodes.KBD_SHOW_ELEM_CTX
FCodes.KBD_SHOW_ELEM_TAGS
FCodes.KBD_SHOW_GRAPHICS
FCodes.KBD_SHOW_GRID
FCodes.KBD_SHOW_HOTSPOTINDICATORS
FCodes.KBD_SHOW_LINK_BOUNDARIES
FCodes.KBD_SHOW_RULERS
FCodes.KBD_SHOW_SYMBOLS
FCodes.KBD_SILENT_OPEN
FCodes.KBD_SINGLE_QUOTE
FCodes.KBD_SLOW_0x00
FCodes.KBD_SLOW_0x01
FCodes.KBD_SLOW_0x10
FCodes.KBD_SLOW_1x00
FCodes.KBD_SMALLTOOLWIN
FCodes.KBD_SMEQN
FCodes.KBD_SMOOTH
FCodes.KBD_SNAP
FCodes.KBD_SNAP_0
FCodes.KBD_SNAP_1
FCodes.KBD_SOFTHYPHEN
FCodes.KBD_SPELLING
FCodes.KBD_SPELLRESET
FCodes.KBD_SPLIT
FCodes.KBD_SPLITL
FCodes.KBD_SPLITR
FCodes.KBD_SPOPTIONS
FCodes.KBD_STRIP_FLOWSTRUCTURE
FCodes.KBD_STRWIN
FCodes.KBD_STRWIN_LEFTANCHOR
FCodes.KBD_STUFF
FCodes.KBD_STUFF_ITEM
FCodes.KBD_STYLEFMT_DELETE
FCodes.KBD_STYLEFMT_DELETE_UNUSED
FCodes.KBD_STYLEQUICK
FCodes.KBD_STYLE_CATALOG
FCodes.KBD_STYLE_DESIGNER
FCodes.KBD_SUBSCRIBE_TO
FCodes.KBD_SWAP_RED_BLUE
FCodes.KBD_SYMBOLS
FCodes.KBD_SYMFONT
FCodes.KBD_TAB
FCodes.KBD_TABLEWIN
FCodes.KBD_TABLE_ADDRC
FCodes.KBD_TABLE_CELLFMT
FCodes.KBD_TABLE_CONVERT
FCodes.KBD_TABLE_CUSTRS
FCodes.KBD_TABLE_DEBUG
FCodes.KBD_TABLE_EXIT_IP
FCodes.KBD_TABLE_FORMAT
FCodes.KBD_TABLE_INS
FCodes.KBD_TABLE_RESIZECOL
FCodes.KBD_TABLE_ROWFMT
FCodes.KBD_TABLE_RULES
FCodes.KBD_TABLE_STRADDLE
FCodes.KBD_TABLE_TAB
FCodes.KBD_TABLE_VARS
FCodes.KBD_TAB_CENTER
FCodes.KBD_TAB_DECIMAL
FCodes.KBD_TAB_LEFT
FCodes.KBD_TAB_RIGHT
FCodes.KBD_TAGSTATUS
FCodes.KBD_TBLFMT_DELETE
FCodes.KBD_TBLFMT_DELETE_UNUSED
FCodes.KBD_TBLIP_ABOVE
FCodes.KBD_TBLIP_BELOW
FCodes.KBD_TBLIP_BOTTOM
FCodes.KBD_TBLIP_LEFT
FCodes.KBD_TBLIP_LEFTMOST
FCodes.KBD_TBLIP_NEXT
FCodes.KBD_TBLIP_PREV
FCodes.KBD_TBLIP_RIGHT
FCodes.KBD_TBLIP_RIGHTMOST
FCodes.KBD_TBLIP_TOP
FCodes.KBD_TBLIP_TOPLEFT
FCodes.KBD_TBLSEL_CELL
FCodes.KBD_TBLSEL_CELLTEXT
FCodes.KBD_TBLSEL_COL
FCodes.KBD_TBLSEL_COLBODY
FCodes.KBD_TBLSEL_ROW
FCodes.KBD_TBLSEL_TABLE
FCodes.KBD_TBL_DLG_ADD_ABOVE
FCodes.KBD_TBL_DLG_ADD_BELOW
FCodes.KBD_TBL_DLG_ADD_LEFT
FCodes.KBD_TBL_DLG_ADD_RIGHT
FCodes.KBD_TBL_DLG_CLEAR_EMPTY
FCodes.KBD_TBL_DLG_CLEAR_X
FCodes.KBD_TBL_DLG_PASTE_AFTER
FCodes.KBD_TBL_DLG_PASTE_BEFORE
FCodes.KBD_TBL_DLG_PASTE_REPL
FCodes.KBD_TBL_DLG_SHRINKWRAP
FCodes.KBD_TBL_DLG_UNIFY_CF
FCodes.KBD_TBL_DLG_UNIFY_TF
FCodes.KBD_TC_SEARCH_BOOK
FCodes.KBD_TC_SEARCH_DITAMAP
FCodes.KBD_TC_SEARCH_DOC
FCodes.KBD_TC_SEARCH_SEL
FCodes.KBD_TC_USER_NAME
FCodes.KBD_TEST_MODAL
FCodes.KBD_TEST_MODELESS
FCodes.KBD_TEST_PRINTDBRE
FCodes.KBD_TEXTCOLPRO
FCodes.KBD_TEXTLTOOL
FCodes.KBD_TEXTRTOOL
FCodes.KBD_TEXT_OPTIONS
FCodes.KBD_THESAURUS
FCodes.KBD_THESAURUS_REPLACE
FCodes.KBD_THINSPACE
FCodes.KBD_TOC
FCodes.KBD_TOGGLEDRAW
FCodes.KBD_TOGGLE_COLLAPSE
FCodes.KBD_TOGGLE_COLLAPSE_ALL
FCodes.KBD_TOGGLE_COLLAPSE_CHILDREN
FCodes.KBD_TOGGLE_INCLUSION
FCodes.KBD_TOGGLE_STRUCT_AND_DOCWIN
FCodes.KBD_TOOLBAR_BASE
FCodes.KBD_TOOLBAR_HIDEALL
FCodes.KBD_TOOLBAR_SHOWALL
FCodes.KBD_TOOLWIN
FCodes.KBD_TRACKCHANGE
FCodes.KBD_TRACKCHANGEDISABLE
FCodes.KBD_UIALERTSTRINGS_PREF
FCodes.KBD_UI_PREFERENCE
FCodes.KBD_UNCOND
FCodes.KBD_UNDO
FCodes.KBD_UNGROUP
FCodes.KBD_UNSMOOTH
FCodes.KBD_UPDATEREF
FCodes.KBD_UPSTACK
FCodes.KBD_USEELTDEFSFROM
FCodes.KBD_USEFMTFROM
FCodes.KBD_VALIDATEFILE
FCodes.KBD_VALIDATE_HYPERTEXT
FCodes.KBD_VALIDATION
FCodes.KBD_VAL_ALLOW
FCodes.KBD_VAL_CLEAR
FCodes.KBD_VAL_DOC
FCodes.KBD_VAL_ELEM
FCodes.KBD_VAL_FLOW
FCodes.KBD_VAL_IGNORE
FCodes.KBD_VAL_IGNORE_ATTR
FCodes.KBD_VAL_START
FCodes.KBD_VARCURDATE
FCodes.KBD_VARCURPG
FCodes.KBD_VARIABLE
FCodes.KBD_VAROTHER
FCodes.KBD_VARPGCOUNT
FCodes.KBD_VARQUICK
FCodes.KBD_VERIFYCONTEXT
FCodes.KBD_VIEWER
FCodes.KBD_VIEWER_MAKE_DOCUMENT
FCodes.KBD_VIEWER_MAKE_MODELESSDIALOG
FCodes.KBD_VIEWER_MAKE_PALETTE
FCodes.KBD_VIEWSEP1
FCodes.KBD_VIEWSEP2
FCodes.KBD_VIEWSEP3
FCodes.KBD_VIEWSEP4
FCodes.KBD_VIEWSEP5
FCodes.KBD_VIEWSEP6
FCodes.KBD_VIEW_API
FCodes.KBD_VIEW_API_SHORTCUT
FCodes.KBD_VIEW_SWITCH
FCodes.KBD_VSCROLL
FCodes.KBD_WAIT_DLGS
FCodes.KBD_WIDTH0
FCodes.KBD_WIDTH1
FCodes.KBD_WINDOWFULL_DOWN
FCodes.KBD_WINDOWFULL_UP
FCodes.KBD_WIN_CASCADE
FCodes.KBD_WIN_TILE
FCodes.KBD_WRAPQUICK
FCodes.KBD_XCHARS
FCodes.KBD_XREFSPOD
FCodes.KBD_XYZZQ
FCodes.KBD_XYZZY
FCodes.KBD_XYZZZ
FCodes.KBD_YANK
FCodes.KBD_ZOOM
FCodes.KBD_ZOOM100
FCodes.KBD_ZOOMIN
FCodes.KBD_ZOOMOUT
FCodes.KBD_ZOOM_AUTOFIT_AFTER_ZOOM
FCodes.KBD_ZOOM_FIT_PAGE
FCodes.KBD_ZOOM_FIT_TEXTFRAME
FCodes.KBD_ZOOM_FIT_WINDOW
FCodes.KBD_ZOOM_SET
FCodes.LEAVE_DOC
FCodes.MENU_BARSTART
FCodes.MENU_DONE
FCodes.MENU_DOWN
FCodes.MENU_DOWNWAIT
FCodes.MENU_EXPOSE_WIN
FCodes.MENU_HYPERTEXT
FCodes.MENU_IMPORT_FILE
FCodes.MENU_RIGHT
FCodes.MENU_RIGHTWAIT
FCodes.MENU_WAITBIT
FCodes.MIF_SAVE_AFMS
FCodes.MIF_SAVE_BANNERTEXT
FCodes.MIF_SAVE_CCAT
FCodes.MIF_SAVE_COLORCAT
FCodes.MIF_SAVE_DATALINKS
FCodes.MIF_SAVE_DICT
FCodes.MIF_SAVE_ECAT
FCodes.MIF_SAVE_ELEMENTS
FCodes.MIF_SAVE_FCAT
FCodes.MIF_SAVE_FMTS
FCodes.MIF_SAVE_FONTS
FCodes.MIF_SAVE_FPLCAT
FCodes.MIF_SAVE_LAYT
FCodes.MIF_SAVE_MKRS
FCodes.MIF_SAVE_MPAGE
FCodes.MIF_SAVE_PCAT
FCodes.MIF_SAVE_RUBIS
FCodes.MIF_SAVE_TABLECATS
FCodes.MIF_SAVE_TABLES
FCodes.MIF_SAVE_TAGS
FCodes.MIF_SAVE_TEXT
FCodes.MIF_SAVE_TEXTINSETS
FCodes.MIF_SAVE_TMPLT
FCodes.MIF_SAVE_VARS
FCodes.MIF_SAVE_VIEWSET
FCodes.MRU_SELECT_FILE
FCodes.NULLINPUT
FCodes.OBJ_SEL_EXTEND_NEXT
FCodes.OBJ_SEL_FIRST
FCodes.OBJ_SEL_LAST
FCodes.OBJ_SEL_NEXT
FCodes.OBJ_SEL_NEXT_WRAP
FCodes.OBJ_SEL_PREV
FCodes.OBJ_SEL_PREV_WRAP
FCodes.OPEN_MRU_FILES
FCodes.PGF_ANYPLACE
FCodes.PGF_APPLY_CAT_TO_SEL
FCodes.PGF_APPLY_TAG
FCodes.PGF_BAM
FCodes.PGF_CENTER
FCodes.PGF_COLTOP
FCodes.PGF_DECLINE
FCodes.PGF_DESIGNKIT_APPLY
FCodes.PGF_DESIGNKIT_NEWFORMAT
FCodes.PGF_DESIGNKIT_RESET
FCodes.PGF_DESIGNKIT_UPDATEALL
FCodes.PGF_DESIGNKIT_UPDATEOPTIONS
FCodes.PGF_DESIGN_CAT
FCodes.PGF_DOUBLE_SPACE
FCodes.PGF_FULL
FCodes.PGF_HYPHENOFF
FCodes.PGF_HYPHENON
FCodes.PGF_INCLINE
FCodes.PGF_KBD_BODYSTRADDLE
FCodes.PGF_KBD_FULLSTRADDLE
FCodes.PGF_KBD_RUN_IN
FCodes.PGF_KBD_SIDEBODY
FCodes.PGF_KBD_SIDEHEAD_FIRST_BASELINE
FCodes.PGF_KBD_SIDEHEAD_LAST_BASELINE
FCodes.PGF_KBD_SIDEHEAD_TOP
FCodes.PGF_LEFT
FCodes.PGF_LEFTTOP
FCodes.PGF_LINEFIX
FCodes.PGF_LINEFLOAT
FCodes.PGF_LINE_SPACE
FCodes.PGF_NEW_FORMAT
FCodes.PGF_ONEANDAHALF_SPACE
FCodes.PGF_PAGETOP
FCodes.PGF_RIGHT
FCodes.PGF_RIGHTTOP
FCodes.PGF_SINGLE_SPACE
FCodes.PGF_SPACE_BETWEEN
FCodes.PGF_UNIFY
FCodes.PGF_UPDATE_ALL
FCodes.SEARCH_CB
FCodes.SEARCH_CBOVERRIDE
FCodes.SEARCH_CBTAG
FCodes.SEARCH_COND
FCodes.SERVER_CANCEL
FCodes.SERVER_QUERY
FCodes.START_DIALOG
FCodes.START_WINDOW
FCodes.STYLE_APPLY_CAT_TO_SEL
FCodes.SUPPRESS_INSETS
FCodes.SWITCH_TO_DOCUMENTVIEW
FCodes.SWITCH_TO_RESOURCEMANAGER
FCodes.SW_CSR_DOWN
FCodes.SW_CSR_LEFT
FCodes.SW_CSR_RIGHT
FCodes.SW_CSR_UP
FCodes.TBL_APPLY_CAT_TO_SEL
FCodes.TBL_APPLY_TAG
FCodes.TBL_DESIGNKIT_APPLY
FCodes.TBL_DESIGNKIT_NEWFORMAT
FCodes.TBL_DESIGNKIT_RESET
FCodes.TBL_DESIGNKIT_UPDATEALL
FCodes.TBL_DESIGNKIT_UPDATEOPTIONS
FCodes.TBL_DESIGN_CAT
FCodes.TEXTSEL_DRAGGING
FCodes.TEXTSEL_ELEMENT
FCodes.TEXTSEL_EXTEND
FCodes.TEXTSEL_EXTEND_ELEMENT
FCodes.TEXTSEL_EXTEND_LINE
FCodes.TEXTSEL_EXTEND_PGF
FCodes.TEXTSEL_EXTEND_SENT
FCodes.TEXTSEL_EXTEND_WORD
FCodes.TEXTSEL_LINE
FCodes.TEXTSEL_PGF
FCodes.TEXTSEL_QUICK_COPY
FCodes.TEXTSEL_SELECT_ONLY
FCodes.TEXTSEL_SENT
FCodes.TEXTSEL_WORD
FCodes.TEXT_INSET_PROPS
FCodes.TOGGLE_FLUID_VIEW
FCodes.TXT_10
FCodes.TXT_12
FCodes.TXT_14
FCodes.TXT_18
FCodes.TXT_24
FCodes.TXT_7
FCodes.TXT_9
FCodes.TXT_BAM
FCodes.TXT_BOLD
FCodes.TXT_CHANGEBAR
FCodes.TXT_DBLUNDERLINE
FCodes.TXT_DECSIZE
FCodes.TXT_DEFAULT
FCodes.TXT_FAMILY_AND_VARIATION
FCodes.TXT_FAMILY_AND_VARIATION_PLATFORM
FCodes.TXT_FONT
FCodes.TXT_INCSIZE
FCodes.TXT_INITCAPS
FCodes.TXT_ITALIC
FCodes.TXT_KERN
FCodes.TXT_LESSSTRETCH
FCodes.TXT_LOWERCASE
FCodes.TXT_MINICAPS
FCodes.TXT_MORESTRETCH
FCodes.TXT_NORMAL
FCodes.TXT_NORMALCASE
FCodes.TXT_NOSTRETCH
FCodes.TXT_NUMUNDERLINE
FCodes.TXT_OTHERSIZE
FCodes.TXT_OUTLINE
FCodes.TXT_OVERLINE
FCodes.TXT_PLAIN
FCodes.TXT_SELBOLD
FCodes.TXT_SELDECSIZE
FCodes.TXT_SELINCSIZE
FCodes.TXT_SELITALIC
FCodes.TXT_SELPLAIN
FCodes.TXT_SELUNDERLINE
FCodes.TXT_SHADOW
FCodes.TXT_SPREAD
FCodes.TXT_SQUEEZE
FCodes.TXT_STRIKEOUT
FCodes.TXT_SUB
FCodes.TXT_SUPER
FCodes.TXT_TSUME
FCodes.TXT_UNDERLINE
FCodes.TXT_UPPERCASE
FCodes.TXT_USIZE
FCodes.TYPEIN
FCodes.UPDATE_INSETS
FCodes.WEB_ADOBEHELP
FCodes.WEB_ADOBE_BOOKMARKS
FCodes.WEB_CORPORATENEWS
FCodes.WEB_FRAME_BOOKMARKS
FCodes.WEB_GOTOADOBE
FCodes.WEB_PREFERENCES
FCodes.WEB_REGISTRATION
FCodes.WEB_TOPISSUES
Usage
Jongware,18-Jan-2015v1.0 Contents::Index
FilterArgs
QuickLinks FilterArgs
Properties Property Type Access Description
args Strings String readwrite
binname string readwrite
clname string readwrite
infile string readwrite
informat string readwrite
outfile string readwrite
outformat string readwrite
Methods ConstructorFilterArgsFilterArgs(infile:string,outfile:string,clname:string,informat:string,outformat:string,binname:string,args:Strings)Parameter Type Description
infile string
outfile string
clname string
informat string
outformat string
binname string
args Strings
Example newFilterArgs()
Return FilterArgsFilterArgs.FilterArgs(infile:string,outfile:string,clname:string,informat:string,outformat:string,binname:string,args:Strings)
Jongware,18-Jan-2015v1.0 Contents::Index
Flow
QuickLinks Delete,GetProps,GetText,ObjectValid,SetProps
Properties Property Type Access Description
FirstTextFrameInFlow TextFrame readonly
FlowIsAutoConnect int readwrite
FlowIsFeathered int readwrite
FlowIsPostScript int readwrite
FlowIsSynchronized int readwrite
HighestLevelElement Element readonly
LastTextFrameInFlow TextFrame readonly
MaxInterPgfPadding int readwrite
MaxInterlinePadding int readwrite
MinHang int readwrite
Name string readwrite
NextFlowInDoc Flow readonly
SideHeadRoomInFlow int readwrite
Spacing int readwrite
UserString string readwrite
Methods InstancesintDelete()
PropValsGetProps()
TextItemsGetText(flags:int)
Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.DocFluidFlowDoc.FirstFlowInDocDoc.MainFlowInDocFlow.NextFlowInDocTextFrame.Flow
Return FlowDoc.NewFlow(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
FmtChangeList
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type
AdjHyphens int
AutoNumChar string
AutoNumString string
BkColor Color
BlockLines int
BottomSepAtIndent int
BottomSeparator string
Capitalization int
CellBottomMargin int
CellBottomMarginChange int
CellBottomMarginFixed int
CellLeftMargin int
CellLeftMarginChange int
CellLeftMarginFixed int
CellRightMargin int
CellRightMarginFixed int
CellTopMargin int
CellTopMarginChange int
CellTopMarginFixed int
CellVAlignment int
ChangeBar int
Color Color
CombinedFontFamily CombinedFontDefn
FirstIndent int
FirstIndentChange int
FirstIndentIsRelative int
FirstIndentRelPos int
FmtChangeListInCatalog int
FontAngle int
FontFamily int
FontSize int
FontSizeChange int
FontVariation int
FontWeight int
HyphMinPrefix int
HyphMinSuffix int
HyphMinWord int
Hyphenate int
KeepWithNext int
KeepWithPrev int
KernX int
KernY int
Language int
Leading int
LeadingChange int
LeftIndent int
LeftIndentChange int
LetterSpace int
LineSpacingFixed int
MaxJLetSpace int
MaxJRomSpace int
MaxSpace int
MinJLetSpace int
MinJRomSpace int
MinSpace int
MoveTabs int
Name string
NextFmtChangeListInDoc FmtChangeList
NumAtEnd int
NumTabs int
OptJLetSpace int
OptJRomSpace int
OptSpace int
Overline int
PairKern int
PgfAlignment int
PgfBoxColor Color
PgfCatalogReference string
PgfIsAutoNum int
Placement int
Position int
RightIndent int
RightIndentChange int
RunInSeparator string
SpaceAbove int
SpaceAboveChange int
SpaceBelow int
SpaceBelowChange int
Spread int
SpreadChange int
Start int
Stretch int
StretchChange int
Strikethrough int
Tabs Tabs Tab
TopSepAtIndent int
TopSeparator string
Underlining int
YakumonoType int
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)
Parameter Type
setVal PropVals
Elementof Book.FirstFmtChangeListInDocDoc.FirstFmtChangeListInDocFmtChangeList.NextFmtChangeListInDocFmtRuleClause.FmtChangeList
Return FmtChangeListDoc.GetNamedFmtChangeListFmtChangeListDoc.NewNamedFmtChangeListFmtChangeListFmtRuleClause.NewFmtChangeList
Jongware,18-Jan-2015v1.0 Contents::Index
FmtRule
QuickLinks Delete,GetProps,NewFmtRuleClauses,ObjectValid,SetProps
Properties Property Type Access Description
CountElements Strings String readwrite
ElementDef ElementDef readwrite
FmtRuleClause FmtRuleClause readwrite
FmtRuleClauses Objects readonly
FmtRuleType int readwrite
StopCountingAt string readwrite
Methods InstancesintDelete()
PropValsGetProps()
FmtRuleClauseNewFmtRuleClauses()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof FmtRuleClause.FmtRuleFmtRuleClause.SubFmtRule
Return FmtRuleElementDef.NewFirstPgfRules()FmtRuleElementDef.NewLastPgfRules()FmtRuleElementDef.NewObjectFmtRules()FmtRuleElementDef.NewPrefixRules()FmtRuleElementDef.NewSuffixRules()
FmtRuleElementDef.NewTextFmtRules()FmtRuleFmtRuleClause.NewSubFmtRule()
Jongware,18-Jan-2015v1.0 Contents::Index
FmtRuleClause
QuickLinks Delete,GetProps,NewFmtChangeList,NewSubFmtRuleObjectValid,SetProps
Properties Property Type Access
ContextLabel string readwrite
ElemPrefixSuffix string readwrite
FmtChangeList FmtChangeList readonly
FmtChangeListTag string readwrite
FmtRule FmtRule readonly
FormatTag string readwrite
IsTextRange int readwrite
RuleClauseType int readonly
Specification string readwrite
SpecificationForCSS Strings String readonly
SubFmtRule FmtRule readonly
Methods InstancesintDelete()
PropValsGetProps()
FmtChangeListNewFmtChangeList()
FmtRuleNewSubFmtRule()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof FmtRule.FmtRuleClause
Return FmtRuleClauseFmtRule.NewFmtRuleClauses
Jongware,18-Jan-2015v1.0 Contents::Index
Fn
QuickLinks Delete,GetProps,GetText,ObjectValid,SetProps
Properties Property Type Access Description
ContentHeight int readonly
Element Element readonly
FirstPgf Pgf readonly
FnAnchorString string readonly
FnNum int readonly
InTextFrame TextFrame readonly
InTextObj SubCol readonly
LastPgf Pgf readonly
NextFn Fn readonly
NextFnInDoc Fn readonly
Overflowed int readonly
PrevFn Fn readonly
TextLoc TextLoc readonly
Unique int readonly
UserString string readwrite
Methods InstancesintDelete()
PropValsGetProps()
TextItemsGetText(flags:int)
Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstFnInDocFn.NextFnFn.NextFnInDocFn.PrevFnSubCol.FirstFnSubCol.LastFnTextFrame.FirstFnTextFrame.LastFn
Return FnDoc.NewAnchoredFn(textloc:TextLoc)
Jongware,18-Jan-2015v1.0 Contents::Index
Font
QuickLinks Font
Properties Property Type Access Description
angle uint readwrite
family uint readwrite
variation uint readwrite
weight uint readwrite
Methods ConstructorFontFont(family:uint,variation:uint,weight:uint,angle:uint)Parameter Type Description
family uint
variation uint
weight uint
angle uint
Example newFont()
Usedin: numberFonts.push(value:Font)stringGlobals.GetEncodingForFont(font:Font)
Return FontFont.Font(family:uint,variation:uint,weight:uint,angle:uint)
FontFonts.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
Fonts AnArrayofFontobjectswithintegerindexingand
alengthproperty.SeealsoFont.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesFontsconcat(value:Fonts)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value Fonts Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
Fontpop()Removesthelastelementfromthearray.
numberpush(value:Font)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value Font
Usedin: FontsFonts.concat(value:Fonts)
Return FontsFonts.concat(value:Fonts)FontsGlobals.FamilyFonts(family:int)
Jongware,18-Jan-2015v1.0 Contents::Index
GraphicsFmt
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access
AFrameIsCropped bool readwrite
AFrameIsFloating bool readwrite
Alignment int readwrite
AnchorType int readwrite
Angle int readwrite
BaselineOffset int readwrite
BorderWidth int readwrite
ColGapWidth int readwrite
Color Color readwrite
ColumnsAreBalanced int readwrite
DTheta int readwrite
Fill int readwrite
FlowIsAutoConnect int readwrite
FlowIsPostScript int readwrite
Height int readwrite
InsetDpi int readwrite
LocX int readwrite
LocY int readwrite
MathMLComposeDpi int readwrite
MathMLDpi int readwrite
MathMLFontSize int readwrite
MathSize int readwrite
NextGraphicsFmtInDoc GraphicsFmt readonly
NumColumns int readwrite
Overprint int readwrite
Pen int readwrite
Radius int readwrite
Runaround int readwrite
RunaroundGap int readwrite
SideHeadGap int readwrite
SideHeadPlacement int readwrite
SideHeadWidth int readwrite
SideOffset int readwrite
StyleTag string readwrite
TextLineType int readwrite
Theta int readwrite
TintPercent int readwrite
UseAFrameIsCropped bool readwrite
UseAFrameIsFloating bool readwrite
UseAlignment bool readwrite
UseAnchorType bool readwrite
UseAngle bool readwrite
UseBaselineOffset bool readwrite
UseBorderWidth bool readwrite
UseColGapWidth bool readwrite
UseColor bool readwrite
UseColumnsAreBalanced bool readwrite
UseDTheta bool readwrite
UseFill bool readwrite
UseFlowIsAutoConnect bool readwrite
UseFlowIsPostScript bool readwrite
UseHeight bool readwrite
UseInsetDpi bool readwrite
UseLocX bool readwrite
UseLocY bool readwrite
UseMathMLComposeDpi bool readwrite
UseMathMLDpi bool readwrite
UseMathMLFontSize bool readwrite
UseMathSize bool readwrite
UseNumColumns bool readwrite
UseOverprint bool readwrite
UsePen bool readwrite
UseRadius bool readwrite
UseRunaround bool readwrite
UseRunaroundGap bool readwrite
UseSideHeadGap bool readwrite
UseSideHeadPlacement bool readwrite
UseSideHeadWidth bool readwrite
UseSideOffset bool readwrite
UseTextLineType bool readwrite
UseTheta bool readwrite
UseTintPercent bool readwrite
UseWidth bool readwrite
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstGraphicsFmtInDocGraphicsFmt.NextGraphicsFmtInDoc
Return GraphicsFmtDoc.GetNamedGraphicsFmt(nameGraphicsFmtDoc.NewNamedGraphicsFmt(name
Jongware,18-Jan-2015v1.0 Contents::Index
Group
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FirstGraphicInGroup FMObject readonly
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LastGraphicInGroup FMObject readonly
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof AFrame.GroupParentArc.GroupParentEllipse.GroupParentGroup.GroupParentInset.GroupParentLine.GroupParentMath.GroupParentMathML.GroupParentPolygon.GroupParentPolyline.GroupParentRectangle.GroupParentRoundRect.GroupParentTextFrame.GroupParentTextLine.GroupParentUnanchoredFrame.GroupParent
Return GroupDoc.NewGroup(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
HiddenPage
QuickLinks ApplyPageLayout,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Name string readonly
PageFrame UnanchoredFrame readonly
PageHeight int readonly
PageWidth int readonly
Methods InstancesintApplyPageLayout(srcPage:PageObject)PageObjectisanyPageobjecti.e.,BodyPage,MasterPage,ReferencePage,HiddenPageParameter Type Description
srcPage PageObject
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.HiddenPage
Jongware,18-Jan-2015v1.0 Contents::Index
IdValuePair
QuickLinks IdValuePair
Properties Property Type Access Description
id int readwrite
value Value readwrite
Methods ConstructorIdValuePairIdValuePair(id:int,value:Value)Parameter Type Description
id int
value Value
Example newIdValuePair()
Usedin: numberIdValuePairs.push(value:IdValuePair)
Return IdValuePairIdValuePair.IdValuePair(id:int,value:Value)
IdValuePairIdValuePairs.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
IdValuePairs AnArrayofIdValuePairobjectswithinteger
indexingandalengthproperty.SeealsoIdValuePair.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesIdValuePairsconcat(value:IdValuePairs)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value IdValuePairs Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
IdValuePairpop()Removesthelastelementfromthearray.
numberpush(value:IdValuePair)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value IdValuePair
Usedin: intCMSObject.CMSCheckin(checkinParam:IdValuePairs)
intCMSObject.CMSDelete(deleteParams:IdValuePairs)
ObjectCMSObject.CMSOpenFile(openParams:IdValuePairs)
CMSSessionGlobals.CMSLogin(setVal:IdValuePairs)
IdValuePairsIdValuePairs.concat(value:IdValuePairs)
Return IdValuePairsIdValuePairs.concat(value:IdValuePairs)
Jongware,18-Jan-2015v1.0 Contents::Index
Inset
QuickLinks Delete,DeletePropByName,GetIntByName,GetMetricByNameGetProps,GetUBytesByName,ObjectValid,SetIntByName,SetMetricByName,SetProps,SetUBytesByName
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
ImportHint string readwrite
InsetDpi int readwrite
InsetEditor string readwrite
InsetFile string readwrite
InsetGfxActiveInPdf bool readwrite
InsetGfxName string readwrite
InsetGfxPlayWindowInPdf bool readwrite
InsetIsFixedSize int readwrite
InsetIsFlippedSideways int readwrite
InsetJavaScriptFile string readwrite
InsetPosterFile string readwrite
InsetU3dAnimationList StringsString
readonly
InsetU3dPartList StringsString
readonly
InsetU3dViewList StringsString
readonly
InsetUpdater string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
PageNum int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
voidDeletePropByName(propName:string)Parameter Type Description
propName string
intGetIntByName(propName:string)Parameter Type Description
propName string
intGetMetricByName(propName:string)Parameter Type Description
propName string
PropValsGetProps()
UBytesGetUBytesByName(propName:string)Parameter Type Description
propName string
intObjectValid()
voidSetIntByName(propName:string,setVal:int)Parameter Type Description
propName string
setVal int
voidSetMetricByName(propName:string,setVal:int)Parameter Type Description
propName string
setVal int
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
voidSetUBytesByName(propName:string,setVal:UBytes)Parameter Type Description
propName string
setVal UBytes
Return InsetDoc.NewInset(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
Ints AnArrayofintobjectswithintegerindexingand
alengthproperty.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesIntsconcat(value:Ints)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value Ints Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
intpop()Removesthelastelementfromthearray.
numberpush(value:int)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value int
Elementof ElementDef.GeneralRuleErrorOffsetsTypedVal.isval
app.FontFamilyAttributes
Usedin: IntsInts.concat(value:Ints)
Return IntsInts.concat(value:Ints)
Jongware,18-Jan-2015v1.0 Contents::Index
Iterator
QuickLinks Delete,GetNextIteratorItem,GetProps,ObjectValid,SetProps
Methods InstancesintDelete()
PropValsGetNextIteratorItem()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Jongware,18-Jan-2015v1.0 Contents::Index
KeyCatalog
QuickLinks Delete,DeleteAllKeyDefinitions,GetAllKeyDefinitionsGetAllKeys,GetKeyDefinition,GetProps,NewKeyDefinitionObjectValid,SetProps,UpdateKeyDefinition
Properties Property Type Access
IsDefault bool readonly
IsStale bool readwrite
KeyCatalogClientName string readwrite
KeyCount int readonly
Name string readwrite
NextKeyCatalogInSession KeyCatalog readonly
NotLoaded bool readwrite
Source string readwrite
SourceType int readwrite
Methods InstancesintDelete()
voidDeleteAllKeyDefinitions()
TypedValsGetAllKeyDefinitions(filterType:int)Parameter Type Description
filterType int
StringsGetAllKeys()
TypedValGetKeyDefinition(key:string,keyField:intParameter Type Description
key string
keyField int
PropValsGetProps()
voidNewKeyDefinition(key:string,href:string,srcTypesrcFile:string,flags:int)Parameter Type Description
key string
href string
srcType int
srcFile string
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
voidUpdateKeyDefinition(key:string,keyField:intTypedVal)Parameter Type Description
key string
keyField int
valuep TypedVal
Elementof Doc.KeyCatalogDoc.SpecifiedKeyCatalogKeyCatalog.NextKeyCatalogInSessionapp.DefaultKeyCatalogapp.FirstKeyCatalogInSession
Return KeyCatalogGlobals.GetKeyCatalog(tag:string)KeyCatalogGlobals.NewKeyCatalog(tag:string)
Line
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
NumPoints int readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
Points PointsPoint
readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return LineDoc.NewLine(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
Marker
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Element Element readonly
MarkerText string readwrite
MarkerTypeId MarkerType readwrite
NextMarkerInDoc Marker readonly
OldTypeNum readwrite
TextLoc TextLoc readonly
Unique int readonly
UserString string readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstMarkerInDocMarker.NextMarkerInDoc
Return MarkerDoc.NewAnchoredMarker(textloc:TextLoc)
Jongware,18-Jan-2015v1.0 Contents::Index
MarkerType
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access
InvariantName string readwrite
Name string readwrite
NextMarkerTypeInDoc MarkerType readwrite
Public bool readwrite
Required bool readonly
Transient bool readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstMarkerTypeInDocMarker.MarkerTypeIdMarkerType.NextMarkerTypeInDoc
Return MarkerTypeDoc.GetNamedMarkerType(name:stringMarkerTypeDoc.NewNamedMarkerType(name:string
Jongware,18-Jan-2015v1.0 Contents::Index
MasterPage
QuickLinks ApplyPageLayout,Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Name string readwrite
PageFrame UnanchoredFrame readonly
PageHeight int readonly
PageNext MasterPage readonly
PageNum int readonly
PagePrev MasterPage readonly
PageWidth int readonly
Methods InstancesintApplyPageLayout(srcPage:PageObject)PageObjectisanyPageobjecti.e.,BodyPage,MasterPage,ReferencePage,HiddenPageParameter Type Description
srcPage PageObject
intDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstMasterPageInDocDoc.LastMasterPageInDocDoc.LeftMasterPageDoc.RightMasterPageMasterPage.PageNextMasterPage.PagePrev
Return MasterPageDoc.GetNamedMasterPage(name:stringMasterPageDoc.NewNamedMasterPage(name:string
Jongware,18-Jan-2015v1.0 Contents::Index
Math
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BasePointX int readwrite
BasePointY int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
MathFullForm string readwrite
MathSize int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TextLineType int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return MathDoc.NewMath(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
MathML
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
MathMLComposeDpi int readwrite
MathMLData StringsString
readwrite
MathMLDpi int readwrite
MathMLFontSize int readwrite
MathMLIsFixedSize int readwrite
MathMLIsFlippedSideways int readwrite
MathMLIsInverted int readwrite
MathMLXmlData string readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return MathMLDoc.NewMathML(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
Menu
QuickLinks AddCommandToMenu,AddMenuToMenu,AnimateMenu,DefineAndAddCommand,DefineAndAddMenu,Delete,GetProps,MenuItemInMenu,ObjectValid,SetProps
Properties Property Type Access Description
FirstMenuItemInMenu FMObject readwrite
Label string readwrite
MenuItemIsEnabled int readonly
MenuType int readonly
Name string readonly
NextMenuItemInMenu FMObject readwrite
NextMenuItemInSession FMObject readonly
PrevMenuItemInMenu FMObject readwrite
Methods InstancesnumberAddCommandToMenu(command:Command)Parameter Type Description
command Command
intAddMenuToMenu(menu:Menu)Parameter Type Description
menu Menu
intAnimateMenu(menuitem:Object,sleep:int,realLabel:string,docOrBook:Object,action:bool)Parameter Type Description
menuitem Object
sleep int
realLabel string
docOrBook Object
action bool
CommandDefineAndAddCommand(cmdNum:number,name:string,label:string,shortcut:string)Parameter Type Description
cmdNum number
name string
label string
shortcut string
MenuDefineAndAddMenu(name:string,label:string)Parameter Type Description
name string
label string
intDelete()
PropValsGetProps()
MenuMenuItemInMenu(menuitem:MenuItemComponent,recursive:bool)Parameter Type Description
menuitem MenuItemComponent
recursive bool
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.MenuBarDoc.ViewOnlyMenuBar
Usedin: intMenu.AddMenuToMenu(menu:Menu)
Return MenuGlobals.DefineMenu(name:string,label:string)MenuMenu.DefineAndAddMenu(name:string,label:string)MenuMenu.MenuItemInMenu(menuitem:
MenuItemComponent,recursive:bool)Menuapp.GetNamedMenu(name:string)Menuapp.NewNamedMenu(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
MenuItemSeparator
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type
Label string
MenuItemIsEnabled int
Name string
NextMenuItemInMenu FMObject
NextMenuItemInSession FMObject
PrevMenuItemInMenu FMObject
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type
setVal PropVals
Return MenuItemSeparatorapp.GetNamedMenuItemSeparator(name:string)
MenuItemSeparatorapp.NewNamedMenuItemSeparator(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
Metrics AnArrayofintobjectswithintegerindexingand
alengthproperty.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesMetricsconcat(value:Metrics)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value Metrics Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
intpop()Removesthelastelementfromthearray.
numberpush(value:int)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value int
Elementof AFrame.DashArc.Dash
Ellipse.DashGroup.DashInset.DashLine.DashMath.DashMathML.DashPolygon.DashPolyline.DashRectangle.DashRoundRect.DashTbl.TblColWidthsTextFrame.DashTextLine.DashTypedVal.msvalUnanchoredFrame.Dash
Usedin: MetricsMetrics.concat(value:Metrics)
Return MetricsMetrics.concat(value:Metrics)
Jongware,18-Jan-2015v1.0 Contents::Index
Pgf
QuickLinks Delete,GetProps,GetText,ObjectValid,SetProps
Properties Property Type Access Description
AdjHyphens int readwrite
AutoNumChar string readwrite
AutoNumString string readwrite
BkColor Color readwrite
BlockLines int readwrite
BottomSeparator string readwrite
Capitalization int readwrite
CellBottomMargin int readwrite
CellLeftMargin int readwrite
CellMarginsFixed int readwrite
CellRightMargin int readwrite
CellTopMargin int readwrite
CellVAlignment int readwrite
ChangeBar int readwrite
Color Color readwrite
CombinedFontFamily CombinedFontDefn readwrite
FirstIndent int readwrite
FontAngle int readwrite
FontEncodingName string readonly
FontFamily int readwrite
FontPlatformName string readwrite
FontPostScriptName string readwrite
FontSize int readwrite
FontVariation int readwrite
FontWeight int readwrite
FormatOverride int readwrite
HyphMinPrefix int readwrite
HyphMinSuffix int readwrite
HyphMinWord int readwrite
Hyphenate int readwrite
InTextFrame TextFrame readonly
InTextObj FMObject readonly
KeepWithNext int readwrite
KeepWithPrev int readwrite
KernX int readwrite
KernY int readwrite
Language int readwrite
Leading int readwrite
LeftIndent int readwrite
LetterSpace int readwrite
LineSpacing int readwrite
Locked int readwrite
MaxJLetSpace int readwrite
MaxJRomSpace int readwrite
MaxSpace int readwrite
MinJLetSpace int readwrite
MinJRomSpace int readwrite
MinSpace int readwrite
Name string readwrite
NextPgfInDoc Pgf readonly
NextPgfInFlow Pgf readonly
NextTag string readwrite
NumAtEnd int readwrite
NumTabs int readonly
OptJLetSpace int readwrite
OptJRomSpace int readwrite
OptSpace int readwrite
Overline int readwrite
PairKern int readwrite
PgfAlignment int readwrite
PgfBoxColor Color readwrite
PgfIsAutoNum int readwrite
PgfNumber string readonly
PgfSpellChecked int readwrite
Placement int readwrite
Position int readwrite
PrevPgfInFlow Pgf readonly
RightIndent int readwrite
RunInSeparator string readwrite
SpaceAbove int readwrite
SpaceBelow int readwrite
Spread int readwrite
Start int readwrite
Stretch int readwrite
Strikethrough int readwrite
Tabs Tabs Tab readwrite
TopSeparator string readwrite
Underlining int readwrite
Unique int readonly
UseNextTag int readwrite
UserString string readwrite
YakumonoType int readwrite
Methods InstancesintDelete()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Cell.FirstPgfCell.LastPgf
Doc.FirstPgfInDocFn.FirstPgfFn.LastPgfPgf.NextPgfInDocPgf.NextPgfInFlowPgf.PrevPgfInFlowSubCol.FirstPgfSubCol.LastPgfTbl.FirstPgfTbl.LastPgfTextFrame.FirstPgfTextFrame.LastPgf
Return PgfDoc.NewSeriesPgf(previous:Object)
Jongware,18-Jan-2015v1.0 Contents::Index
PgfFmt
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access
AcrobatLevel int readwrite
AdjHyphens int readwrite
AutoNumChar string readwrite
AutoNumString string readwrite
BkColor Color readwrite
BlockLines int readwrite
BottomSeparator string readwrite
Capitalization int readwrite
CellBottomMargin int readwrite
CellLeftMargin int readwrite
CellMarginsFixed int readwrite
CellRightMargin int readwrite
CellTopMargin int readwrite
CellVAlignment int readwrite
ChangeBar int readwrite
Color Color readwrite
CombinedFontFamily CombinedFontDefn readwrite
FirstIndent int readwrite
FontAngle int readwrite
FontEncodingName string readonly
FontFamily int readwrite
FontPlatformName string readwrite
FontPostScriptName string readwrite
FontSize int readwrite
FontVariation int readwrite
FontWeight int readwrite
HyphMinPrefix int readwrite
HyphMinSuffix int readwrite
HyphMinWord int readwrite
Hyphenate int readwrite
KeepWithNext int readwrite
KeepWithPrev int readwrite
KernX int readwrite
KernY int readwrite
Language int readwrite
Leading int readwrite
LeftIndent int readwrite
LetterSpace int readwrite
LineSpacing int readwrite
MaxJLetSpace int readwrite
MaxJRomSpace int readwrite
MaxSpace int readwrite
MinJLetSpace int readwrite
MinJRomSpace int readwrite
MinSpace int readwrite
Name string readwrite
NextPgfFmtInDoc PgfFmt readonly
NextTag string readwrite
NumAtEnd int readwrite
NumTabs int readonly
OptJLetSpace int readwrite
OptJRomSpace int readwrite
OptSpace int readwrite
Overline int readwrite
PDFStructureLevel int readwrite
PairKern int readwrite
PgfAlignment int readwrite
PgfBoxColor Color readwrite
PgfIsAutoNum int readwrite
PgfMarkedForNamedDestination int readwrite
Placement int readwrite
Position int readwrite
RightIndent int readwrite
RunInSeparator string readwrite
SpaceAbove int readwrite
SpaceBelow int readwrite
Spread int readwrite
Start int readwrite
Stretch int readwrite
Strikethrough int readwrite
Tabs Tabs Tab readwrite
TopSeparator string readwrite
Underlining int readwrite
UseBkColor bool readwrite
UseNextTag int readwrite
UserString string readwrite
YakumonoType int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstPgfFmtInDocPgfFmt.NextPgfFmtInDoc
Return PgfFmtDoc.GetNamedPgfFmt(name:string)PgfFmtDoc.NewNamedPgfFmt(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
Point
QuickLinks Point
Properties Property Type Access Description
x int readwrite
y int readwrite
Methods ConstructorPointPoint(x:int,y:int)Parameter Type Description
x int
y int
Example newPoint()
Elementof Button.locationCheckbox.locationDropDownList.locationEditText.locationFlashPlayer.locationGroup.locationIconButton.locationListBox.locationPanel.locationProgressbar.locationRadioButton.locationScriptUIGraphics.currentPointScrollbar.locationSlider.locationStaticText.locationTreeView.locationWindow.frameLocation
Window.location
Usedin: numberPoints.push(value:Point)
Return PointPoint.Point(x:int,y:int)PointPoints.pop()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)
Jongware,18-Jan-2015v1.0 Contents::Index
Points AnArrayofPointobjectswithintegerindexingand
alengthproperty.SeealsoPoint.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesPointsconcat(value:Points)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value Points Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
Pointpop()Removesthelastelementfromthearray.
numberpush(value:Point)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value Point
Elementof Line.Points
Polygon.PointsPolyline.PointsTypedVal.psval
Usedin: PointsPoints.concat(value:Points)
Return PointsPoints.concat(value:Points)
Jongware,18-Jan-2015v1.0 Contents::Index
Polygon
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
NumPoints int readwrite
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
Points PointsPoint
readwrite
PolyIsBezier int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return PolygonDoc.NewPolygon(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
Polyline
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
NumPoints int readwrite
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
Points PointsPoint
readonly
PolyIsBezier int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return PolylineDoc.NewPolyline(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
PropIdent
QuickLinks PropIdent
Properties Property Type Access Description
name string readwrite
num int readwrite
Methods ConstructorPropIdentPropIdent(num:int,name:string)Parameter Type Description
num int
name string
Example newPropIdent()
Elementof PropVal.propIdent
Usedin: PropValCMSObject.CMSGetProperty(propertyId:PropIdent)
PropValPropVal.PropVal(propIdent:PropIdent,propVal:TypedVal)
Return PropIdentPropIdent.PropIdent(num:int,name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
PropVal
QuickLinks PropVal
Properties Property Type Access Description
propIdent PropIdent readwrite
propVal TypedVal readwrite
Methods ConstructorPropValPropVal(propIdent:PropIdent,propVal:TypedVal)Parameter Type Description
propIdent PropIdent
propVal TypedVal
Example newPropVal()
Usedin: voidCMSObject.CMSSetProperty(propVal:PropVal)voidDoc.SetTextPropVal(textRange:TextRange,setVal:
PropVal)voidGlobals.PrintPropVal(p:PropVal)numberPropVals.push(value:PropVal)
Return PropValCMSObject.CMSGetProperty(propertyId:PropIdent)
PropValDoc.GetTextPropVal(textLoc:TextLoc,propNum:int)
PropValPropVal.PropVal(propIdent:PropIdent,propVal:TypedVal)
PropValPropVals.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
PropVals AnArrayofPropValobjectswithintegerindexingand
alengthproperty.SeealsoPropVal.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesPropValsconcat(value:PropVals)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value PropVals Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
PropValpop()Removesthelastelementfromthearray.
numberpush(value:PropVal)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value PropVal
Usedin: voidAFrame.SetProps(setVal:PropVals)
voidArc.SetProps(setVal:PropVals)voidAttrCondExpr.SetProps(setVal:PropVals)voidBodyPage.SetProps(setVal:PropVals)intBook.Export(fileName:string,exportParams:
PropVals,exportReturnParams:PropVals)ObjectBook.Import(textLocP:TextLoc,filename:string,
importParams:PropVals,importReturnParams:PropVals)
ObjectBook.NewIterator(paramsp:PropVals)ObjectBook.Save(saveAsName:string,saveParams:
PropVals,saveReturnParams:PropVals)voidBook.SetProps(setVal:PropVals)intBook.UpdateBook(updateParams:PropVals,
updateReturnParams:PropVals)voidBookComponent.SetProps(setVal:PropVals)voidCMSConnection.SetProps(setVal:PropVals)voidCMSObject.CMSSetProperties(propVals:PropVals)voidCMSObject.SetProps(setVal:PropVals)voidCMSRegistration.SetProps(setVal:PropVals)voidCMSSession.SetProps(setVal:PropVals)voidCell.SetProps(setVal:PropVals)voidCharFmt.SetProps(setVal:PropVals)voidColor.SetProps(setVal:PropVals)voidCombinedFontDefn.SetProps(setVal:PropVals)voidCommand.SetProps(setVal:PropVals)voidCondFmt.SetProps(setVal:PropVals)intDoc.Export(fileName:string,exportParams:
PropVals,exportReturnParams:PropVals)TextRangeDoc.Find(textLoc:TextLoc,findParams:
PropVals)ObjectDoc.Import(textLocP:TextLoc,filename:string,
importParams:PropVals,importReturnParams:PropVals)
ObjectDoc.NewIterator(paramsp:PropVals)ObjectDoc.Save(saveAsName:string,saveParams:
PropVals,saveReturnParams:PropVals)voidDoc.SetProps(setVal:PropVals)voidDoc.SetTextProps(textRange:TextRange,setVal:
PropVals)
voidElement.SetProps(setVal:PropVals)voidElementDef.SetProps(setVal:PropVals)voidEllipse.SetProps(setVal:PropVals)voidFlow.SetProps(setVal:PropVals)voidFmtChangeList.SetProps(setVal:PropVals)voidFmtRule.SetProps(setVal:PropVals)voidFmtRuleClause.SetProps(setVal:PropVals)voidFn.SetProps(setVal:PropVals)voidGlobals.AppendIntProp(pv:PropVals,prop:int,
val:int)voidGlobals.AppendMetricProp(pv:PropVals,prop:int,
val:int)voidGlobals.AppendStringProp(pv:PropVals,prop:int,
val:string)voidGlobals.AppendStringsProp(pv:PropVals,prop:
int,val:Strings)voidGlobals.AppendVal(pv:PropVals,prop:int,val:
TypedVal)intGlobals.CheckStatus(p:PropVals,statusBit:int)intGlobals.GetPropIndex(propVals:PropVals,
propNum:int)boolGlobals.IsDataDifferentFromTemplateData
(templatePath:string,templateDataProps:PropVals)ObjectGlobals.NewXML(newXMLParams:PropVals,
newXMLReturnParamspp:PropVals)ObjectGlobals.Open(fileName:string,openParams:
PropVals,openReturnParams:PropVals)voidGlobals.PrintExportStatus(p:PropVals)voidGlobals.PrintImportStatus(p:PropVals)voidGlobals.PrintOpenStatus(p:PropVals)voidGlobals.PrintPropVals(p:PropVals)voidGlobals.PrintSaveStatus(p:PropVals)voidGlobals.PrintUpdateBookStatus(p:PropVals)voidGraphicsFmt.SetProps(setVal:PropVals)voidGroup.SetProps(setVal:PropVals)voidHiddenPage.SetProps(setVal:PropVals)voidInset.SetProps(setVal:PropVals)voidIterator.SetProps(setVal:PropVals)voidKeyCatalog.SetProps(setVal:PropVals)
voidLine.SetProps(setVal:PropVals)voidMarker.SetProps(setVal:PropVals)voidMarkerType.SetProps(setVal:PropVals)voidMasterPage.SetProps(setVal:PropVals)voidMath.SetProps(setVal:PropVals)voidMathML.SetProps(setVal:PropVals)voidMenu.SetProps(setVal:PropVals)voidMenuItemSeparator.SetProps(setVal:PropVals)voidPgf.SetProps(setVal:PropVals)voidPgfFmt.SetProps(setVal:PropVals)voidPolygon.SetProps(setVal:PropVals)voidPolyline.SetProps(setVal:PropVals)PropValsPropVals.concat(value:PropVals)voidRectangle.SetProps(setVal:PropVals)voidRefPage.SetProps(setVal:PropVals)voidRoundRect.SetProps(setVal:PropVals)voidRow.SetProps(setVal:PropVals)voidRubi.SetProps(setVal:PropVals)voidRulingFmt.SetProps(setVal:PropVals)voidSubCol.SetProps(setVal:PropVals)voidTbl.SetProps(setVal:PropVals)voidTblFmt.SetProps(setVal:PropVals)voidTextFrame.SetProps(setVal:PropVals)voidTextLine.SetProps(setVal:PropVals)voidTiApiClient.SetProps(setVal:PropVals)voidTiFlow.SetProps(setVal:PropVals)voidTiText.SetProps(setVal:PropVals)voidTiTextTable.SetProps(setVal:PropVals)voidUnanchoredFrame.SetProps(setVal:PropVals)voidVar.SetProps(setVal:PropVals)voidVarFmt.SetProps(setVal:PropVals)voidXRef.SetProps(setVal:PropVals)voidXRefFmt.SetProps(setVal:PropVals)voidapp.SetProps(setVal:PropVals)
Return PropValsAFrame.GetProps()PropValsArc.GetProps()PropValsAttrCondExpr.GetProps()PropValsBodyPage.GetProps()
PropValsBook.GetProps()PropValsBookComponent.GetProps()PropValsCMSConnection.GetProps()PropValsCMSObject.CMSGetProperties()PropValsCMSObject.GetProps()PropValsCMSRegistration.GetProps()PropValsCMSSession.GetProps()PropValsCell.GetProps()PropValsCharFmt.GetProps()PropValsColor.GetProps()PropValsCombinedFontDefn.GetProps()PropValsCommand.GetProps()PropValsCondFmt.GetProps()PropValsDoc.GetProps()PropValsDoc.GetTextProps(textLoc:TextLoc)PropValsElement.GetProps()PropValsElementDef.GetProps()PropValsEllipse.GetProps()PropValsFlow.GetProps()PropValsFmtChangeList.GetProps()PropValsFmtRule.GetProps()PropValsFmtRuleClause.GetProps()PropValsFn.GetProps()PropValsGlobals.AllocatePropVals(numProps:int)PropValsGlobals.GetExportDefaultParams(:void)PropValsGlobals.GetImportDefaultParams()PropValsGlobals.GetIteratorDefaultParams()PropValsGlobals.GetNewXMLDefaultParams()PropValsGlobals.GetOpenDefaultParams()PropValsGlobals.GetSaveDefaultParams()PropValsGlobals.GetUpdateBookDefaultParams()PropValsGraphicsFmt.GetProps()PropValsGroup.GetProps()PropValsHiddenPage.GetProps()PropValsInset.GetProps()PropValsIterator.GetNextIteratorItem()PropValsIterator.GetProps()PropValsKeyCatalog.GetProps()PropValsLine.GetProps()
PropValsMarker.GetProps()PropValsMarkerType.GetProps()PropValsMasterPage.GetProps()PropValsMath.GetProps()PropValsMathML.GetProps()PropValsMenu.GetProps()PropValsMenuItemSeparator.GetProps()PropValsPgf.GetProps()PropValsPgfFmt.GetProps()PropValsPolygon.GetProps()PropValsPolyline.GetProps()PropValsPropVals.concat(value:PropVals)PropValsRectangle.GetProps()PropValsRefPage.GetProps()PropValsRoundRect.GetProps()PropValsRow.GetProps()PropValsRubi.GetProps()PropValsRulingFmt.GetProps()PropValsSubCol.GetProps()PropValsTbl.GetProps()PropValsTblFmt.GetProps()PropValsTextFrame.GetProps()PropValsTextLine.GetProps()PropValsTiApiClient.GetProps()PropValsTiFlow.GetProps()PropValsTiText.GetProps()PropValsTiTextTable.GetProps()PropValsUnanchoredFrame.GetProps()PropValsVar.GetProps()PropValsVarFmt.GetProps()PropValsXRef.GetProps()PropValsXRefFmt.GetProps()PropValsapp.GetProps()
Jongware,18-Jan-2015v1.0 Contents::Index
Rectangle
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
RectangleIsSmoothed int readwrite
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return RectangleDoc.NewRectangle(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
RefPage
QuickLinks ApplyPageLayout,Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Name string readwrite
PageFrame UnanchoredFrame readonly
PageHeight int readonly
PageNext RefPage readonly
PageNum int readonly
PagePrev RefPage readonly
PageWidth int readonly
Methods InstancesintApplyPageLayout(srcPage:PageObject)PageObjectisanyPageobjecti.e.,BodyPage,MasterPage,ReferencePage,HiddenPageParameter Type Description
srcPage PageObject
intDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstRefPageInDoc
Doc.LastRefPageInDocRefPage.PageNextRefPage.PagePrev
Return RefPageDoc.GetNamedRefPage(name:string)RefPageDoc.NewNamedRefPage(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
RoundRect
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Radius int readwrite
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return RoundRectDoc.NewRoundRect(parent:FrameObject
Jongware,18-Jan-2015v1.0 Contents::Index
Row
QuickLinks AddRows,Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
CondFmtIsShown int readwrite
Element Element readonly
FirstCellInRow Cell readonly
Height int readonly
InCond Objects readwrite
LocX int readonly
LocY int readonly
NextRowInTbl Row readonly
PrevRowInTbl Row readonly
RowIsShown int readonly
RowKeepWithNext int readwrite
RowKeepWithPrev int readwrite
RowMaxHeight int readwrite
RowMinHeight int readwrite
RowStart int readwrite
RowTbl Tbl readonly
RowType int readonly
SepOverride Color readwrite
StyleOverrides int readwrite
UseSepOverride int readwrite
UserString string readwrite
Width int readonly
Methods InstancesintAddRows(direction:int,numNewRows:int)Parameter Type Description
direction int
numNewRows int
intDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Cell.CellRowRow.NextRowInTblRow.PrevRowInTblTbl.BottomRowSelectionTbl.FirstRowInTblTbl.LastRowInTblTbl.TopRowSelection
Usedin: intTbl.DeleteRows(refRow:Row,numDelRows:int)
Jongware,18-Jan-2015v1.0 Contents::Index
Rubi
QuickLinks Delete,GetProps,GetText2,ObjectValid,SetProps
Properties Property Type Access Description
Element Element readonly
NextRubiInDoc Rubi readonly
OyamojiTextRange TextRange readonly
RubiElement Element readonly
RubiTextRange TextRange readonly
Unique int readonly
Methods InstancesintDelete()
PropValsGetProps()
TextItemsGetText2(flags:int,flags2:int)Parameter Type Description
flags int
flags2 int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstRubiInDocRubi.NextRubiInDoc
RulingFmt
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Name string readwrite
NextRulingFmtInDoc RulingFmt readonly
Pen int readwrite
RulingGap int readwrite
RulingLines int readwrite
RulingPenWidth int readwrite
RulingSep Color readwrite
UserString string readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Cell.CellDefaultBottomRulingCell.CellDefaultLeftRulingCell.CellDefaultRightRulingCell.CellDefaultTopRulingCell.CellOverrideBottomRulingCell.CellOverrideLeftRuling
Cell.CellOverrideRightRulingCell.CellOverrideTopRulingDoc.FirstRulingFmtInDocRulingFmt.NextRulingFmtInDocTbl.TblBodyRowRulingTbl.TblColRulingTbl.TblHFRowRulingTbl.TblHFSeparatorRulingTbl.TblLeftRulingTbl.TblOtherBodyRowRulingTbl.TblOtherColRulingTbl.TblRightRulingTbl.TblTopRulingTblFmt.TblBodyRowRulingTblFmt.TblBottomRulingTblFmt.TblColRulingTblFmt.TblHFRowRulingTblFmt.TblHFSeparatorRulingTblFmt.TblLeftRulingTblFmt.TblOtherBodyRowRulingTblFmt.TblOtherColRulingTblFmt.TblRightRulingTblFmt.TblTopRuling
Return RulingFmtDoc.GetNamedRulingFmt(name:string)RulingFmtDoc.NewNamedRulingFmt(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
Strings AnArrayofstringobjectswithintegerindexingand
alengthproperty.SeealsoString.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesStringsconcat(value:Strings)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value Strings Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
stringpop()Removesthelastelementfromthearray.
numberpush(value:string)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value string
Elementof AFrame.ObjectAttributes
Arc.ObjectAttributesAttribute.valuesAttributeDef.choicesAttributeDef.defValuesAttributeEx.originalValuesAttributeEx.valuesBook.CustomElementListBook.DocAcrobatElementListBook.PDFDocInfoBook.XmlStyleSheetListBookComponent.ExtractElementTagsBookComponent.ExtractTagsCMSInfo.userFieldsCommand.KeyboardShortcutsCommand.LabelsDoc.CustomElementListDoc.DefaultExclusionsDoc.DefaultInclusionsDoc.DictionaryDoc.DocAcrobatElementListDoc.MarkerTypeNamesDoc.PDFDocInfoDoc.ReviewerNameListDoc.SymbolsListDoc.XmlStyleSheetListElement.NamespaceElementDef.AlsoInsertElementDef.ExclusionsElementDef.InclusionsEllipse.ObjectAttributesFilterArgs.argsFmtRule.CountElementsFmtRuleClause.SpecificationForCSSGroup.ObjectAttributesInset.InsetU3dAnimationListInset.InsetU3dPartListInset.InsetU3dViewListInset.ObjectAttributesLine.ObjectAttributes
Math.ObjectAttributesMathML.MathMLDataMathML.ObjectAttributesPolygon.ObjectAttributesPolyline.ObjectAttributesRectangle.ObjectAttributesRoundRect.ObjectAttributesTextFrame.ObjectAttributesTextLine.ObjectAttributesTypedVal.ssvalUnanchoredFrame.ObjectAttributesapp.FontAngleNamesapp.FontFamilyNamesapp.FontVariationNamesapp.FontWeightNamesapp.MarkerNames
Usedin: AttributeAttribute.Attribute(name:string,values:Strings,valflags:uint,allow:uint)
AttributeDefAttributeDef.AttributeDef(name:string,required:int,flags:uint,attrType:int,choices:Strings,defValues:Strings,rangeMin:string,rangeMax:string)
AttributeExAttributeEx.AttributeEx(name:string,values:Strings,originalValues:Strings,valflags:uint,allow:uint,overriddenFlags:uint)
CMSInfoCMSInfo.CMSInfo(cmsName:string,userFields:Strings,userLoginUi:uint)
voidCMSRegistration.CMSConfigLoginUI(userFields:Strings,userLoginUI:bool)
intDoc.QuickSelect(prompt:string,stringlist:Strings)FilterArgsFilterArgs.FilterArgs(infile:string,outfile:string,
clname:string,informat:string,outformat:string,binname:string,args:Strings)
voidGlobals.AppendStringsProp(pv:PropVals,prop:int,val:Strings)
intGlobals.ScrollBox(title:string,stringslist:Strings,_default:int)
StringsStrings.concat(value:Strings)
StringsDoc.GetBuildExprCatalog()
Return StringsGlobals.GetSupportedEncodings()StringsKeyCatalog.GetAllKeys()StringsStrings.concat(value:Strings)
Jongware,18-Jan-2015v1.0 Contents::Index
SubCol
QuickLinks Delete,GetProps,GetText,ObjectValid,SetProps
Properties Property Type Access Description
ContentHeight int readonly
FirstAFrame AFrame readonly
FirstCell Cell readonly
FirstFn Fn readonly
FirstPgf Pgf readonly
FrameParent TextFrame readonly
Height int readonly
LastAFrame AFrame readonly
LastCell Cell readonly
LastFn Fn readonly
LastPgf Pgf readonly
LocX int readonly
LocY int readonly
NextSubCol SubCol readonly
Overflowed int readonly
ParentTextFrame TextFrame readonly
PrevSubCol SubCol readonly
Unique int readonly
UserString string readwrite
Width int readonly
Methods InstancesintDelete()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Cell.InTextObjFn.InTextObjSubCol.NextSubColSubCol.PrevSubColTextFrame.FirstSubColTextFrame.LastSubCol
Jongware,18-Jan-2015v1.0 Contents::Index
Tab
QuickLinks Tab
Properties Property Type Access Description
decimal uint readwrite
leader string readwrite
type uint readwrite
x int readwrite
Methods ConstructorTabTab(x:int,type:uint,leader:string,decimal:uint)Parameter Type Description
x int
type uint
leader string
decimal uint
Example newTab()
Usedin: numberTabs.push(value:Tab)
Return TabTab.Tab(x:int,type:uint,leader:string,decimal:uint)TabTabs.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
Tabs AnArrayofTabobjectswithintegerindexingand
alengthproperty.SeealsoTab.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesTabsconcat(value:Tabs)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value Tabs Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
Tabpop()Removesthelastelementfromthearray.
numberpush(value:Tab)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value Tab
Elementof FmtChangeList.Tabs
Pgf.TabsPgfFmt.TabsTypedVal.tsval
Usedin: TabsTabs.concat(value:Tabs)
Return TabsTabs.concat(value:Tabs)
Jongware,18-Jan-2015v1.0 Contents::Index
Tbl
QuickLinks AddCols,Delete,DeleteCols,DeleteRows,GetProps,MakeTblSelection,ObjectValid,SetProps
Properties Property Type Access Description
BottomRowSelection Row readonly
ContentHeight int readonly
Element Element readonly
FirstPgf Pgf readonly
FirstRowInTbl Row readonly
HighestLevelElement Element readonly
LastPgf Pgf readonly
LastRowInTbl Row readonly
LeftColNum int readonly
Locked int readwrite
NextTblInDoc Tbl readonly
OrphanRows int readwrite
Overflowed int readonly
RightColNum int readonly
TblAlignment int readwrite
TblBodyElement Element readonly
TblBodyFirstColor Color readwrite
TblBodyFirstFill int readwrite
TblBodyFirstPeriod int readwrite
TblBodyNextColor Color readwrite
TblBodyNextFill int readwrite
TblBodyNextPeriod int readwrite
TblBodyRowRuling RulingFmt readwrite
TblBodyRowRulingPeriod int readwrite
TblBodyShadeBy int readwrite
TblBottomRuling int readwrite
TblCatalogEntry int readonly
TblCellBottomMargin int readwrite
TblCellLeftMargin int readwrite
TblCellRightMargin int readwrite
TblCellTopMargin int readwrite
TblColRuling RulingFmt readwrite
TblColRulingPeriod int readwrite
TblColWidths Metrics readwrite
TblElement Element readonly
TblFooterElement Element readonly
TblHFColor Color readwrite
TblHFFill int readwrite
TblHFRowRuling RulingFmt readwrite
TblHFSeparatorRuling RulingFmt readwrite
TblHeaderElement Element readonly
TblInLockedTi bool readwrite
TblLastBodyRuling int readwrite
TblLeftIndent int readwrite
TblLeftRuling RulingFmt readwrite
TblNumCols int readonly
TblNumRows int readonly
TblNumbering int readwrite
TblOtherBodyRowRuling RulingFmt readwrite
TblOtherColRuling RulingFmt readwrite
TblPlacement int readwrite
TblRightIndent int readwrite
TblRightRuling RulingFmt readwrite
TblSpaceAbove int readwrite
TblSpaceBelow int readwrite
TblTag string readwrite
TblTitleElement Element readonly
TblTitleGap int readwrite
TblTitlePosition int readwrite
TblTitleSelected int readonly
TblTopRuling RulingFmt readwrite
TblWidth int readonly
TextLoc TextLoc readwrite
TopRowSelection Row readonly
Unique int readonly
UserString string readwrite
Methods InstancesintAddCols(refColNum:int,direction:int,numNewCols:int)Parameter Type Description
refColNum int
direction int
numNewCols int
intDelete()
intDeleteCols(delColNum:int,numDelCols:int)Parameter Type Description
delColNum int
numDelCols int
intDeleteRows(refRow:Row,numDelRows:int)Parameter Type Description
refRow Row
numDelRows int
PropValsGetProps()
intMakeTblSelection(topRow:int,bottomRow:int,leftCol:intrightCol:int)Parameter Type Description
topRow int
bottomRow int
leftCol int
rightCol int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstTblInDoc
Doc.SelectedTblRow.RowTblTbl.NextTblInDoc
Return TblDoc.NewAnchoredFormattedTbl(format:string,textLoc:TextLoc)
TblDoc.NewAnchoredTbl(textloc:TextLoc)TblDoc.NewTable(format:string,numCols:int,
numBodyRows:int,numHeaderRows:int,numFooterRowsint,textLoc:TextLoc)
Jongware,18-Jan-2015v1.0 Contents::Index
TblFmt
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Name string readwrite
NextTblFmtInDoc TblFmt readonly
OrphanRows int readwrite
TblAlignment int readwrite
TblBodyFirstColor Color readwrite
TblBodyFirstFill int readwrite
TblBodyFirstPeriod int readwrite
TblBodyNextColor Color readwrite
TblBodyNextFill int readwrite
TblBodyNextPeriod int readwrite
TblBodyRowRuling RulingFmt readwrite
TblBodyRowRulingPeriod int readwrite
TblBodyShadeBy int readwrite
TblBottomRuling RulingFmt readwrite
TblCatalogEntry int readwrite
TblCellBottomMargin int readwrite
TblCellLeftMargin int readwrite
TblCellRightMargin int readwrite
TblCellTopMargin int readwrite
TblColRuling RulingFmt readwrite
TblColRulingPeriod int readwrite
TblHFColor Color readwrite
TblHFFill int readwrite
TblHFRowRuling RulingFmt readwrite
TblHFSeparatorRuling RulingFmt readwrite
TblInitNumBodyRows int readwrite
TblInitNumCols int readwrite
TblInitNumFRows int readwrite
TblInitNumHRows int readwrite
TblLastBodyRuling int readwrite
TblLeftIndent int readwrite
TblLeftRuling RulingFmt readwrite
TblNumbering int readwrite
TblOtherBodyRowRuling RulingFmt readwrite
TblOtherColRuling RulingFmt readwrite
TblPlacement int readwrite
TblRightIndent int readwrite
TblRightRuling RulingFmt readwrite
TblSpaceAbove int readwrite
TblSpaceBelow int readwrite
TblTag string readwrite
TblTitleGap int readwrite
TblTitlePosition int readwrite
TblTopRuling RulingFmt readwrite
UserString string readwrite
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstTblFmtInDocTblFmt.NextTblFmtInDoc
Return TblFmtDoc.GetNamedTblFmt(name:string)TblFmtDoc.NewNamedTblFmt(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
TemplateData
QuickLinks TemplateData
Properties Property Type Access
templateDataAttrs strings readwrite
templateDataType TemplateDataType readwrite
Methods ConstructorTemplateDataTemplateData(templateDataTypeTemplateDataType,templateDataAttrs:strings)Parameter Type
templateDataType TemplateDataType
templateDataAttrs strings
Example newTemplateData()
Usedin: numberTemplateDatas.push(value:TemplateData
Return TemplateDataTemplateData.TemplateData(templateDataType:TemplateDataType,templateDataAttrsstrings)
TemplateDataTemplateDatas.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
TemplateDatas AnArrayofTemplateDataobjectswith
integerindexingandalengthproperty.SeealsoTemplateData.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesTemplateDatasconcat(value:TemplateDatas)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value TemplateDatas Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
TemplateDatapop()Removesthelastelementfromthearray.
numberpush(value:TemplateData)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value TemplateData
Usedin: TemplateDatasTemplateDatas.concat(value:TemplateDatas)
Return TemplateDatasTemplateDatas.concat(value:TemplateDatas)
Jongware,18-Jan-2015v1.0 Contents::Index
TextFrame
QuickLinks Delete,GetProps,GetText,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BorderWidth int readwrite
ColGapWidth int readwrite
Color Color readwrite
ColumnsAreBalanced int readwrite
Dash Metrics readwrite
Fill int readwrite
FirstAFrame AFrame readonly
FirstCell Cell readonly
FirstFn Fn readonly
FirstPgf Pgf readonly
FirstSubCol SubCol readonly
Flow Flow readonly
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsButton int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
LastAFrame AFrame readonly
LastCell Cell readonly
LastFn Fn readonly
LastPgf Pgf readonly
LastSubCol SubCol readonly
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
NextTextFrameInFlow TextFrame readwrite
NumColumns int readwrite
ObjectAttributes Strings readwrite
String
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
PrevTextFrameInFlow TextFrame readwrite
Runaround int readwrite
RunaroundGap int readwrite
SideHeadGap int readwrite
SideHeadPlacement int readwrite
SideHeadWidth int readwrite
TailArrow int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods InstancesintDelete()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof AFrame.InTextFrameCell.InTextFrameFlow.FirstTextFrameInFlowFlow.LastTextFrameInFlowFn.InTextFramePgf.InTextFrameSubCol.FrameParentSubCol.ParentTextFrameTextFrame.NextTextFrameInFlowTextFrame.PrevTextFrameInFlow
Return TextFrameDoc.NewTextFrame(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
TextItem
Properties Property Type Access Description
dataType int readwrite
idata number readwrite
obj any readwrite
offset int readwrite
sdata string readwrite
Usedin: voidGlobals.PrintTextItem(textItem:TextItem)numberTextItems.push(value:TextItem)
Return TextItemTextItems.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
TextItems AnArrayofTextItemobjectswithintegerindexingand
alengthproperty.SeealsoTextItem.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesTextItemsconcat(value:TextItems)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value TextItems Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
TextItempop()Removesthelastelementfromthearray.
numberpush(value:TextItem)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value TextItem
Usedin: voidGlobals.PrintTextItems(textItems:TextItems)TextItemsTextItems.concat(value:TextItems)
Return TextItemsCell.GetText(flags:int)TextItemsDoc.GetTextForRange(tr:TextRange,flags:
int)TextItemsDoc.GetTextForRange2(tr:TextRange,
flags:int,flags2:int)TextItemsElement.GetText(flags:int)TextItemsFlow.GetText(flags:int)TextItemsFn.GetText(flags:int)TextItemsPgf.GetText(flags:int)TextItemsRubi.GetText2(flags:int,flags2:int)TextItemsSubCol.GetText(flags:int)TextItemsTextFrame.GetText(flags:int)TextItemsTextItems.concat(value:TextItems)TextItemsTextLine.GetText(flags:int)TextItemsTiApiClient.GetText(flags:int)TextItemsTiFlow.GetText(flags:int)TextItemsTiText.GetText(flags:int)TextItemsTiTextTable.GetText(flags:int)TextItemsVar.GetText(flags:int)TextItemsXRef.GetText(flags:int)
Jongware,18-Jan-2015v1.0 Contents::Index
TextLine
QuickLinks Delete,GetProps,GetText,ObjectValid,SetProps
Properties Property Type Access Description
Angle int readwrite
ArrowBaseAngle int readwrite
ArrowLength int readwrite
ArrowScaleFactor int readwrite
ArrowScaleHead int readwrite
ArrowTipAngle int readwrite
ArrowType int readwrite
BasePointX int readwrite
BasePointY int readwrite
BorderWidth int readwrite
Color Color readwrite
Dash Metrics readwrite
Fill int readwrite
FrameParent FMObject readwrite
GraphicCantBeSelected int readwrite
GraphicIsSelected int readwrite
GroupParent Group readwrite
HeadArrow int readwrite
Height int readwrite
HotspotCmdStr string readwrite
HotspotTitle string readwrite
IsHotspot int readwrite
Language int readwrite
LineCap int readwrite
LocX int readwrite
LocY int readwrite
NextGraphicInDoc FMObject readonly
NextGraphicInFrame FMObject readwrite
NextGraphicInGroup FMObject readonly
NextSelectedGraphicInDoc FMObject readonly
ObjectAttributes StringsString
readwrite
Overprint int readwrite
Pen int readwrite
PrevGraphicInFrame FMObject readwrite
PrevGraphicInGroup FMObject readonly
Runaround int readwrite
RunaroundGap int readwrite
TailArrow int readwrite
TextLineType int readwrite
TintPercent int readwrite
Unique int readonly
Width int readwrite
Methods Instances
intDelete()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Return TextLineDoc.NewTextLine(parent:FrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
TextLoc
QuickLinks TextLoc
Properties Property Type Access Description
obj any readwrite
offset int readwrite
Methods ConstructorTextLocTextLoc(obj:any,offset:int)Parameter Type Description
obj any
offset int
Example newTextLoc()
Elementof AFrame.TextLocFn.TextLocMarker.TextLocTbl.TextLocTextRange.begTextRange.endTypedVal.tlval
Usedin: ObjectBook.Import(textLocP:TextLoc,filename:string,importParams:PropVals,importReturnParams:PropVals)
TextLocDoc.AddText(textLoc:TextLoc,text:string)TextRangeDoc.Find(textLoc:TextLoc,findParams:
PropVals)PropValDoc.GetTextPropVal(textLoc:TextLoc,propNum:
int)PropValsDoc.GetTextProps(textLoc:TextLoc)
TypedValDoc.GetTextVal(textLoc:TextLoc,propNum:int)
ObjectDoc.Import(textLocP:TextLoc,filename:string,importParams:PropVals,importReturnParams:PropVals)
AFrameDoc.NewAnchoredAFrame(textloc:TextLoc)FnDoc.NewAnchoredFn(textloc:TextLoc)ObjectDoc.NewAnchoredFormattedObject(objType:int,
format:string,textLoc:TextLoc)TblDoc.NewAnchoredFormattedTbl(format:string,
textLoc:TextLoc)VarDoc.NewAnchoredFormattedVar(format:string,
textLoc:TextLoc)XRefDoc.NewAnchoredFormattedXRef(format:string,
textLoc:TextLoc)MarkerDoc.NewAnchoredMarker(textloc:TextLoc)ObjectDoc.NewAnchoredObject(objType:int,textloc:
TextLoc)TblDoc.NewAnchoredTbl(textloc:TextLoc)TiApiClientDoc.NewAnchoredTiApiClient(textloc:
TextLoc)TblDoc.NewTable(format:string,numCols:int,
numBodyRows:int,numHeaderRows:int,numFooterRows:int,textLoc:TextLoc)
ElementLocDoc.TextLocToElementLoc(tloc:TextLoc)ElementElementDef.NewElement(textLoc:TextLoc)TextRangeTextRange.TextRange(beg:TextLoc,end:
TextLoc)
Return TextLocDoc.AddText(textLoc:TextLoc,text:string)TextLocDoc.ElementLocToTextLoc(eloc:ElementLoc)TextLocTextLoc.TextLoc(obj:any,offset:int)
Jongware,18-Jan-2015v1.0 Contents::Index
TextRange
QuickLinks TextRange
Properties Property Type Access Description
beg TextLoc readwrite
end TextLoc readwrite
Methods ConstructorTextRangeTextRange(beg:TextLoc,end:TextLoc)Parameter Type Description
beg TextLoc
end TextLoc
Example newTextRange()
Elementof Doc.TextSelectionElement.TextRangeRubi.OyamojiTextRangeRubi.RubiTextRangeTiApiClient.TextRangeTiFlow.TextRangeTiText.TextRangeTiTextTable.TextRangeTypedVal.trvalVar.TextRangeXRef.TextRange
Usedin: intDoc.CenterOnText(textRange:TextRange)intDoc.DeleteText(textRange:TextRange)TextItemsDoc.GetTextForRange(tr:TextRange,
flags:int)TextItemsDoc.GetTextForRange2(tr:TextRange,
flags:int,flags2:int)intDoc.ScrollToText(textRange:TextRange)voidDoc.SetTextPropVal(textRange:TextRange,
setVal:PropVal)voidDoc.SetTextProps(textRange:TextRange,
setVal:PropVals)voidDoc.SetTextVal(textRange:TextRange,
propNum:int,setVal:TypedVal)
Return TextRangeDoc.Find(textLoc:TextLoc,findParams:PropVals)
TextRangeTextRange.TextRange(beg:TextLoc,end:TextLoc)
Jongware,18-Jan-2015v1.0 Contents::Index
TiApiClient
QuickLinks ConvertToText,Delete,DeletePropByName,DeleteTextInsetContents,GetProps,GetText,ObjectValidSetProps,UpdateTextInset
Properties Property Type Access Description
ImportHint string readwrite
LastUpdate int readwrite
Name string readwrite
NextTiInDoc FMObject readonly
TextRange TextRange readonly
TiAutomaticUpdate int readwrite
TiClientData string readwrite
TiClientName string readwrite
TiClientSource string readwrite
TiClientType string readwrite
TiFile string readwrite
TiFileModDate string readwrite
TiIsUnresolved int readwrite
TiLocked int readwrite
TiMacEdition int readonly
Unique int readonly
Methods InstancesvoidConvertToText()
intDelete()
voidDeletePropByName(propName:string)Parameter Type Description
propName string
intDeleteTextInsetContents()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
intUpdateTextInset()
Return TiApiClientDoc.NewAnchoredTiApiClient(textloc:TextLoc)
Jongware,18-Jan-2015v1.0 Contents::Index
TiFlow
QuickLinks ConvertToText,Delete,DeletePropByName,DeleteTextInsetContents,GetProps,GetText,ObjectValid,SetProps,UpdateTextInset
Properties Property Type Access Description
ImportHint string readwrite
LastUpdate int readwrite
Name string readwrite
NextTiInDoc FMObject readonly
TextRange TextRange readonly
TiAutomaticUpdate int readwrite
TiFile string readwrite
TiFileModDate string readwrite
TiFlowName string readwrite
TiFlowPageSpace int readwrite
TiFormat int readwrite
TiLocked int readwrite
TiMacEdition int readonly
TiMainFlow int readwrite
TiRemoveOverrides int readwrite
TiRemovePageBreaks int readwrite
Unique int readonly
Methods Instances
voidConvertToText()
intDelete()
voidDeletePropByName(propName:string)Parameter Type Description
propName string
intDeleteTextInsetContents()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
intUpdateTextInset()
Jongware,18-Jan-2015v1.0 Contents::Index
TiText
QuickLinks ConvertToText,Delete,DeletePropByName,DeleteTextInsetContents,GetProps,GetText,ObjectValid,SetProps,UpdateTextInset
Properties Property Type Access Description
ImportHint string readwrite
LastUpdate int readwrite
Name string readwrite
NextTiInDoc FMObject readonly
TextRange TextRange readonly
TiAutomaticUpdate int readwrite
TiEOLisEOP int readwrite
TiFile string readwrite
TiFileModDate string readwrite
TiLocked int readwrite
TiMacEdition int readonly
TiTextEncoding string readonly
Unique int readonly
Methods InstancesvoidConvertToText()
intDelete()
voidDeletePropByName(propName:string)Parameter Type Description
propName string
intDeleteTextInsetContents()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
intUpdateTextInset()
Jongware,18-Jan-2015v1.0 Contents::Index
TiTextTable
QuickLinks ConvertToText,Delete,DeletePropByName,DeleteTextInsetContents,GetProps,GetText,ObjectValidSetProps,UpdateTextInset
Properties Property Type Access Description
ImportHint string readwrite
LastUpdate int readwrite
Name string readwrite
NextTiInDoc FMObject readonly
TextRange TextRange readonly
TiAutomaticUpdate int readwrite
TiByRows int readwrite
TiFile string readwrite
TiFileModDate string readwrite
TiHeadersEmpty int readwrite
TiLocked int readwrite
TiMacEdition int readonly
TiNumCols int readwrite
TiNumHeaderRows int readwrite
TiNumSeparators int readwrite
TiSeparator string readwrite
TiTblTag string readwrite
TiTextEncoding string readonly
Unique int readonly
Methods InstancesvoidConvertToText()
intDelete()
voidDeletePropByName(propName:string)Parameter Type Description
propName string
intDeleteTextInsetContents()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
intUpdateTextInset()
Jongware,18-Jan-2015v1.0 Contents::Index
TypedVal
Properties Property Type Access Description
adsval AttributeDefsAttributeDef
readwrite
asval Attribute readwrite
asvalEx AttributeEx readwrite
csval ElementCatalogEntriesElementCatalogEntry
readwrite
isval Ints readwrite
ival int readwrite
msval Metrics readwrite
obj any readwrite
osval Objects readwrite
psval Points Point readwrite
ssval Strings String readwrite
sval string readwrite
tlval TextLoc readwrite
trval TextRange readwrite
tsval Tabs Tab readwrite
uisval UInts readwrite
valType int readwrite
valsval TypedVals TypedVal readwrite
Elementof ElementDef.AlsoInsertsPropVal.propVal
Usedin: voidDoc.SetTextVal(textRange:TextRange,propNum:intsetVal:TypedVal)
voidGlobals.AppendVal(pv:PropVals,prop:int,val:TypedVal)
voidKeyCatalog.UpdateKeyDefinition(key:string,keyField:int,valuep:TypedVal)
PropValPropVal.PropVal(propIdent:PropIdent,propVal:TypedVal)
numberTypedVals.push(value:TypedVal)
Return TypedValDoc.GetTextVal(textLoc:TextLoc,propNum:int)
TypedValKeyCatalog.GetKeyDefinition(key:string,keyField:int)
TypedValTypedVals.pop()
Jongware,18-Jan-2015v1.0 Contents::Index
TypedVals AnArrayofTypedValobjectswithintegerindexing
andalengthproperty.SeealsoTypedVal.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesTypedValsconcat(value:TypedVals)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value TypedVals Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
TypedValpop()Removesthelastelementfromthearray.
numberpush(value:TypedVal)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value TypedVal
Elementof CMSProperty.valuesTypedVal.valsval
Usedin: boolCMSObject.CMSShowCommonListUI(commandId:int,title:string,columnProperties:TypedVals)
CMSPropertyCMSProperty.CMSProperty(prop:uint,label:string,isMultiValue:uint,isEditable:uint,values:TypedVals)
TypedValsTypedVals.concat(value:TypedVals)
Return TypedValsBook.GetDependencies(depMode:int)TypedValsDoc.GetDependencies(depMode:int)TypedValsGlobals.CallClientEx(clname:string,arg:
string)TypedValsKeyCatalog.GetAllKeyDefinitions
(filterType:int)TypedValsTypedVals.concat(value:TypedVals)
Jongware,18-Jan-2015v1.0 Contents::Index
UBytes AnArrayofuintobjectswithintegerindexingand
alengthproperty.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesUBytesconcat(value:UBytes)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value UBytes Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
uintpop()Removesthelastelementfromthearray.
numberpush(value:uint)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value uint
Usedin: voidInset.SetUBytesByName(propName:string,setVal:UBytes)
UBytesUBytes.concat(value:UBytes)
Return UBytesInset.GetUBytesByName(propName:string)UBytesUBytes.concat(value:UBytes)
Jongware,18-Jan-2015v1.0 Contents::Index
UInts AnArrayofuintobjectswithintegerindexingand
alengthproperty.
QuickLinks concat,pop,push
Properties Property Type Access Description
length number r/w Thelengthofthearray
Methods InstancesUIntsconcat(value:UInts)Returnsanewarraycreatedbyconcatenatingthegivenvaluestotheendoftheoriginalarray.Theoriginalarrayisunchanged.Ifanarrayisprovidedasaparametertoconcat(),eachofitselementsareappendedasseparatearrayelementsattheendofthenewarray.Returnsanewarray,theresultofconcatenationthegivenvaluestotheendoftheoriginalarray.Parameter Type Description
value UInts Anynumberofvaluestobeaddedtotheendofthearray.Canalsobearrays.
uintpop()Removesthelastelementfromthearray.
numberpush(value:uint)Placesvalueontotheendofthearray.Returnsthenewlengthofthearray.Parameter Type Description
value uint
Elementof Book.ViewOnlyDeadCodesCommand.Fcodes
Doc.ViewOnlyDeadCodesTypedVal.uisval
Usedin: UIntsUInts.concat(value:UInts)
Return UIntsUInts.concat(value:UInts)
Jongware,18-Jan-2015v1.0 Contents::Index
UnanchoredFrame
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type
Angle int
ArrowBaseAngle int
ArrowLength int
ArrowScaleFactor int
ArrowScaleHead int
ArrowTipAngle int
ArrowType int
BorderWidth int
Color Color
Dash Metrics
Fill int
FirstGraphicInFrame FMObject
FirstGraphicInFrame FMObject
FrameParent FMObject
GraphicCantBeSelected int
GraphicIsSelected int
GroupParent Group
HeadArrow int
Height int
HotspotCmdStr string
HotspotTitle string
IsHotspot int
LastGraphicInFrame FMObject
LastGraphicInFrame FMObject
LineCap int
LocX int
LocY int
Name string
NextGraphicInDoc FMObject
NextGraphicInFrame FMObject
NextGraphicInGroup FMObject
NextSelectedGraphicInDoc FMObject
ObjectAttributes StringsString
Overprint int
PageFramePage FMObject
Pen int
PrevGraphicInFrame FMObject
PrevGraphicInGroup FMObject
Runaround int
RunaroundGap int
TailArrow int
TintPercent int
Unique int
Width int
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type
setVal PropVals
Elementof BodyPage.PageFrameHiddenPage.PageFrameMasterPage.PageFrameRefPage.PageFrame
Return UnanchoredFrameDoc.GetNamedUnanchoredFramestring)
UnanchoredFrameDoc.NewUnanchoredFrameFrameObject)
Jongware,18-Jan-2015v1.0 Contents::Index
Var
QuickLinks Delete,GetProps,GetText,ObjectValid,SetProps
Properties Property Type Access Description
Element Element readonly
Locked int readwrite
NextVarInDoc Var readonly
TextRange TextRange readonly
Unique int readonly
UserString string readwrite
VarFmt VarFmt readwrite
Methods InstancesintDelete()
PropValsGetProps()
TextItemsGetText(flags:int)Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstVarInDocVar.NextVarInDoc
Return VarDoc.NewAnchoredFormattedVar(format:string,textLoc:TextLoc)
Jongware,18-Jan-2015v1.0 Contents::Index
VarFmt
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Fmt string readwrite
Name string readwrite
NextVarFmtInDoc VarFmt readonly
SystemVar int readonly
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstVarFmtInDocVar.VarFmtVarFmt.NextVarFmtInDoc
Return VarFmtDoc.GetNamedVarFmt(name:string)VarFmtDoc.NewNamedVarFmt(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
XRef
QuickLinks Delete,GetProps,GetText,ObjectValid,SetProps
Properties Property Type Access Description
Element Element readonly
Locked int readwrite
NextXRefInDoc XRef readonly
TextRange TextRange readonly
Unique int readonly
UserString string readwrite
XRefAltText string readwrite
XRefClientName string readwrite
XRefClientType string readwrite
XRefFile string readwrite
XRefFmt XRefFmt readwrite
XRefIsUnresolved int readonly
XRefSrcElemNonUniqueId string readwrite
XRefSrcIsElem int readwrite
XRefSrcText string readwrite
Methods InstancesintDelete()
PropValsGetProps()
TextItemsGetText(flags:int)
Parameter Type Description
flags int
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstXRefInDocXRef.NextXRefInDoc
Usedin: intDoc.UpdateXRef(srcDoc:Doc,xref:XRef)
Return XRefDoc.NewAnchoredFormattedXRef(format:string,textLocTextLoc)
Jongware,18-Jan-2015v1.0 Contents::Index
XRefFmt
QuickLinks Delete,GetProps,ObjectValid,SetProps
Properties Property Type Access Description
Fmt string readwrite
Name string readwrite
NextXRefFmtInDoc XRefFmt readonly
Methods InstancesintDelete()
PropValsGetProps()
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Elementof Doc.FirstXRefFmtInDocXRef.XRefFmtXRefFmt.NextXRefFmtInDoc
Return XRefFmtDoc.GetNamedXRefFmt(name:string)XRefFmtDoc.NewNamedXRefFmt(name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
app
QuickLinks Close,GetNamedBook,GetNamedCommand,GetNamedMenu,GetNamedMenuItemSeparator,GetNamedObject,GetProps,NewNamedBookNewNamedCommand,NewNamedMenu,NewNamedMenuItemSeparatorNewNamedObject,ObjectValid,SetProps
Properties Property Type Access
ActiveBook Book readwrite
ActiveDoc Doc readwrite
ActiveView string readwrite
AddMarkerTypeToStandardMarkers string readwrite
AllowNewFileURL bool readwrite
ApplyFormatRules int readwrite
AutoBackup int readwrite
AutoSave int readwrite
AutoSaveSeconds int readwrite
BinDir string readonly
CharacterReferencesOnXMLExport bool readwrite
CurrentDir string readonly
CurrentMenuSet int readwrite
DefaultKeyCatalog KeyCatalog readwrite
DefaultVectorFormatForXMLExport string readwrite
DisplayName string readonly
Displaying int readwrite
DoNotExportInvalidXML bool readwrite
DoNotGenerateErrorLog int readwrite
DoPostXSLTValidationOnExport bool readwrite
DocOpenClientEncounteredErrors int readwrite
DontShowWelcomeScreen bool readwrite
EnableAutoSpellCheck bool readwrite
FMConsoleString string readwrite
FirstCommandInSession Command readwrite
FirstKeyCatalogInSession KeyCatalog readonly
FirstMenuItemInSession FMObject readonly
FirstOpenBook Book readonly
FirstOpenDoc Doc readonly
FontAngleNames StringsString
readonly
FontFamilyAttributes Ints readonly
FontFamilyNames StringsString
readonly
FontVariationNames StringsString
readonly
FontWeightNames StringsString
readonly
Gravity int readwrite
GreekSize int readwrite
HelpDir string readonly
HomeDir string readonly
HostName string readonly
IconBarOn int readwrite
InitDir string readonly
InsetURL bool readwrite
IsFMRunningInTrialPeriod bool readwrite
IsIconified int readwrite
IsInFront int readwrite
IsOnScreen int readwrite
IsTechnicalSuiteLicensed int readonly
IsTempOpenSave int readonly
KeyCatalogWorkflow int readwrite
Label string readwrite
Language int readonly
MarkerNames StringsString
readonly
No3DInPDF bool readwrite
NoFlashInPDF bool readwrite
NoMultiMediaInPDF bool readwrite
OpenAndSaveXmlBookComponentDoc bool readwrite
OpenDir string readwrite
OperatingSystem string readonly
Path string readonly
Platform string readonly
ProcessNumber int readwrite
ProductFamily string readonly
ProductIsDemo bool readwrite
ProductIsStructured bool readwrite
ProductName string readonly
Reformatting int readwrite
RememberMissingFontNames int readwrite
RemoveExtraWhiteSpacesOnXMLImport bool readwrite
RpcProgramNumber int readwrite
RpcPropertyName string readwrite
ScreenHeight int readwrite
ScreenWidth int readwrite
ScreenX int readwrite
ScreenY int readwrite
SgmlDir string readonly
Snap int readwrite
StackWarningLevel int readwrite
StructureDir string readonly
SuppressXMLParserWarnings bool readwrite
TechSuiteInternal int readwrite
TmpDir string readonly
UndoFDKRecording bool readwrite
UserHomeDir string readonly
UserLogin string readonly
UserName string readonly
UserSettingsDir string readonly
UserString string readwrite
Validating int readwrite
VersionMajor int readonly
VersionMinor int readonly
VersionRevision int readonly
WindowSystem string readonly
XmlDir string readonly
XmlIsBook bool readwrite
Methods InstancesintClose(flags:int)Parameter Type Description
flags int
BookGetNamedBook(name:string)Parameter Type Description
name string
CommandGetNamedCommand(name:string)Parameter Type Description
name string
MenuGetNamedMenu(name:string)Parameter Type Description
name string
MenuItemSeparatorGetNamedMenuItemSeparator(name:stringParameter Type Description
name string
ObjectGetNamedObject(objType:int,name:string)Parameter Type Description
objType int
name string
PropValsGetProps()
BookNewNamedBook(name:string)Parameter Type Description
name string
CommandNewNamedCommand(name:string)Parameter Type Description
name string
MenuNewNamedMenu(name:string)Parameter Type Description
name string
MenuItemSeparatorNewNamedMenuItemSeparator(name:stringParameter Type Description
name string
ObjectNewNamedObject(objType:int,name:string)Parameter Type Description
objType int
name string
intObjectValid()
voidSetProps(setVal:PropVals)Parameter Type Description
setVal PropVals
Jongware,18-Jan-2015v1.0 Contents::Index
ContentsJavaScriptBaseClasses
BasicJavaScriptprogrammingstartshere.
AdobeFrameMaker-12.0JavaScriptBaseClassesScriptUIClasses
$ArrayBooleanDateErrorFileFolderFunctionGlobalElementsMath(JS)NamespaceNumberObjectQNameReflectionReflectionInfoRegExpSocketStringUnitValueXMLXMLList
Jongware,18-Jan-2015v1.0 Contents::Index
$ 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.
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()
Jongware,18-Jan-2015v1.0 Contents::Index
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])
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])
BooleanFlashPlayer.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])
BooleanGroup(SUI).addEventListener(eventName:String,handler:Function[,capturePhase:
Boolean=false])BooleanGroup(SUI).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(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])
BooleanProgressbar.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])
BooleanProgressbar.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])
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(SUI).addEventListener(eventName:
String,handler:Function[,capturePhase:Boolean=false])
BooleanStaticText(SUI).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])
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:
String,handler:Function[,capturePhase:Boolean=false])
Jongware,18-Jan-2015v1.0 Contents::Index
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)
Anintegervaluefrom0to999.Ifthisargumentisnotsupplied,itsvalueissetto0.(default:0)(Optional)
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.
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)
Anintegervaluefrom0to999.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
ms number(range:0-999)
Anintegervaluefrom0to999.
Example date.setMilliseconds(ms)
numbersetMinutes(minutes:number)SetstheminutesofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970.Parameter Type Description
minutes number(range:0-59)
Anintegervaluefrom0to59.
Example date.setMinutes(minutes)
numbersetMonth(month:number)SetsthemonthofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateandmidnight,January1,1970.Parameter Type Description
month number(range:0-11)
Anintegervaluefrom0(Jan)to11(Dec).
Example date.setMonth(month)
numbersetSeconds(seconds:number)SetsthesecondsofaspecifiedDateobjectaccordingtolocaltime.Returnsthenumberofmillisecondsbetweenthenewdateand
midnight,January1,1970.Parameter Type Description
seconds number(range:0-59)
Anintegervaluefrom0to59.
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
hours number(range:0-23)
Anintegervaluefrom0(midnight)to23(11PM)indicatingthehourtobeset.
Example date.setUTCHours(hours)
numbersetUTCMilliseconds(ms:number)SetsthemillisecondsofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970,inUTC.Parameter Type Description
ms number(range:0-999)
Anintegervalueintherangeof0to999indicatingthenumberofmillisecondstoset.
Example date.setUTCMilliseconds(ms)
numbersetUTCMinutes(min:number)SetstheminutesofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970,inUTC.Parameter Type Description
min number(range:0-59)
Anintegervalueintherange0to59indicatingthenumberofminutestobeset.
Example date.setUTCMinutes(min)
numbersetUTCMonth(month:number)SetsthemonthofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetand
midnight,January1,1970,inUTC.Parameter Type Description
month number(range:0-11)
Anintegervalueintherange0(Jan.)to11(Dec.)indicatingthemonthtoset.
Example date.setUTCMonth(month)
numbersetUTCSeconds(sec:number)SetsthesecondsofaspecifiedDateobjectaccordingtoUTC.Returnsthenumberofmillisecondsbetweenthedatesetandmidnight,January1,1970,inUTC.Parameter Type Description
sec number(range:0-59)
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.
stringtoSource()Createsastringrepresentationofthisobjectthatcanbefedbacktoeval()tore-createanobject.Worksonlywithbuilt-inclasses.
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)
Jongware,18-Jan-2015v1.0 Contents::Index
Error Wrapsaruntimeerror.
QuickLinks Error,toSource,toString
Properties Property Type Access Description
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])
Jongware,18-Jan-2015v1.0 Contents::Index
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
Properties Property Type Access Description
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.
Class Property Type Access Description
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.
stringtoString()Convertsthisobjecttoastring.
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 Reflection.sampleFileReflectionInfo.sampleFile
Usedin: any$.evalFile(file:File[,timeout:number=10000])boolFile.copy(target:string|File)voidFlashPlayer.loadMovie(file:File)
Return 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])
Jongware,18-Jan-2015v1.0 Contents::Index
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
Properties Property Type Access Description
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.
Class Property Type Access Description
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.
stringtoString()Convertsthisobjecttoastring.
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)
Jongware,18-Jan-2015v1.0 Contents::Index
Function Wrapsabuilt-inorJavaScriptfunction.
QuickLinks Function,apply,call,toSource,toString
Properties Property Type Access Description
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:
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])
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])
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:
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])
BooleanWindow.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])
BooleanWindow.removeEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])
Return FunctionFunction.Function(arguments:string,body:string)
Jongware,18-Jan-2015v1.0 Contents::Index
GlobalElements TheglobalmethodsandpropertiesforExtendScript.
QuickLinks alert,confirm,decodeURI,decodeURIComponent,encodeURI,encodeURIComponent,escape,eval,isFinite,isNaN,isXMLName,localize,parseFloat,parseInt,prompt,setDefaultXMLNamespace,unescape,uneval
Properties Property Type Access Description
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])Displaysanalertbox
Parameter 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,wherexxisthehexvalueof
thecharacter.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-encodedstringandmergesadditional
argumentsintothestring.Parameter Type Description
what string Thestringtolocalize.AZString-encodedstringthatcancontainplaceholderforadditionalargumentsintheform%1to%n.
argument any Optionalargument(s)tobemergedintothestring.Theremaybemorethanoneargument.(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,baseisdeterminedbytheformatof
string.(Optional)
Example parseInt(aString,base)
stringprompt(prompt:string[,default:string][,title:string])DisplaysadialogallowingtheusertoentertextReturnsnulliftheusercancelledthedialog,thetextotherwiseParameter Type Description
prompt string Thetexttodisplay
default string Thedefaulttexttopresettheeditfieldwith(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.
Jongware,18-Jan-2015v1.0 Contents::Index
Math(JS) Aglobalobjectcontainingasetofmathfunctionsand
constants.
QuickLinks abs,acos,asin,atan,atan2,ceil,cos,exp,floor,log,max,min,pow,random,round,sin,sqrt,tan
Class Property Type Access Description
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
x number Anangle,inradians.
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
x number Anangle,inradians.
Example Math.tan(x)
Jongware,18-Jan-2015v1.0 Contents::Index
Namespace AXMLnamespaceobject.
QuickLinks Namespace
Properties Property Type Access Description
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: voidGlobalElements.setDefaultXMLNamespace(namespace:Namespace)
XMLXML.addNamespace(namespace:Namespace)
XMLXML.removeNamespace(namespace:
Namespace)voidXML.setNamespace(namespace:Namespace)
Return NamespaceNamespace.Namespace(prefix:any[,uri:string])
NamespaceXML.namespace()
Jongware,18-Jan-2015v1.0 Contents::Index
Number Wrapsanumericvalue.
QuickLinks Number,toExponential,toFixed,toLocaleString,toPrecision,toString,valueOf
Class Property Type Access Description
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
decimals number Thenumberofdecimals.
numbertoLocaleString()ReturnsthevalueofaNumberobjectconvertedtoastring,usinglocalizedconventions.
numbertoPrecision(decimals:number)ConvertstheNumberobjecttoastringineitherscientificorfixednotation,ependingonitsvalue.Parameter Type Description
decimals number Thenumberofdecimals.
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)
Jongware,18-Jan-2015v1.0 Contents::Index
Object ThebaseclassofallJavaScriptobjects.
QuickLinks Object,hasOwnProperty,isPrototypeOf,isValid,propertyIsEnumerable,toLocaleString,toSource,toString,unwatch,valueOf,watch
Properties Property Type Access Description
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$.screensButton.childrenButton.parentButton.propertiesCheckbox.childrenCheckbox.parentCheckbox.propertiesDropDownList.childrenDropDownList.parentDropDownList.propertiesEditText.childrenEditText.parentEditText.propertiesEvent.targetFlashPlayer.parentFlashPlayer.propertiesFunction.argumentsGroup.childrenGroup.parentGroup.propertiesIconButton.childrenIconButton.parentIconButton.propertiesListBox.childrenListBox.columnsListBox.parentListBox.propertiesListItem.parentListItem.propertiesObject.prototypePanel.childrenPanel.parent
Panel.propertiesProgressbar.childrenProgressbar.parentProgressbar.propertiesRadioButton.childrenRadioButton.parentRadioButton.propertiesScriptUI.FontStyleScriptUI.applicationFontsScriptUI.compatibilityScriptUIFont.styleScriptUIGraphics.BrushTypeScriptUIGraphics.PenTypeScrollbar.childrenScrollbar.parentScrollbar.propertiesSlider.childrenSlider.parentSlider.propertiesStaticText.childrenStaticText.parentStaticText.propertiesTreeView.childrenTreeView.parentTreeView.propertiesUIEvent.targetWindow.cancelElementWindow.childrenWindow.defaultElementWindow.parentWindow.properties
Usedin: BookComponentBook.NewSeriesBookComponent(previous:Object)
ObjectBook.NewSeriesObject(objType:int,previous:Object)
intDoc.AddTableVariables(tblFormatOrTblId:Object,allTables:bool,insertContVariable:bool,insertSheetVariable:bool)
intDoc.DeleteUndefinedAttribute(attrName:string,scope:int,objId:Object)
BodyPageDoc.NewSeriesBodyPage(previous:Object)ObjectDoc.NewSeriesObject(objType:int,previous:Object)PgfDoc.NewSeriesPgf(previous:Object)intDoc.SetAttributeSimple(attrName:string,attrValStr:
string,scope:int,objId:Object)anyFunction.apply(thisObj:Object,args:Array)anyFunction.call(thisObj:Object,argument:any)intGlobals.Externalize(srcDocId:Object,objId:Object,
dstFolder:string)boolGlobals.IsFileValid(docOrBookId:Object,silent:bool)ObjectGroup.add(type:String[,bounds:Bounds][,text:
String][,properties:Object])intMenu.AnimateMenu(menuitem:Object,sleep:int,
realLabel:string,docOrBook:Object,action:bool)boolObject.isPrototypeOf(what:Object)boolObject.isValid(what:Object)ObjectPanel.add(type:String[,bounds:Bounds][,text:
String][,properties:Object])UIEventUIEvent.UIEvent(type:String[,captures:
Boolean=false][,bubbles:Boolean=false][,view:Object][,detail:Number])
voidUIEvent.initUIEvent(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 ObjectBook.GetUniqueObject(objType:int,unique:int)ObjectBook.Import(textLocP:TextLoc,filename:string,
importParams:PropVals,importReturnParams:PropVals)ObjectBook.NewIterator(paramsp:PropVals)ObjectBook.NewSeriesObject(objType:int,previous:
Object)ObjectBook.Save(saveAsName:string,saveParams:
PropVals,saveReturnParams:PropVals)ObjectCMSObject.CMSOpenFile(openParams:
IdValuePairs)ObjectDoc.GetNamedObject(objType:int,name:string)ObjectDoc.GetUniqueObject(objType:int,unique:int)ObjectDoc.Import(textLocP:TextLoc,filename:string,
importParams:PropVals,importReturnParams:PropVals)ObjectDoc.NewAnchoredFormattedObject(objType:int,
format:string,textLoc:TextLoc)ObjectDoc.NewAnchoredObject(objType:int,textloc:
TextLoc)ObjectDoc.NewGraphicObject(objType:int,parent:
FrameObject)ObjectDoc.NewIterator(paramsp:PropVals)ObjectDoc.NewNamedObject(objType:int,name:string)ObjectDoc.NewSeriesObject(objType:int,previous:Object)ObjectDoc.Save(saveAsName:string,saveParams:
PropVals,saveReturnParams:PropVals)ObjectGlobals.NewXML(newXMLParams:PropVals,
newXMLReturnParamspp:PropVals)ObjectGlobals.Open(fileName:string,openParams:
PropVals,openReturnParams:PropVals)ObjectGlobals.SimpleOpen(fileName:string,interactive:
int)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()Objectapp.GetNamedObject(objType:int,name:string)Objectapp.NewNamedObject(objType:int,name:string)
Jongware,18-Jan-2015v1.0 Contents::Index
QName AqualifiedXMLname,containingtheURIandthelocal
name.
QuickLinks QName
Properties Property Type Access Description
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()
Jongware,18-Jan-2015v1.0 Contents::Index
Reflection Providesinformationaboutaclass.
QuickLinks find,toXML
Properties Property Type Access Description
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
Jongware,18-Jan-2015v1.0 Contents::Index
ReflectionInfo Providesinformationaboutamethod,apropertyora
methodparameters.
Hierarchy Reflection
ReflectionInfo
Properties Property Type Access Description
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)
RegExp Wrapsaregularexpression.
QuickLinks RegExp,compile,exec,test,toString
Class Property Type Access Description
$1 string readonly Thematchedsubexpression#1.
$2 string readonly Thematchedsubexpression#2.
$3 string readonly Thematchedsubexpression#3.
$4 string readonly Thematchedsubexpression#4.
$5 string readonly Thematchedsubexpression#5.
$6 string readonly Thematchedsubexpression#6.
$7 string readonly Thematchedsubexpression#7.
$8 string readonly Thematchedsubexpression#8.
$9 string readonly Thematchedsubexpression#9.
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])
Jongware,18-Jan-2015v1.0 Contents::Index
Socket CreatesaTCP/IPconnection,orestablishesaTCP/IPserver.
QuickLinks Socket,close,listen,open,poll,read,readln,write,writeln
Properties Property Type Access Description
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()
Jongware,18-Jan-2015v1.0 Contents::Index
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
Properties Property Type Access Description
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()Returnsastringconsistingofthisstringenclosedina<b>tag.
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)Returnsastringconsistingofthisstringenclosedina<font>tag.Parameter Type Description
color string Thevaluetobestoredinthetag'scolorattribute.
stringfontsize(size:number)Returnsastringconsistingofthisstringenclosedina<font>tag.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()Returnsastringconsistingofthisstringenclosedina<i>tag.
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()Returnsastringconsistingofthisstringenclosedina<small>tag.
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()Returnsastringconsistingofthisstringenclosedina<sub>tag.
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()Returnsastringconsistingofthisstringenclosedina<sup>tag.
stringtoLocaleLowerCase()Returnsanewstringwhichcontainsallthecharactersoftheoriginalstringconvertedtolowercase(localized).Theoriginalstringisunchanged.
stringtoLocaleUpperCase()Returnsanewstringwhichcontainsallthecharactersoftheoriginalstringconvertedtouppercase(localized).Theoriginalstringisunchanged.
stringtoLowerCase()Returnsanewstringwhichcontainsallthecharactersoftheoriginalstringconvertedtolowercase.Theoriginalstringisunchanged.
Example string.toLowerCase()
stringtoSource()Createsastringrepresentationofthisobjectthatcanbefedbacktoeval()tore-createanobject.Worksonlywithbuilt-inclasses.
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:
String,handler:Function[,capturePhase:Boolean=false])
ListItemDropDownList.find(text:String)voidDropDownList.notify([eventName:String])BooleanDropDownList.removeEventListener(eventName:
String,handler:Function[,capturePhase:Boolean=false])
BooleanEditText.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])
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:
String,handler:Function[,capturePhase:Boolean=false])
ObjectGroup.add(type:String[,bounds:Bounds][,text:String][,properties:Object])
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])
voidIconButton.notify([eventName:String])BooleanIconButton.removeEventListener(eventName:
String,handler:Function[,capturePhase:Boolean=false])
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])
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])
voidRadioButton.notify([eventName:String])BooleanRadioButton.removeEventListener(eventName:
String,handler:Function[,capturePhase:Boolean=false])
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)
BooleanScrollbar.addEventListener(eventName:String,handler:Function[,capturePhase:Boolean=false])
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])
voidUIEvent.initUIEvent(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])
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])
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])
UnitValue Representsameasurementasacombinationofvalues
andunit.Notethatthisobjectisnotavailableinallapplications.
QuickLinks as,convert
Properties Property Type Access Description
baseUnit UnitValue r/w Thebaseunit.
type string readonly Theunitname.
value number r/w Thenumericvalue.
Class Property Type Access Description
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)
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
Class Property Type Access Description
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)
Jongware,18-Jan-2015v1.0 Contents::Index
XMLList AnXMLlistobject.
Inthisimplementation,anXMLListobjectissynonymoustotheXMLobject.TheconstructoracceptsanXMLlist,buteverythingelseworksliketheXMLobject.
Jongware,18-Jan-2015v1.0 Contents::Index
Contents ScriptUIClasses
Don'tlikethepanelsanddialogsAdobecameupwith?Createyourownandseeifyoucandobetter.
AdobeFrameMaker-12.0JavaScriptBaseClassesScriptUIClasses
BoundsButton(SUI)Checkbox(SUI)DimensionDrawStateDropDownListEditTextEnvironmentEvent(SUI)Events(SUI)FlashPlayerGroup(SUI)IconButtonKeyboardStateLayoutManagerListBox(SUI)ListItemPanel(SUI)Point(SUI)ProgressbarRadioButton(SUI)ScriptUIScriptUIBrushScriptUIFontScriptUIGraphicsScriptUIImageScriptUIPathScriptUIPenScrollbarSliderStaticText(SUI)TreeViewUIEventWindow(SUI)
Jongware,18-Jan-2015v1.0 Contents::Index
Bounds Definestheboundariesofawindowwithinthescreen's
coordinatespace,orofaUIelementwithinthecontainer'scoordinatespace.ABoundsobjectiscreatedwhenyousetanelement'sboundsproperty.YoucansetthepropertyusingaJavaScriptobjectwithpropertiesnamedleft,top,right,bottomorx,y,width,height,oranarraywith4valuesintheorder[x,y,wd,ht].
Properties Property Type Access Description
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])
voidWindow.Window(type:String[,title:String][,bounds:Bounds][,properties:Object])
ObjectWindow.add(type:String[,bounds:Bounds][,text:String][,properties:Object])
Jongware,18-Jan-2015v1.0 Contents::Index
Button(SUI) Apushbuttonelementcontainingamouse-sensitivetextstring.
CallstheonClick()callbackifthecontrolisclickedorifitsnotify()iscalled.
QuickLinks addEventListener,dispatchEvent,hide,notify,onActivate,onClickonDeactivate,onDraw,onShortcutKey,removeEventListener,show
Hierarchy Object
Button(SUI)
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrensettingfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandvertical
alignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,right
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeoftheelement.
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 Thetextjustificationstyle.(default:left)Oneofleft,centerJustificationonlyworksifthisvalueissetoncreationoftheelement.
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.Ifnotexplicitlysetbya
script,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.
properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).AButtonobjecthasnocreationproperties,butthethirdargumenttotheadd()methodthatcreatesitcanbetheinitialtextvalue.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.Ascriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishan
elementsizeotherthanthepreferredSizeorthedefaultsize,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,calledwhentheelementhasbeen
clicked
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])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestor
ofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
BooleanremoveEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-
Checkbox(SUI) Adual-statecontrolshowingaboxthathasacheckmarkwhenthe
true,andisemptywhenthevalueisfalse.CallstheonClick()callbackifthecontrolisclickedorifitsiscalled.
QuickLinks addEventListener,dispatchEvent,hide,notify,onActivateonDeactivate,onDraw,onShortcutKey,removeEventListener
Hierarchy Object
Checkbox(SUI)
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththe
horizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right•Fororientation=stack:bottom,left
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeoftheelement.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
justify String r/w Thedefaulttextjustificationstyleforchildtextelements.(default:leftOneofleftJustificationonlyworksifthisvalueissetoncreationoftheelement.
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,usedbylayoutmanagerstodeterminethebestsizefor
eachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.
properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesoftheitem(propertiesusedonlywhentheelementiscreated).ACheckBoxobjecthasnocreationproperties.Thethirdargumenttotheadd()methodthatcreatesitisthetexttobedisplayed.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.Ascriptcanexplicitlysetsizebefore
thelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizesize,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.
visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.
window Window(SUI) readonly Thewindowthatthiselementbelongsto.
windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-level
parentwindow.
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:capturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptTools
Guide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
BooleanremoveEventListener(eventName:String,handlercapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
Dimension DefinesthesizeofawindoworUIelement.Contains
a2-elementarray.Specifiestheheightandwidthofanelementinpixels.ADimensionobjectiscreatedwhenyousetanelement'ssizeproperty.YoucansetthepropertyusingaJavaScriptobjectwithnamedproperties{width:wd,height:ht},oranarraywith2valuesintheorder[wd,ht].
Properties Property Type Access Description
height Number r/w Theheightinpixels.
length Number readonly Thearraylength.(default:2)
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])
Jongware,18-Jan-2015v1.0 Contents::Index
DrawState Describesaninputstateatthetimeofthetriggering
ScriptUIGraphics.onDraw()event.Containspropertiesthatreportwhetherthecurrentcontrolhastheinputfocus,andtheparticularmousebuttonandkeypressstate.PassedinasargumenttoScriptUIGraphics.onDraw().
Properties Property Type Access Description
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.
DropDownList Displaysasinglevisibleitem.Whenyouclickthecontrol,alistdropsdown
orpopsup,andallowsyoutoselectoneoftheotheritemsinthelist.Drop-downlistscanhavenonselectableseparatoritemsforvisuallyseparatinggroupsofrelateditems,asinamenu.Youcanspecifytheitemsoncreationofthelistobject,orafterwardusingthelistobject'sYoucanremoveitemsprogrammaticallywiththelistobject'sremove()andremoveAll()methods.CallstheonChange()callbackiftheitemselectionischangedorifitsnotify()methodiscalled.
QuickLinks add,addEventListener,dispatchEvent,find,hideonChange,onDeactivate,onDraw,onShortcutKeyremoveEventListener,show
Hierarchy Object
DropDownList
Properties Property Type Access
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
location Point r/w
maximumSize Dimension r/w
minimumSize Dimension r/w
parent Object readonly
preferredSize Dimension r/w
properties Object r/w
size Dimension r/w
type String readonly
visible Boolean r/w
window Window(SUI) readonly
windowBounds Bounds readonly
Methods EventsvoidonActivate()Anevent-handlercallbackfunction,calledwhentheelementacquiresthekeyboardfocus.Calledwhentheusergivesthecontrolthekeyboardfocusbyclickingitortabbingintoit.
voidonChange()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementhasbeenchanged
voidonDeactivate()Anevent-handlercallbackfunction,calledwhentheelementlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviouslyactivecontroltoanothercontrol.
voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.
voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement'sshortcutKeysequenceistypedintheactivewindow.InWindowsonly.
InstancesListItemadd(type:String[,text:String])Addsanitemorseparatortothechoicesinthislist.Returnstheitemcontrolobjectfortype="item",ornullfortype="separator".Parameter Type Description
type String Thetypeofthechildelement.Eitheritem(abasic,selectableitemwithatextlabel)
orseparator
text String Thelocalizabletextlabelfortheitem.
BooleanaddEventListener(eventName:StringcapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
ListItemfind(text:String)Retrievesanitemobjectfromthelistthathasagiventextlabel.Parameter Type Description
text String Thetextstringtomatch.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChangesimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
voidremove(what:Any)Removesachilditemfromthelist.Parameter Type Description
what Any Theitemorchildtoremove,specifiedby0-basedindex,textvalue,orasaListItemobject.
voidremoveAll()Removesallchilditemsfromthelist.
BooleanremoveEventListener(eventName:StringcapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
EditText Aneditabletextfieldthattheusercanselectandchange.
CallstheonChange()callbackifthetextischangedandtheusertypesEnterorthecontrollosesfocus,orifitsnotify()methodiscalled.CallstheonChanging()callbackwhenanychangeismadetothetext.Thetextselectionpropertycontainscurrentlyselectedtext.
QuickLinks addEventListener,dispatchEvent,hide,notify,onActivate,onChangeonChanging,onDeactivate,onDraw,onShortcutKey,removeEventListenershow
Hierarchy Object
EditText
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
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,
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeoftheelement.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
justify String r/w Thetextjustificationstyle.(default:left)Oneofleft,centerJustificationonlyworksifthisvalueissetoncreationoftheelement.
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).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()theeditabletextischangedandtheusertypesEnter;otherchangestothekeyboardfocusdonotsignaltheevent.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizesize,butthisisnotrecommended.Definedas
[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.
text String r/w Thecurrenttextdisplayedinthefield,alocalizablestring.
textselection String r/w Thecurrentlyselectedtext,ortheemptystringifthereisnotextselected.Settingthevaluereplacesthecurrenttextselectionandmodifiesthevalueofthetextproperty.Ifthereisnocurrentselection,insertsthenewvalueintothetextstringatthecurrentinsertionpoint.Thetextselectionvalueisresettoanemptystringafteritmodifiesthetextvalue.Notethatsettingthetextselectionpropertybeforetheelement'sparentWindowexistsisanundefinedoperation.
type String readonly Theelementtype;"edittext".
visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.
window Window(SUI) readonly Thewindowthatthiselement
belongsto.
windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-levelparentwindow.
Methods EventsvoidonActivate()Anevent-handlercallbackfunction,calledwhentheelementacquiresthekeyboardfocus.Calledwhentheusergivesthecontrolthekeyboardfocusbyclickingitortabbingintoit.
voidonChange()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementhasbeenchangedThehandleriscalledonlywhenthechangeiscomplete–thatis,whenfocusmovestoanothercontrol,ortheusertypesEnter.TheexactbehaviordependsonthecreationparameterenterKeySignalsOnChange;seetheproperty.
voidonChanging()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementisintheprocessofchangingThehandleriscalledforeachkeypresswhilethiscontrolhastheinputfocus.
voidonDeactivate()Anevent-handlercallbackfunction,calledwhentheelementlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviouslyactivecontroltoanothercontrol.
voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.
voidonShortcutKey()Anevent-handlercallbackfunction,calledwhenthe
element'sshortcutKeysequenceistypedintheactivewindow.InWindowsonly.
InstancesBooleanaddEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.
Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
BooleanremoveEventListener(eventName:String,handlercapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
Environment DefinesattributesoftheScriptUIenvironment.
AccessthroughtheScriptUI.environmentproperty.
Properties Property Type Access Description
keyboardState KeyboardState readonly Anobjectthatreportstheactivestateofthekeyboardatanytime.Providesaccesstothekeystateindependentoftheevent-handlingframework.
Elementof ScriptUI.environment
Jongware,18-Jan-2015v1.0 Contents::Index
Event(SUI) BaseclassforUIEvent.
Encapsulatesinputeventinformationforaneventthatpropagatesthroughacontainerandcontrolhierarchy.ImplementsW3Cstandardeventhandling.
QuickLinks preventDefault,stopPropagation
Properties Property Type Access Description
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.
Class Property Type Access Description
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)
Jongware,18-Jan-2015v1.0 Contents::Index
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".
Jongware,18-Jan-2015v1.0 Contents::Index
FlashPlayer AcontrolthatcontainsaFlashPlayer,whichcanloadandplay
FlashmoviesstoredinSWFfiles.TheScriptUIFlashPlayerelementrunstheFlashapplicationwithinanAdobeapplication.TheFlashapplicationrunsActionScript,adifferentimplementationofJavaScriptfromtheExtendScriptversionofJavaScriptthatAdobeapplicationsrun.AcontrolobjectofthistypecontainsfunctionsthatallowyourscripttoloadSWFfiles,controlmovieplayback,andcommunicatewiththeActionScriptenvironment.
QuickLinks addEventListener,callback,dispatchEvent,hide,invokePlayerFunction,loadMovie,notify,playMovieremoveEventListener,show,stopMovie
Hierarchy Object
FlashPlayer
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
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.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0)
r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.
maximumSize Dimension r/w Themaximumheight
andwidthtowhichtheelementcanberesized.
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).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.
windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-levelparentwindow.
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
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunction
definedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.(default:falseDefaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
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.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
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
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:false
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
voidstopMovie()Haltsplaybackofthecurrentmovie.ThestopMovie()-playMovie()sequencedoesnotworkforSWFfilesproducedbyFlex,orforsomefilesproducedbyFlashAuthoring(dependingonhowtheywereimplemented).UsingstopMovie()fromtheplayer'shostingenvironmenthasnoeffectonanSWFfileplayinginaScriptUIFlashPlayerelement.Itis,however,possibletoproduceanSWFusingFlashAuthoringthatcanstopitselfinresponsetouserinteraction.
Jongware,18-Jan-2015v1.0 Contents::Index
Group(SUI) Acontainerforothercontrolswithinawindow.
Agroupcanspecifylayoutoptionsforitschildelements.Hidingagrouphidesallitschildren.Makingitvisiblemakesvisiblethosechildrenthatarenotindividuallyhidden.
QuickLinks add,addEventListener,dispatchEvent,hide,onDraw,remove,removeEventListener,show
Hierarchy Object
Group(SUI)
Properties Property Type Access Description
alignChildren String r/w Tellsthelayoutmanagerhowunlike-sizedchildrenofthiscontainershouldbealignedwithinacolumnorrow.Orderofcreationdetermineswhichchildrenareatthetopofacolumnortheleftofarow;theearlierachildiscreated,thecloseritistothetoporleftofitscolumnorrow.Ifdefined,alignmentchildelementoverridesthealignChildrensettingfortheparentcontainer.Seealignmentpropertyforvalues.
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,right
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
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 Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
layout LayoutManager r/w Thelayoutmanagerforthiscontainer.Thefirsttimeacontainerobjectismadevisible,ScriptUIinvokesthislayoutmanagerbycallingitslayout()function.DefaultisaninstanceoftheLayoutManager
thatisautomaticallycreatedwhenthecontainerelementiscreated.
location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.
margins Number r/w Thenumberofpixelsbetweentheedgesofacontainerandtheoutermostchildelements.Youcanspecifydifferentmarginsforeachedgeofthecontainer.Thedefaultvalueisbasedonthetypeofcontainer,andischosentomatchthestandardAdobeUIguidelines.
maximumSize Dimension r/w Themaximumheightandwidthtowhichtheelementcanberesized.
minimumSize Dimension r/w Theminimumheightandwidthtowhichtheelementcanberesized.
orientation String r/w Thelayoutorientationofchildreninacontainer.Interpretedbythelayout
managerforthecontainer.ThedefaultLayoutManagerObjectacceptsthe(case-insensitive)valuescolumn,orstackwindowandpanel,thedefaultiscolumn,andforgroupthedefaultisrow.Theallowedvaluesforthecontainer'salignChildrenanditschildren'salignmentpropertiesdependontheorientation.
parent Object readonly Theparentelement.
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,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizeorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.
spacing Number r/w Thenumberofpixelsseparatingonechildelementfromitsadjacentsiblingelement.Becauseeachcontainerholdsonlyasingleroworcolumnofchildren,onlyasinglespacingvalueisneededforacontainer.Thedefault
valueisbasedonthetypeofcontainer,andischosentomatchstandardAdobeUIguidelines.
type String readonly Theelementtype;"group".
visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.
window Window(SUI) readonly Thewindowthatthiselementbelongsto.
windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-levelparentwindow.
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.ControltypesarelistedintheJavaScriptToolsGuide.
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
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedin
theextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.(default:false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
voidremove(what:Any)Removesthespecifiedchildcontrolfromthisgroup'schildrenarray.Noerrorresultsifthechilddoesnotexist.Parameter Type Description
what Any Thechildcontroltoremove,specifiedby0-basedindex,textpropertyvalue,orasacontrolobject.
BooleanremoveEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthe
capturingphaseoftheeventpropagation.(default:false)
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
IconButton Amouse-sensitivepushbuttonthatdisplaysanimageinsteadoftext.
CallstheonClick()callbackifthecontrolisclickedorifitsiscalled.
QuickLinks addEventListener,dispatchEvent,hide,notify,onActivateonDeactivate,onDraw,onShortcutKey,removeEventListener
Hierarchy Object
IconButton
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButtontheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependon
theorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom•Fororientation=column:left,right•Fororientation=stack:bottom
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
image ScriptUIImage r/w Theimageobjectthatdefinestheimagetobedrawn.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
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.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanageris
invokedinordertoestablishanelementsizeotherthanthedefault.
properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).CreationpropertiesofanIconButtonobjectcaninclude:•style:visualstyle,either"button",whichhasavisibleborderwitharaisedor3Dappearance,or"toolbutton",whichhasaflatappearance,appropriateforinclusioninatoolbar.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizesize,butthisisnotrecommended.Definedas
[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.
type String readonly Theelementtype;"iconbutton".
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.Calledwhentheusermovesthekeyboardfocusfromthepreviouslyactive
controltoanothercontrol.
voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.
voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement'ssequenceistypedintheactivewindow.InWindowsonly.
InstancesBooleanaddEventListener(eventName:String,handlercapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.
AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
BooleanremoveEventListener(eventName:String,handlercapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
KeyboardState Reportstheactivestateofthekeyboard.
AccessthroughtheScriptUI.environment.keyboardStateproperty.Querythepropertiesofthisobjectatanytimetodeterminethecurrentkeythatisdownandanymodifiersthatarepressed.
Properties Property Type Access Description
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
Jongware,18-Jan-2015v1.0 Contents::Index
LayoutManager Controlstheautomaticlayoutbehaviorfor
awindoworcontainer.ThesubclassAutoLayoutManagerimplementsthedefaultautomaticlayoutbehavior.
QuickLinks layout,resize
Methods Instancesvoidlayout()Invokestheautomaticlayoutbehaviorforthemanagedcontainer.Adjustssizesandpositionsofthechildelementsofthiswindoworcontaineraccordingtotheplacementandalignmentpropertyvaluesintheparentandchildren.Invokedautomaticallythefirsttimethewindowisdisplayed.Thereafter,thescriptmustinvokeitexplicitlytochangethelayoutincaseofchangesinthesizeorpositionoftheparentorchildren.
voidresize()PerformsalayoutafteraWindowisresized,basedonthenewsize.Resizesthechildelementsofthemanagedcontainerwithagivenalignmenttype,afterthewindowhasbeenresizedbytheuser.
Elementof Group.layoutPanel.layoutWindow.layout
Jongware,18-Jan-2015v1.0 Contents::Index
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,onShortcutKeyremoveAll,removeEventListener,show
Hierarchy Object
ListBox(SUI)
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrensettingforthe
parentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,right
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
children ArrayofObject readonly AnarrayofchildListItemelements.
columns Object readonly Foramulti-columnlistbox,thecolumnproperties.AJavaScriptobjectwithtworead-onlypropertieswhosevaluesaresetbythecreationparameters:•titles:Anarrayofcolumntitlestrings,whoselengthmatchesthenumberofcolumnsspecifiedat
creation.•preferredWidthsarrayofcolumnwidths,whoselengthmatchesthenumberofcolumnsspecifiedatcreation.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()event.
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
itemSize Dimension r/w Thewidthandheightinpixelsofeachiteminthelist.Usedbyauto-layouttodeterminethepreferredSizeifnototherwisespecified.Ifnotsetexplicitly,thesizeof
eachitemissettomatchthelargestheightandwidthamongallitemsinthelist
items ArrayofListItem readonly Thearrayofchoiceitemsdisplayedinthelist.Accessthisarraywitha0-basedindex.Toobtainthenumberofitemsinthelist,useitems.lengtharecreatedwhenitemsarespecifiedoncreationoftheparentlistobject,orafterwardusingthelistcontrol'sadd()method.Eachitemhasaselectedthatistruewhenitisintheselectedstate.
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 Anobjectthatcontainsoneormorecreationpropertiesofthecontrol(propertiesusedonlywhentheelementiscreated).CreationpropertiesofaListBoxobjectcaninclude:•multiselect:Whenfalse(thedefault),onlyoneitemcanbeselected.Whentrue,multipleitemscanbeselected.•items:Anarrayofstringsforthetextofeachlistitem.Anitemobjectiscreatedforeachitem.Anitemwiththetextstring"-"createsaseparatoritem.Supplythisproperty,ortheargumenttotheadd()method,notboth.ThisformismostusefulforelementsdefinedusingResourceSpecifications.
•numberOfColumnsnumberofcolumnsinwhichtodisplaytheitems;defaultis1.Whentherearemultiplecolumns,eachListItemobjectrepresentsaselectablerow.Itstextandimagespecifythelabelinthefirstcolumn,andthesubitemspropertyspecifiesthelabelsintheadditionalcolumns.•showHeadersdisplaycolumntitles.•columnWidthsofnumbersforthepreferredwidthinpixelsofeachcolumn.•columnTitlescorrespondingarrayofstringsforthetitleofeachcolumn,tobeshownifshowHeadersistrue.
selection ListItem r/w Thecurrentlyselecteditemforasingle-selectionlist,oranarrayofitemsforcurrentselectioninamulti-selectionlist.Settingthisvaluecausestheselecteditemtobehighlightedandtobescrolledintoviewifnecessary.Ifnoitemsareselected,thevalueisnull.Settonulltodeselectallitems.Youcansetthevalueusingtheindexofanitemor
anarrayofindices,ratherthanobjectreferences.Ifsettoanindexvaluethatisoutofrange,theoperationisignored.Whensetwithindexvalues,thepropertystillreturnsobjectreferences.•Ifyousetthevaluetoanarrayforasingle-selectionlist,onlythefirstiteminthearrayisselected.•Ifyousetthevaluetoasingleitemforamulti-selectionlist,thatitemisaddedtothecurrentselection.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizeorthedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-
versa.
type String readonly Theelementtype;"listbox".
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.
voidonChange()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementhasbeenchanged
voidonDeactivate()Anevent-handlercallbackfunction,calledwhentheelementlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviouslyactivecontroltoanothercontrol.
voidonDoubleClick()Anevent-handlercallbackfunction,calledwhenaniteminthelistboxisdouble-clicked
Checktheselectionpropertytoidentifytheitemthatwasdouble-clicked.
voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.
voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement'sshortcutKeysequenceistypedintheactivewindow.InWindowsonly.
InstancesListItemadd(type:String[,text:String])Addsanitemtothechoicesinthislist.Returnstheitemcontrolobject.Ifthisisamulti-columnlistbox,eachaddedListItemrepresentsoneselectablerow.Itstextandimagespecifythelabelinthefirstcolumn,andthesubitemspropertyspecifiesthelabelsintheadditionalcolumns.Parameter Type Description
type String Thetypeofthechildelement,thestring"item".
text String Thelocalizabletextlabelfortheitem.(Optional)
BooleanaddEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandler
functiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
ListItemfind(text:String)Retrievesanitemobjectfromthelistthathasagiventextlabel.Parameter Type Description
text String Thetextstringtomatch.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
voidremove(what:Any)Removesachilditemfromthelist.Parameter Type Description
what Any Theitemorchildtoremove,specifiedby0-basedindex,textvalue,orasaListItemobject.
voidremoveAll()
Removesallchilditemsfromthelist.
BooleanremoveEventListener(eventName:String,handler:capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
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
Properties Property Type Access Description
checked Boolean r/w Thecheckedstateofaniteminalist.Whentrue,theitemismarkedwiththeplatform-appropriatecheckmark.Whenfalse,nocheckmarkisdrawn,butspaceisreservedforitintheleftmargin,sothattheitemlinesupwithothercheckableitems.Whenundefined,nospaceisreservedforacheckmark.
expanded Boolean r/w TheexpansionstateofanitemoftypenodethatisachildofaTreeViewlistcontrol.Whentrue,theitemisin
theexpandedstateanditschildrenareshown,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,theitemis
partoftheselectionforitsparentlist.Whenfalse,theitemisnotselected.Settotruetoselectthisiteminasingle-selectionlist,ortoaddittotheselectionarrayforamulti-selectionlist.
subItems Array readonly Whentheparentisamulti-columnListBoxthisdescribesthelabelsforthisselectablerowinadditionalcolumns.AarrayofJavaScriptobjectswhoselengthisonelessthanthenumberofcolumns.Thefirstmemberdescribesthelabelinthesecondcolumn.Eachmemberobjecthastwoproperties,ofwhichyoucanspecifyoneorboth:•text:Adisplaystringforthecorrespondinglabel.•image:AnScriptUIImageobjectforthecorrespondinglabel.
text String r/w Thelabeltexttodisplayfortheitem,alocalizablestring.Iftheparentisamulti-columnlistbox,thisdescribesthelabelinthefirstcolumn.Labelsin
additionalcolumnsaredescribedbythesubitemsproperty.
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)
Jongware,18-Jan-2015v1.0 Contents::Index
Panel(SUI) Acontainerforothertypesofcontrols,withanoptionalframe.
Apanelcanspecifylayoutoptionsforitschildelements.Hidingapanelhidesallitschildren.Makingitvisiblemakesvisiblethosechildrenthatarenotindividuallyhidden.
QuickLinks add,addEventListener,dispatchEvent,hide,onDraw,remove,removeEventListener,show
Hierarchy Object
Panel(SUI)
Properties Property Type Access Description
alignChildren String r/w Specifieshowtoalignthechildelements.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrensettingfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcase
sensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,right
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
characters Number(min:0) r/w Reservespaceforthespecifiednumberofcharacters;affectscalculationofpreferredSize.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement's
appearance,inresponsetotheonDraw()event.
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
justify String r/w Thedefaulttextjustificationstyleforchildtextelements.(default:left)Oneofleft,centerright.Justificationonlyworksifthisvalueissetoncreationoftheelement.
layout LayoutManager r/w Thelayoutmanagerforthiscontainer.Thefirsttimeacontainerobjectismadevisible,ScriptUIinvokesthislayoutmanagerbycallingitslayout()function.DefaultisaninstanceoftheLayoutManagerclassthatisautomaticallycreatedwhenthecontainerelementis
created.
location Point r/w Theupperleftcornerofthiselement'sframerelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.
margins Number r/w Thenumberofpixelsbetweentheedgesofacontainerandtheoutermostchildelements.Youcanspecifydifferentmarginsforeachedgeofthecontainer.Thedefaultvalueisbasedonthetypeofcontainer,andischosentomatchthestandardAdobeUIguidelines.
maximumSize Dimension r/w Themaximumheightandwidthtowhichtheelementcanberesized.
minimumSize Dimension r/w Theminimumheightandwidthtowhichtheelementcanberesized.
orientation String r/w Thelayoutorientationofchildreninacontainer.Interpretedbythelayoutmanagerforthecontainer.ThedefaultLayoutManager
Objectacceptsthe(case-insensitive)valuescolumn,orstackwindowandpanel,thedefaultiscolumn,andforgroupthedefaultisrow.Theallowedvaluesforthecontainer'salignChildrenanditschildren'salignmentpropertiesdependontheorientation.
parent Object readonly Theparentelement.
preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.
properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontrol
(propertiesusedonlywhentheelementiscreated).CreationpropertiesofaPanelobjectcaninclude:•borderStyle:Astringthatspecifiestheappearanceoftheborderdrawnaroundthepanel.Oneofblack,etchedgray,raised,sunkenDefaultisetched•su1PanelCoordinatesPhotoshoponly.Whentrue,thispanelautomaticallyadjuststhepositionsofitschildrenforcompatabilitywithPhotoshopCS.Defaultisfalse,meaningthatthepaneldoesnotadjustthepositionsofitschildren,eveniftheparentwindowhasautomaticadjustmentenabled.
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizeorthe
defaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.
spacing Number r/w Thenumberofpixelsseparatingonechildelementfromitsadjacentsiblingelement.Becauseeachcontainerholdsonlyasingleroworcolumnofchildren,onlyasinglespacingvalueisneededforacontainer.Thedefaultvalueisbasedonthetypeofcontainer,andischosentomatchstandardAdobeUIguidelines.
text String r/w Thetitleorlabeltext,alocalizablestring.
type String readonly Theelementtype;"panel".
visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhidden
accordinglywhentheparentisnextshown.
window Window(SUI) readonly Thewindowthatthiselementbelongsto.
windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-levelparentwindow.
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.
bounds Bounds Aboundsspecificationthatdescribesthesizeandpositionofthenewcontrolorcontainer,relativetoitsparent.Ifsupplied,thisvaluecreatesanewBoundsobjectwhichisassignedtothenewobject'sboundsproperty.(Optional)
text String Thetextorlabel,alocalizablestring.Initialtexttobedisplayedinthecontrolasthe
title,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
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.
voidremove(what:Any)Removesthespecifiedchildcontrolfromthisgroup'schildrenarray.Noerrorresultsifthechilddoesnotexist.Parameter Type Description
what Any Thechildcontroltoremove,specifiedby0-basedindex,textpropertyvalue,orasacontrolobject.
BooleanremoveEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:false)
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
Point(SUI) DefinesthelocationofawindoworUIelement.Containsa2-
elementarray.Specifiestheoriginpointofanelementashorizontalandverticalpixeloffsetsfromtheoriginoftheelement'scoordinatespace.APointobjectiscreatedwhenyousetanelement'slocationproperty.YoucansetthepropertyusingaJavaScriptobjectwithpropertiesnamedxandy,oranarraywith2valuesintheorder[x,y].
Properties Property Type Access Description
left Number r/w Theleftcoordinate.
length Number readonly Thearraylength.(default:2)
top Number r/w Thetopcoordinate.
x Number r/w Thehorizontalcoordinate,apixeloffsetfromtheoriginoftheelement'scoordinatespace.
y Number r/w Theverticalcoordinate,apixeloffsetfromtheoriginoftheelement'scoordinatespace.
Jongware,18-Jan-2015v1.0 Contents::Index
Progressbar Ahorizontalbarwithanindicatorthatshowstheprogressofan
operation.Allprogressbarcontrolshaveahorizontalorientation.Thevaluepropertycontainsthecurrentpositionoftheprogressindicator;thedefaultis0.Thereisaminvalueproperty,butitisalways0;attemptstosetittoadifferentvaluearesilentlyignored.
QuickLinks addEventListener,dispatchEvent,hide,onDraw,removeEventListener,show
Hierarchy Object
Progressbar
Properties Property Type Access Description
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
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedto
customizetheelement'sappearance,inresponsetotheonDraw()
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.
maximumSize Dimension r/w Themaximumheightandwidthtowhichtheelementcanberesized.
maxvalue Number r/w Themaximumvalueintherange.Defaultis100.
minimumSize Dimension r/w Theminimumheight
andwidthtowhichtheelementcanberesized.
minvalue Number r/w Theminimumvalueintherange;always0.Ifsettoadifferentvalue,itisignored.
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).AProgressBarobjecthasnocreationproperties.Thethirdargumentoftheadd()createsitistheinitialvalue(default0),andthefourthargumentisthemaximumvalueoftherange(default100).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizethedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,and
vice-versa.
type String readonly Theelementtype,"progessbar".
value Number r/w Thecurrentpositionoftheindicator.Ifsettoavalueoutsidetherangespecifiedby0tomaxvalueautomaticallyresettotheclosestboundary.
visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.
window Window(SUI) readonly Thewindowthatthiselementbelongsto.
windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-levelparentwindow.
Methods EventsvoidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesone
argument,aDrawStateobject.
InstancesBooleanaddEventListener(eventName:String,handlercapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.(default:false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
BooleanremoveEventListener(eventName:String,Function[,capturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregisterthe
eventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:false)
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
RadioButton(SUI) Adual-statecontrol,groupedwithotherradiobuttons,ofwhichonlyonecan
beintheselectedstate.Showstheselectedstatewhenvalue=true,emptywhentheonClick()callbackifthecontrolisclickedorifitscalled.
QuickLinks addEventListener,dispatchEvent,hide,notify,onActivateonDeactivate,onDraw,onShortcutKey,removeEventListener
Hierarchy Object
RadioButton(SUI)
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButtontheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwo
strings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom•Fororientation=column:left,•Fororientation=stack:bottom
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeoftheelement.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponseto
theonDraw
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
justify String r/w Thedefaulttextjustificationstyleforchildtextelements.(default:OneofJustificationonlyworksifthisvalueissetoncreationoftheelement.
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,usedbylayoutmanagersto
determinethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,andotherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.
properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).ARadioButtonobjecthasnocreationproperties.Thethirdargumentoftheadd()canbethelabeltext.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.Ascript
canexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizedefaultsize,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,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.
window Window(SUI) readonly Thewindowthatthiselementbelongsto.
windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-levelparentwindow.
Methods Events
voidonActivate()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,handlercapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctionto
beexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
BooleanremoveEventListener(eventName:StringcapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturing
phaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
ScriptUI AglobalclasscontainingcentralinformationaboutScriptUI.Notinstantiable.
QuickLinks getResourceText,newFont,newImage
Class Property Type Access Description
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)
Jongware,18-Jan-2015v1.0 Contents::Index
ScriptUIBrush Apaintingbrushthatencapsulatesacolororpatternusedtofillpaths.
CreatewithScriptUIGraphics.newBrush().UseasavalueofbackgroundColorproperties,andpassasanargumenttothe
Properties Property Type Access Description
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)
Jongware,18-Jan-2015v1.0 Contents::Index
ScriptUIFont Encapsulatesthequalitiesofafontusedtodrawtextintoa
control.CreatewiththenewFont()method.UsedasavalueofPassedasanargumenttodrawString()andmeasureString()
Properties Property Type Access Description
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:ScriptUIFont][,boundingWidth:Number])
Return ScriptUIFontScriptUI.newFont(name:String,styleNumber,size:Number)
Jongware,18-Jan-2015v1.0 Contents::Index
ScriptUIGraphics Anobjectusedtodrawcustomgraphics,foundinthe
ofwindow,container,andcontrolobjects.Allowsascripttocustomizeaspectsoftheelement'sappearance,suchasthecolorandfont.UseanonDrawcallbackfunctiontosetthesepropertiesorcallthefunctions.Allmeasurementsareinpixels.
QuickLinks closePath,drawFocusRing,drawImage,drawOSControlellipsePath,fillPath,lineTo,measureStringnewPath,newPen,rectPath,strokePath
Properties Property Type
backgroundColor ScriptUIBrush
currentPath ScriptUIPath
currentPoint Point
disabledBackgroundColor ScriptUIBrush
disabledForegroundColor ScriptUIPen
font ScriptUIFont
foregroundColor ScriptUIPen
Class Property Type Access Description
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.Defaultisthefontvalueinthisobject.
PointellipsePath(left:Number,top:NumberNumber)DefinesanellipticalpathwithinagivenrectangularareainthecurrentPathobject,whichcanbefilledusingusingstrokePath().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.Defaultis
thefontvalueinthisobject.
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
Jongware,18-Jan-2015v1.0 Contents::Index
ScriptUIImage Encapsulatesasetofimagesthatcanbedrawn
intoacontrol.Differentimagescanreflectthecurrentstate,suchasadimmedversionforadisabledcontrol.CreatewiththenewImage()method.PassedasanargumenttodrawImage().
Properties Property Type Access Description
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])
Jongware,18-Jan-2015v1.0 Contents::Index
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()
Jongware,18-Jan-2015v1.0 Contents::Index
ScriptUIPen Adrawingpenthatdefinesacolorandlinewidthusedtostrokepaths.
CreatewithScriptUIGraphics.newPen().UseasavalueofforegroundColorproperties,andpassasanargumenttodrawString()andstrokePath()methods.
Properties Property Type Access Description
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:Number
Scrollbar Ascrollbarwithadraggablescrollindicatorandstepperbuttonstomove
theindicator.Thescrollbarcontrolhasahorizontalorientationifthewidthisgreaterthantheheightatcreationtime,orverticalifitsheightisgreaterthanitswidth.CallstheonChange()callbackafterthepositionoftheindicatorischangedorifitsnotify()methodiscalled.CallstheonChanging()callbackrepeatedlywhiletheuserismovingtheindicator.ScrollbarsareoftencreatedwithanassociatedEditTextdisplaythecurrentvalueofthescrollbar,andtoallowsettingthescrollbar'spositiontoaspecificvalue.
QuickLinks addEventListener,dispatchEvent,hide,notify,onActivate,onChanging,onDeactivate,onDraw,onShortcutKey,removeEventListener,show
Hierarchy Object
Scrollbar
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildren
theparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:right,fill•Fororientation=stack:bottom,left
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,
controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
jumpdelta Number(min:0) r/w Theamounttoincrementordecrementascrollbarindicator'spositionwhentheuserclicksaheadorbehindthemoveableelement.Defaultis20%oftherangebetweenthemaxvalueandminvaluepropertyvalues.
location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].
Settinganelement'slocationchangesitsboundsproperty,andvice-versa.
maximumSize Dimension r/w Themaximumheightandwidthtowhichtheelementcanberesized.
maxvalue Number r/w Themaximumvalueallowedintheproperty.Togetherwithsetsthescrollingrange.Defaultis100.
minimumSize Dimension r/w Theminimumheightandwidthtowhichtheelementcanberesized.
minvalue Number r/w Theminimumvalueallowedintheproperty.Togetherwithsetsthescrollingrange.Defaultis0.
parent Object readonly Theparentelement.
preferredSize Dimension r/w Thepreferredsize,usedbylayoutmanagerstodeterminethebestsizeforeachelement.Ifnotexplicitlysetbyascript,valueisestablishedbytheUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,font,fontsize,iconsize,and
otherUIframework-specificattributes.Ascriptcanexplicitlysetthisvaluebeforethelayoutmanagerisinvokedinordertoestablishanelementsizeotherthanthedefault.
properties Object r/w Anobjectthatcontainsoneormorecreationpropertiesofthecontainer(propertiesusedonlywhentheelementiscreated).AScrollbarobjecthasnocreationproperties.Thethirdargumentoftheadd()methodthatcreatesitistheinitialvalue,andthefourthandfifthargumentsaretheminimumandmaximumvaluesoftherange.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.Ascriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedto
establishanelementsizeotherthanthepreferredSizedefaultsize,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.
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.
voidonChange()Anevent-handlercallbackfunction,calledwhentheuserhasfinisheddraggingthepositionindicator,orhasclickedthecontrol.
voidonChanging()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementisintheprocessofchangingThehandleriscalledforanymotionofthepositionindicatorwhilethiscontrolhastheinputfocus.
voidonDeactivate()Anevent-handlercallbackfunction,calledwhentheelementlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviouslyactivecontroltoanothercontrol.
voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.
voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement'sshortcutKeysequenceistypedintheactivewindow.InWindowsonly.
InstancesBooleanaddEventListener(eventName:String,handler:Function
capturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.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,anonClickeventforcontrolsthat
supportthatevent.(Optional)
BooleanremoveEventListener(eventName:String,handlercapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:false)
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
Slider Asliderbarthatindicatesanumericvaluewithamoveableposition
indicator.Allslidercontrolshaveahorizontalorientation.CallstheonChange()callbackafterthepositionoftheindicatorischangedorifitsnotify()methodiscalled.CallstheonChanging()callbackrepeatedlywhiletheuserismovingtheindicator.Thevaluepropertycontainsthecurrentpositionoftheindicatorwithintherangeofminvalueto
QuickLinks addEventListener,dispatchEvent,hide,notify,onActivate,onChangeonChanging,onDeactivate,onDraw,onShortcutKey,removeEventListenershow
Hierarchy Object
Slider
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrensettingfortheparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparent
container,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,fill•Fororientation=stack:bottom,left,right
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
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 Thehelptextthatisdisplayedwhenthemouse
hoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.
maximumSize Dimension r/w Themaximumheightandwidthtowhichtheelementcanberesized.
maxvalue Number r/w Themaximumvalueallowedinthevalueproperty.Togetherwithminvaluetherange.Defaultis100.
minimumSize Dimension r/w Theminimumheightandwidthtowhichtheelementcanberesized.
minvalue Number r/w Theminimumvalueallowedinthevalueproperty.Togetherwithmaxvaluetherange.Defaultis0.
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).ASliderobjecthasnocreationproperties.Thethirdargumentoftheadd()methodthatcreatesitistheinitialvalue,andthefourthandfifthargumentsaretheminimumandmaximumvaluesoftherange.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbya
script,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.
type String readonly Theelementtype,"slider".
value Number r/w Thecurrentpositionoftheindicator.Ifsettoavalueoutsidetherangespecifiedbyminvalueanditisautomaticallyresettotheclosestboundary.
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.
voidonChange()Anevent-handlercallbackfunction,calledwhentheuserhasfinisheddraggingthepositionindicator,orhasclickedthecontrol.
voidonChanging()Anevent-handlercallbackfunction,calledwhenthecontentoftheelementisintheprocessofchangingThehandleriscalledforanymotionofthepositionindicatorwhilethiscontrolhastheinputfocus.
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])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.
Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
BooleanremoveEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.
Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
StaticText(SUI) Atextlabelthattheusercannotchange.
QuickLinks addEventListener,dispatchEvent,hide,notify,onDraw,onShortcutKeyremoveEventListener,show
Hierarchy Object
StaticText(SUI)
Properties Property Type Access Description
active Boolean r/w Alwaysfalse.Thiselementcannothaveinputfocus.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).
Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right•Fororientation=stack:bottom,left
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeoftheelement.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()
helpTip String r/w Thehelptextthatis
displayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
justify String r/w Thetextjustificationstyle.(default:leftOneofleftJustificationonlyworksifthisvalueissetoncreationoftheelement.
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,valueisestablishedby
theUIframeworkinwhichScriptUIisemployed,andisbasedonsuchattributesoftheelementasitstext,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,thedisplayedtextcanbeverticallyscrolledusingtheUpArrowandDownArrow;thiscaseimpliesmultiline=true.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()
forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.AscriptcanexplicitlysetsizebeforethelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizesize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.
text String r/w Thetexttodisplay,alocalizablestring.
type String readonly Theelementtype,"statictext".
visible Boolean r/w Trueifthiselementisshown,falseifitishidden.Whenacontainerishidden,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.
window Window(SUI) readonly Thewindowthatthiselementbelongsto.
windowBounds Bounds readonly Theboundsofthiselementrelativetothetop-levelparentwindow.
Methods EventsvoidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.
voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement'ssequenceistypedintheactivewindow.InWindowsonly.
InstancesBooleanaddEventListener(eventName:String,handler:capturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobject
isitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
BooleanremoveEventListener(eventName:String,handlercapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
Jongware,18-Jan-2015v1.0 Contents::Index
TreeView Ahierarchicallistwhoseitemscancontainchilditems.
TheListItemchildrenofthiscontrol(intheitemsarray)canbeoftypewhichmeansthattheycancontainchilditems.Anitemwithchilditemscanexpanded,sothatthechilditemsaredisplayed,orcollapsed,sothatthechilditemsarehiddenIndividualitemscanbeselectedatanylevelofthetree.
QuickLinks add,addEventListener,dispatchEvent,find,hide,notify,onActivateonChange,onCollapse,onDeactivate,onDraw,onExpand,remove,removeAll,removeEventListener,show
Hierarchy Object
TreeView
Properties Property Type Access Description
active Boolean r/w Trueifthiselementisactive.Anactivecontrolistheonewithkeyboardfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,isselectedwhentheusertypesReturnorEnterinWindows,orthespacebarinMacOS.
alignment String r/w Thealignmentstyleforthiselement.Ifdefined,thisvalueoverridesthealignChildrenparentcontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththe
horizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:bottom,fill•Fororientation=column:left,right,•Fororientation=stack:bottom,left
bounds Bounds r/w Theboundariesoftheelement,inparent-relativecoordinates.Settinganelement'ssizeorlocationchangesitsboundsproperty,andvice-versa.
children ArrayofObject readonly Anarrayofchildelements.
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizetheelement'sappearance,inresponsetotheonDraw()
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelementduringautomaticlayout.Appliesforcolumnorientationandleftalignment,orroworientationandtopalignment.
itemSize Dimension r/w Thewidthandheightinpixelsofeachiteminthelist.Usedbyauto-layouttodeterminethepreferredSizeifnototherwisespecified.Ifnotsetexplicitly,thesizeofeachitemissettomatchthelargestheightandwidthamongallitemsinthelist
items ArrayofListItem readonly Thearrayoftop-levelitemsdisplayedinthelist.Accessthisarraywitha0-basedindex.Toobtainthenumberofitemsinthelist,useitems.lengtharecreatedwhenitemsarespecifiedoncreationoftheparentlistobject,orafterwardusingthelistcontrol'sadd()
location Point r/w Theupperleftcornerofthiselementrelativetoitsparent.Thelocationisdefinedas[bounds.x,bounds.y].Settinganelement'slocationchangesitsboundsproperty,andvice-versa.
maximumSize Dimension r/w Themaximumheightand
widthtowhichtheelementcanberesized.
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 Anobjectthatcontainsoneormorecreationpropertiesofthecontrol(propertiesusedonlywhentheelementiscreated).CreationpropertiesofaListBoxobjectcaninclude:•items:Anarrayofstringsforthetextofeachtop-levellistitem.Anitemobjectiscreatedforeachitem.Anitemwiththetextstring"-"
createsaseparatoritem.Supplythisproperty,ortheitemsargumenttotheadd()method,notboth.ThisformismostusefulforelementsdefinedusingResourceSpecifications.
selection ListItem r/w Thecurrentlyselecteditem.Settingthisvaluecausestheselecteditemtobehighlightedandtobescrolledintoviewifnecessary.Ifnoitemsareselected,thevalueisnull.Settonulltodeselectallitems.Youcansetthevalueusingtheindexofanitem,ratherthananobjectreference.Ifsettoanindexvaluethatisoutofrange,theoperationisignored.Whensetwithanindexvalue,thepropertystillreturnsanobjectreference.
shortcutKey String r/w ThekeysequencethatinvokestheonShortcutKey()forthiselement(inWindowsonly).
size Dimension r/w Thecurrentdimensionsofthiselement.Initiallyundefined,andunlessexplicitlysetbyascript,itisdefinedbyaLayoutManager.Ascriptcanexplicitlysetsizebefore
thelayoutmanagerisinvokedtoestablishanelementsizeotherthanthepreferredSizedefaultsize,butthisisnotrecommended.Definedas[bounds.width,bounds.height].Settinganelement'ssizechangesitsboundsproperty,andvice-versa.
type String readonly Theelementtype,"treeview".
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.
voidonChange()
Anevent-handlercallbackfunction,calledwhenthecontentoftheelementhasbeenchanged
voidonCollapse(item:ListItem)Anevent-handlercallbackfunction,calledwhentheusercollapses(closes)anexpandednodeinthetreeview.Parameter Type Description
item ListItem TheListItemnodethatcollapsed.
voidonDeactivate()Anevent-handlercallbackfunction,calledwhentheelementlosesthekeyboardfocus.Calledwhentheusermovesthekeyboardfocusfromthepreviouslyactivecontroltoanothercontrol.
voidonDraw()Anevent-handlercallbackfunction,calledwhenthewindowisabouttobedrawn.Allowsthescripttomodifyorcontroltheappearance,usingthecontrol'sassociatedScriptUIGraphicsobject.Handlertakesoneargument,aDrawStateobject.
voidonExpand(item:ListItem)Anevent-handlercallbackfunction,calledwhentheuserexpands(opens)acollapsednodeinthetreeview.Parameter Type Description
item ListItem TheListItemnodethatexpanded.
voidonShortcutKey()Anevent-handlercallbackfunction,calledwhentheelement'sshortcutKeysequenceistypedintheactivewindow.InWindowsonly.
InstancesListItemadd(type:String[,text:String])Addsanitemtothetop-levelchoicesinthislist.Returnstheitemcontrolobject.Parameter Type Description
type String Thetypeofthechildelement,thestring"item".
text String Thelocalizabletextlabelfortheitem.
BooleanaddEventListener(eventName:String,handler:FunctioncapturePhase:Boolean=false])Registersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Parameter Type Description
eventName String Thenameoftheevent.EventnamesarelistedintheJavaScriptToolsGuide.
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.false)Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.
EventdispatchEvent()Simulatestheoccurrenceofaneventinthistarget.AscriptcancreateaUIEventobjectforaspecificeventandpassittothismethodtostarttheeventpropagationfortheevent.
ListItemfind(text:String)Retrievesanitemobjectfromthelistthathasagiventextlabel.Parameter Type Description
text String Thetextstringtomatch.
voidhide()Hidesthiselement.
voidnotify([eventName:String])Sendsanotificationmessage,simulatingthespecifieduserinteractionevent.Parameter Type Description
eventName String Thenameofthecontroleventhandlertocall.Oneof:onClick,onChange,onChangingsimulatestheonChangeeventforanedittextcontrol,anonClickeventforcontrolsthatsupportthatevent.(Optional)
voidremove(what:Any)Removesachilditemfromthelist.Parameter Type Description
what Any Theitemorchildtoremove,specifiedby0-basedindexinthetop-levelitemlist,textvalue,orasaListItemobject.
voidremoveAll()Removesallchilditemsfromthelist.
BooleanremoveEventListener(eventName:String,handlercapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiselement.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseoftheeventpropagation.(default:
voidshow()Showsthiselement.Whenawindoworcontainerishidden,itschildrenarealsohidden,butwhenitisshownagain,thechildrenretaintheirownvisibilitystates.
UIEvent Encapsulatesinputeventinformationforaneventthat
propagatesthroughacontainerandcontrolhierarchy.ImplementsW3Cstandardeventhandling.Thisobjectispassedtoafunctionthatyouregistertorespondtoeventsofacertaintypethatoccurinawindoworcontrol.UsewindowObj.addEventListener()orcontrolObj.addEventListener()toregisterahandlerfunction.
QuickLinks UIEvent,initEvent,initUIEvent,preventDefault,stopPropagation
Properties Property Type Access Description
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.
captures Boolean Settotrueifthiseventcanbecaptured.(default:false)
bubbles Boolean Settotrueiftheeventbubbles.(default:false)
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.
captures Boolean Settotrueifthiseventcanbecaptured.(default:false)
bubbles Boolean Settotrueiftheeventbubbles.(default:false)
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()
Jongware,18-Jan-2015v1.0 Contents::Index
Window(SUI) Theinstancerepresentsatop-levelwindowordialogbox,whichcontainsuser-
interfaceelements.ThegloballyavailableWindowobjectprovidesaccesstopredefinedandscript-definedwindows.
QuickLinks Window,add,addEventListener,alert,center,close,confirm,hide,notify,onActivate,onClose,onDeactivate,onMove,onMovingonResizing,onShortcutKey,onShow,prompt,remove,removeEventListener
Hierarchy Object
Window(SUI)
Properties Property Type Access Description
active Boolean r/w Settotruetomakethiswindowactive.
•Amodaldialogthatisvisibleisbydefinitiontheactivedialog.•Anactivepaletteisthefront-mostwindow.•Anactivecontrolistheonewithfocus–thatis,theonethatacceptskeystrokes,orinthecaseofaButton,beselectedwhentheusertypesReturnorEnter.
alignChildren String r/w Tellsthelayoutmanagerhowunlike-sizedchildrenofthiscontainershouldbealignedwithinacolumnorrow.Orderofcreationdetermineswhichchildrenareatthetopofacolumnortheleftofarow;theearliera
childiscreated,thecloseritistothetoporleftofitscolumnorrow.Ifdefined,alignmentelementoverridesthealignChildrencontainer.Seeforvalues.
alignment String r/w Thealignmentstyleforchildelementsofacontainer.Ifdefined,thisvalueoverridesthealignChildrencontainer.Thiscanbeasinglestring,whichindicatesthealignmentfortheorientationspecifiedintheparentcontainer,oranarrayoftwostrings,indicatingboththehorizontalandverticalalignment(inthatorder).Allowedvaluesdependontheorientationvalueoftheparentcontainer.Theyarenotcasesensitive.•Fororientation=row:fill•Fororientation=column:right,fill•Fororientation=stack:bottom,left,
bounds Bounds r/w Theboundsofthewindow'sdrawablearea,excludingtheframe,inscreencoordinates.
cancelElement Object r/w Forwindowsoftypeelementtonotifywhentheuserpressesacancellationkeycombination.ThecancellationkeyistheEsckey.Bydefault,looksforabutton
whosenameortextis"cancel"(casedisregarded).
characters Number(min:0) r/w Anumberofcharactersforwhichtoreservespacewhencalculatingthepreferredsizeofthewindow.
children ArrayofObject readonly ThecollectionofUIelementsthathavebeenaddedtothiscontainer.Anarrayindexedbynumberorbyastringcontaininganelement'sname.Thelengthpropertyofthisarrayisthenumberofchildelementsforcontainerelements,andiszeroforcontrols.
defaultElement Object r/w ForwindowsoftypeelementtonotifywhentheuserpressesaEnterkey.Bydefault,looksforabuttonwhosenameortextis"ok"(casedisregarded).
enabled Boolean r/w Trueifthiselementisenabled.Anenabledelementcanacceptinput,accordingtoitstype.Whenfalse,controlelementsdonotacceptinput,andalltypesofelementshaveadimmedappearance.
frameBounds Bounds readonly Theboundsofthewindowframeinscreencoordinates.Theframeconsistsofthetitlebarandbordersthatenclosethecontentregionofawindow,dependingonthewindowingsystem.
frameLocation Point r/w Thetopleftcornerofthewindowframeinscreencoordinates.Thesameas[frameBounds.x,
frameBounds.y].Setthisvaluetomovethewindowframetothespecifiedlocationonthescreen.TheframeBoundsaccordingly.
frameSize Dimension readonly Thesizeandlocationofthewindow'sframeinscreencoordinates.
graphics ScriptUIGraphics readonly Thegraphicsobjectthatcanbeusedtocustomizethewindow'sappearance,inresponsetotheonDrawevent.
helpTip String r/w Thehelptextthatisdisplayedwhenthemousehoversovertheelement.
indent Number(min:0) r/w Thenumberofpixelstoindenttheelement.
justify String r/w Thedefaulttextjustificationstyleforchildtextelements.left)Oneofleft,centerJustificationonlyworksifthisvalueissetoncreationoftheelement.
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.ThedefaultLayoutManagerObjectacceptsthe(case-insensitive)valuesrow,column,orandpanel,thedefaultiscolumn,andforgroupthedefaultisrow.Theallowedvaluesforthecontainer'salignChildren
children'salignmentdependontheorientation.
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,thechildpanelsofthiswindowautomaticallyadjustthepositionsoftheirchildrenforcompatabilitywithPhotoshopCS(inwhichtheverticalcoordinatewasmeasuredfromoutsidetheframe).Defaultisfalse.Individualpanelscanoverridetheparentwindow'ssetting.•closeButton:Bridgeonly.Whentrue,thetitlebarincludesabuttontoclosethewindow,iftheplatformandwindowtypeallowit.Whenfalse,itdoesnot.Defaultistrue.Notusedfordialogs.•maximizeButton:Bridgeonly.Whentrue,thetitlebarincludesabuttontoexpandthewindowtoitsmaximumsize(typically,theentire
screen),iftheplatformandwindowtypeallowit.Whenfalse,itdoesnot.Defaultisfalsefortypepalette,truefortypewindow.Notusedfordialogs.
shortcutKey String r/w Thekeypresscombinationthatinvokesthiselement'sonShortcutKey()
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,itschildrenarealsohidden,buttheyretaintheirownvisibilityvalues,andareshownorhiddenaccordinglywhentheparentisnextshown.
window Window(SUI) readonly Thewindowthatthiselementbelongsto.
windowBounds Bounds readonly Theboundsofthiswindowrelativetothetop-levelparentwindow.
Class Property Type Access Description
frameworkName String readonly Deprecated.UseScriptUI.frameworkName
version Any readonly Deprecated.UseScriptUI.version
Methods ConstructorWindow(type:String[,title:String][,bounds:Bounds][,propertiesCreatesanewwindow.Parameter Type Description
type String Thewindowtype.Oneof:•window:Createsasimplewindowthatcanbeusedasamainwindowforanapplication.(NotsupportedbyPhotoshopCS3.)•palette:Createsamodelessdialog,alsocalledafloatingpalette.(NotsupportedbyPhotoshopCS3.)•dialog:Createsamodaldialog.ThisargumentcanalsobeaScriptUIresourcespecification;inthatcase,allotherargumentsareignored.
title String Thewindowtitle,alocalizablestring.(Optional)
bounds Bounds Thewindow'spositionandsize.(Optional)
properties Object Anobjectcontainingcreation-onlyproperties.Cancontainanyoftheseproperties:•resizeable:Whentrue,thewindowcanberesizedbytheuser.Defaultisfalse.•su1PanelCoordinates:Photoshoponly.Whentrue,thechildpanelsofthiswindowautomaticallyadjustthepositionsoftheirchildrenforcompatabilitywithPhotoshop
CS(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-standardalerticonisreplacedby
theplatform-standarderroriconinthedialog.false)IgnoredinMacOS,whichdoesnotsupporticonsforalertdialogs.
Booleanconfirm(message:String[,noAsDefault:Boolean=falseDisplaysaplatform-standarddialogcontainingashortmessageandtwobuttonslabeledYesandNo.ReturnstrueiftheuserclickedYes,falseiftheuserclickedNo.Parameter Type Description
message String Thestringforthedisplayedmessage.
noAsDefault Boolean Whentrue,theNobuttonisthedefaultchoice,selectedwhentheusertypesEnter.(default: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,calledwhenthewindow
voidonMoving()Anevent-handlercallbackfunction,calledwhenthewindowisbeingmovedCalledwhileawindowinbeingmoved,eachtimethepositionchanges.Ahandlercanmonitorthemoveoperation.
voidonResize()Anevent-handlercallbackfunction,calledafterthewindowhasbeenresized
voidonResizing()Anevent-handlercallbackfunction,calledwhileawindowisbeingresizedCalledwhileawindowisbeingresized,eachtimetheheightorwidthchanges.Ahandlercanmonitortheresizeoperation.
voidonShortcutKey()InWindowsonly,anevent-handlercallbackfunction,calledashortcut-keysequenceistypedthatmatchestheshortcutKeyvalueforthiswindow.
voidonShow()Anevent-handlercallbackfunction,calledjustbeforethewindowisdisplayedCalledwhenarequestismadetoopenthewindowusingthethewindowismadevisible,butafterautomaticlayoutiscomplete.Ahandlercanmodifytheresultsoftheautomaticlayout.
InstancesObjectadd(type:String[,bounds:Bounds][,text:String][,propertiesCreatesandreturnsanewcontrolorcontainerobjectandaddsittothechildrenofthiswindow.Parameter Type Description
type String Thetypeofthechildelement,asspecifiedforthetypeproperty.ControltypesarelistedintheJavaScriptToolsGuide
bounds Bounds Aboundsspecificationthatdescribesthesizeandpositionofthenewcontrolorcontainer,relativetoitsparent.Ifsupplied,thisvaluecreatesanewBoundsobjectwhichisassignedtothenewobject'sboundsproperty.
text String Thetextorlabel,alocalizablestring.Initialtexttobedisplayedinthecontrolasthetitle,label,orcontents,dependingonthecontroltype.Ifsupplied,thisvalueisassignedtothenewobject'stext(Optional)
properties Object Anobjectthatcontainsoneormorecreationpropertiesofthenewchild(propertiesusedonlywhentheelementiscreated).
Thecreationpropertiesdependontheelementtype.Seepropertyofeachcontroltype.(Optional)
BooleanaddEventListener(eventName:String,handler:FunctionBoolean=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).
handler Function Thefunctionthathandlestheevent.Thiscanbethenameofafunctiondefinedintheextension,oralocallydefinedhandlerfunctiontobeexecutedwhentheeventoccurs.Ahandlerfunctiontakesoneargument,theUIEventobject.
capturePhase Boolean Whentrue,thehandleriscalledonlyinthecapturingphaseoftheeventpropagation.(default:Defaultisfalse,meaningthatthehandleriscalledinthebubblingphaseifthisobjectisanancestorofthetarget,orintheat-targetphaseifthisobjectisitselfthetarget.(Optional)
voidcenter([window:Window])Centersthiswindowonscreenorwithrepecttoanotherwindow.Parameter Type Description
window Window(SUI)
Therelativewindow.Ifnotspecified,centersonthescreen.(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,onResizing,onShow(Optional)
voidremove(what:Any)Removesthespecifiedchildcontrolfromthiswindow'schildrenNoerrorresultsifthechilddoesnotexist.Parameter Type Description
what Any Thechildcontroltoremove,specifiedby0-basedindex,textpropertyvalue,orasacontrolobject.
BooleanremoveEventListener(eventName:String,handlercapturePhase:Boolean=false])Unregistersaneventhandlerforaparticulartypeofeventoccuringinthiswindow.Allargumentsmustbeidenticaltothosethatwereusedtoregistertheeventhandler.Parameter Type Description
eventName String Thenameoftheevent.
handler Function Thefunctionthathandlestheevent.
capturePhase Boolean Whethertocallthehandleronlyinthecapturingphaseof
theeventpropagation.(default:false
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.windowStaticText.windowTreeView.windowWindow.window
Usedin: voidWindow.center([window:Window])
Jongware,18-Jan-2015v1.0 Contents::Index
ClassIndex
$ABCDEFGHIJKLMNOP$
$ABCDEFGHIJKLMNOPAFrame
Arc
Array
AttrCondExpr
Attribute
AttributeDef
AttributeDefs
AttributeEx
$ABCDEFGHIJKLMNOPBodyPage
Book
BookComponent
Boolean
$ABCDEFGHIJKLMNOPCMSCheckinParam
CMSConnection
CMSDeleteParam
CMSInfo
CMSMenuItem
CMSObject
CMSProperties
CMSProperty
CMSRegistration
CMSResult
CMSSession
Cell
CharFmt
Checkbox(SUI)
Color
CombinedFont
$ABCDEFGHIJKLMNOPDate
Dimension
Doc
DrawState
$ABCDEFGHIJKLMNOPEditText
Element
ElementCatalogEntries
ElementDef
ElementLoc
ElementRange
ElementCatalogEntries
ElementCatalogEntry
ElementRange
Ellipse
$ABCDEFGHIJKLMNOPFCodes(enum)
File
FilterArgs
FlashPlayer
Flow
FmtChangeList
FmtRule
FmtRuleClause
Fn
Folder
$ABCDEFGHIJKLMNOPGlobalElements
Globals
GraphicsFmt
Group
$ABCDEFGHIJKLMNOPHiddenPage
$ABCDEFGHIJKLMNOPIconButton
IdValuePair
IdValuePairs
Inset
$ABCDEFGHIJKLMNOPKeyCatalog KeyboardState
$ABCDEFGHIJKLMNOPLayoutManager
Line
ListBox(SUI)
ListItem
$ABCDEFGHIJKLMNOPMarker
MarkerType
MasterPage
Math
Math(JS)
MathML
$ABCDEFGHIJKLMNOPNamespace Number
$ABCDEFGHIJKLMNOPObject
$ABCDEFGHIJKLMNOPPanel(SUI)
Pgf
PgfFmt
Point
Point(SUI)
Points
Polygon
Polyline
$ABCDEFGHIJKLMNOPQName
$ABCDEFGHIJKLMNOPRadioButton(SUI)
Rectangle
RefPage
Reflection
ReflectionInfo
RegExp
RoundRect
Row
$ABCDEFGHIJKLMNOPScriptUI
ScriptUIBrush
ScriptUIFont
ScriptUIGraphics
ScriptUIImage
ScriptUIPath
ScriptUIPen
Scrollbar
Slider
Socket
$ABCDEFGHIJKLMNOPTab
Tabs
TextItem
TextItems
Tabs
Tbl
TblFmt
TemplateData
TemplateDatas
TextFrame
TextItems
TextLine
TextLoc
TextRange
TiApiClient
TiFlow
$ABCDEFGHIJKLMNOPUBytes
UIEvent
UInts
UnanchoredFrame
$ABCDEFGHIJKLMNOPVar VarFmt
$ABCDEFGHIJKLMNOPWindow(SUI)
$ABCDEFGHIJKLMNOPXML
XMLList
XRef
XRefFmt
Jongware,18-Jan-2015v1.0 Contents::Index
Globals
QuickLinks AddMenu,Alert,Alive,AllocatePropVals,AppendIntProp,AppendMetricProp,AppendStringProp,AppendStringsProp,AppendVal,CMSAddMenuEntry,CMSGetCmsIdFromName,CMSLogin,CMSRegister,CallClient,CallClientEx,CheckStatus,ChooseFile,ClientDir,ClientName,ClientNumber,CustomDoc,DefineMenu,DisconnectFromSession,Emergency,Err,ErrorName,Externalize,FamilyFonts,FileScrollBox,GetEncodingForFamily,GetEncodingForFont,GetExportDefaultParams,GetFontAngleValue,GetFontFamilyValue,GetFontVariationValue,GetFontWeightValue,GetImportDefaultParams,GetIteratorDefaultParams,GetKeyCatalog,GetNewXMLDefaultParams,GetOpenDefaultParams,GetPropIndex,GetSaveDefaultParams,GetSupportedEncodings,GetUpdateBookDefaultParams,InitializationName,IsDRL,IsDataDifferentFromTemplateData,IsEncodingSupported,IsFileValid,LoadMenuCustomizationFile,LogFMPIPEvent,MenuExists,NewKeyCatalog,NewXML,Notification,NotificationName,Open,PopClipboard,PrintErrno,PrintExportStatus,PrintFAErrno,PrintImportStatus,PrintInitialization,PrintNotification,PrintOpenStatus,PrintPropVal,PrintPropVals,PrintSaveStatus,PrintTextItem,PrintTextItems,PrintUpdateBookStatus,PromptInt,PromptMetric,PromptString,PushClipboard,RemoveMenu,ReturnValue,Run,ScrollBox,Service,SetDdeInstance,ShortcutExists,ShutDown,SimpleNewDoc,SimpleOpen,Sleep,StringLen,USleep,UpdateMenus,UserCancel,WinInstallDefaultMessageFilter
Methods InstancesintAddMenu(toMenu:string,menu:string,label:string)Parameter Type Description
toMenu string
menu string
label string
intAlert(message:string,type:int)Parameter Type Description
message string
type int
intAlive(:void)Parameter Type Description
void
PropValsAllocatePropVals(numProps:int)Parameter Type Description
numProps int
voidAppendIntProp(pv:PropVals,prop:int,val:int)Parameter Type Description
pv PropVals
prop int
val int
voidAppendMetricProp(pv:PropVals,prop:int,val:int)Parameter Type Description
pv PropVals
prop int
val int
voidAppendStringProp(pv:PropVals,prop:int,val:string)Parameter Type Description
pv PropVals
prop int
val string
voidAppendStringsProp(pv:PropVals,prop:int,val:Strings)Parameter Type Description
pv PropVals
prop int
val Strings
voidAppendVal(pv:PropVals,prop:int,val:TypedVal)Parameter Type Description
pv PropVals
prop int
val TypedVal
intCMSAddMenuEntry(menuId:int,menuEntryp:CMSMenuItem)Parameter Type Description
menuId int
menuEntryp CMSMenuItem
CMSRegistrationCMSGetCmsIdFromName(cmsName:string)Parameter Type Description
cmsName string
CMSSessionCMSLogin(setVal:IdValuePairs)Parameter Type Description
setVal IdValuePairs
CMSRegistrationCMSRegister(cmsName:string)Parameter Type Description
cmsName string
intCallClient(clname:string,arg:string)Parameter Type Description
clname string
arg string
TypedValsCallClientEx(clname:string,arg:string)Parameter Type Description
clname string
arg string
intCheckStatus(p:PropVals,statusBit:int)Parameter Type Description
p PropVals
statusBit int
intChooseFile(title:string,directory:string,stuffVal:string,mode:int,helpLink:string)Parameter Type Description
title string
directory string
stuffVal string
mode int
helpLink string
stringClientDir(:void)Parameter Type Description
void
stringClientName(_:void)Parameter Type Description
_ void
intClientNumber(_:void)Parameter Type Description
_ void
DocCustomDoc(width:int,height:int,numCols:int,columnGap:int,topMargin:int,botMargin:int,leftinsideMargin:int,rightoutsideMargin:int,sidedness:int,makeVisible:bool)Parameter Type Description
width int
height int
numCols int
columnGap int
topMargin int
botMargin int
leftinsideMargin int
rightoutsideMargin int
sidedness int
makeVisible bool
MenuDefineMenu(name:string,label:string)Parameter Type Description
name string
label string
intDisconnectFromSession()
voidEmergency(:void)Parameter Type Description
void
voidErr(message:string)Parameter Type Description
message string
stringErrorName(i:int)Parameter Type Description
i int
intExternalize(srcDocId:Object,objId:Object,dstFolder:string)Parameter Type Description
srcDocId Object
objId Object
dstFolder string
FontsFamilyFonts(family:int)Parameter Type Description
family int
intFileScrollBox(title:string,directory:string)Parameter Type Description
title string
directory string
stringGetEncodingForFamily(family:int)Parameter Type Description
family int
stringGetEncodingForFont(font:Font)
Parameter Type Description
font Font
PropValsGetExportDefaultParams(:void)Parameter Type Description
void
intGetFontAngleValue(angleName:string)Parameter Type Description
angleName string
intGetFontFamilyValue(familyName:string)Parameter Type Description
familyName string
intGetFontVariationValue(variationName:string)Parameter Type Description
variationName string
intGetFontWeightValue(weightName:string)Parameter Type Description
weightName string
PropValsGetImportDefaultParams()
PropValsGetIteratorDefaultParams()
KeyCatalogGetKeyCatalog(tag:string)Parameter Type Description
tag string
PropValsGetNewXMLDefaultParams()
PropValsGetOpenDefaultParams()
intGetPropIndex(propVals:PropVals,propNum:int)Parameter Type Description
propVals PropVals
propNum int
PropValsGetSaveDefaultParams()
StringsGetSupportedEncodings()
PropValsGetUpdateBookDefaultParams()
stringInitializationName(i:int)Parameter Type Description
i int
boolIsDRL(drl:string)Parameter Type Description
drl string
boolIsDataDifferentFromTemplateData(templatePath:string,templateDataProps:PropVals)Parameter Type Description
templatePath string
templateDataProps PropVals
boolIsEncodingSupported(encodingName:string)Parameter Type Description
encodingName string
boolIsFileValid(docOrBookId:Object,silent:bool)Parameter Type Description
docOrBookId Object
silent bool
voidLoadMenuCustomizationFile(pathname:string,silent:bool)Parameter Type Description
pathname string
silent bool
intLogFMPIPEvent(category:string,subcategory:string,eventName:string)Parameter Type Description
category string
subcategory string
eventName string
intMenuExists(menu:string)Parameter Type Description
menu string
KeyCatalogNewKeyCatalog(tag:string)Parameter Type Description
tag string
ObjectNewXML(newXMLParams:PropVals,newXMLReturnParamspp:PropVals)Parameter Type Description
newXMLParams PropVals
newXMLReturnParamspp PropVals
intNotification(notification:int,state:int)Parameter Type Description
notification int
state int
stringNotificationName(i:int)Parameter Type Description
i int
ObjectOpen(fileName:string,openParams:PropVals,openReturnParams:PropVals)Parameter Type Description
fileName string
openParams PropVals
openReturnParams PropVals
intPopClipboard(:void)Parameter Type Description
void
voidPrintErrno(i:int)Parameter Type Description
i int
voidPrintExportStatus(p:PropVals)Parameter Type Description
p PropVals
voidPrintFAErrno(_:void)Parameter Type Description
_ void
voidPrintImportStatus(p:PropVals)Parameter Type Description
p PropVals
voidPrintInitialization(i:int)Parameter Type Description
i int
voidPrintNotification(i:int)Parameter Type Description
i int
voidPrintOpenStatus(p:PropVals)Parameter Type Description
p PropVals
voidPrintPropVal(p:PropVal)Parameter Type Description
p PropVal
voidPrintPropVals(p:PropVals)Parameter Type Description
p PropVals
voidPrintSaveStatus(p:PropVals)Parameter Type Description
p PropVals
voidPrintTextItem(textItem:TextItem)Parameter Type Description
textItem TextItem
voidPrintTextItems(textItems:TextItems)Parameter Type Description
textItems TextItems
voidPrintUpdateBookStatus(p:PropVals)Parameter Type Description
p PropVals
intPromptInt(message:string,stuffVal:string)Parameter Type Description
message string
stuffVal string
intPromptMetric(message:string,stuffVal:string,defaultunit:int)Parameter Type Description
message string
stuffVal string
defaultunit int
intPromptString(message:string,stuffVal:string)Parameter Type Description
message string
stuffVal string
voidPushClipboard(:void)Parameter Type Description
void
intRemoveMenu(fromMenu:string,label:string)Parameter Type Description
fromMenu string
label string
intReturnValue(retvalue:int)Parameter Type Description
retvalue int
intRun(:void)Parameter Type Description
void
intScrollBox(title:string,stringslist:Strings,_default:int)Parameter Type Description
title string
stringslist Strings
_default int
intService()
intSetDdeInstance(ddeInstance:int)Parameter Type Description
ddeInstance int
intShortcutExists(shortcut:string)Parameter Type Description
shortcut string
voidShutDown(_:void)Parameter Type Description
_ void
DocSimpleNewDoc(templateName:string,interactive:int)Parameter Type Description
templateName string
interactive int
ObjectSimpleOpen(fileName:string,interactive:int)Parameter Type Description
fileName string
interactive int
intSleep(seconds:int)Parameter Type Description
seconds int
intStringLen(s:string)
Parameter Type Description
s string
intUSleep(microseconds:int)Parameter Type Description
microseconds int
voidUpdateMenus(:void)Parameter Type Description
void
intUserCancel(:void)Parameter Type Description
void
voidWinInstallDefaultMessageFilter(:void)Parameter Type Description
void
Jongware,18-Jan-2015v1.0 Contents::Index