jade encyclopaedia of classes (volume 2) · encyclosys2-2018.0.01 jadetableelementproperties 144...

Copyright©2018 Jade Software Corporation Limited. All rights reserved.

Encyclopaedia of ClassesVolume 2

V E R S I O N 2018.0.01

Jade Software Corporation Limited cannot accept any financial or other responsibilities that may be the result of your use of this informationor software material, including direct, indirect, special or consequential damages, or loss of profits. There are no warranties extended orgranted by this document or software material.

You should be very careful to ensure that the use of this software material and/or information complies with the laws, rules, and regulationsof the jurisdictions with respect to which it is used. No part of this document may be reproduced or transmitted in any form or by any means,electronic or mechanical, for any purpose, without the express written permission of Jade Software Corporation Limited.

The information contained herein is subject to change without notice. Revisions may be issued to advise of such changes and/or additions.

Copyright © 2018 Jade Software Corporation Limited.

All rights reserved.

JADE is a trademark of Jade Software Corporation Limited. All trade names referenced are the service mark, trademark, or registeredtrademark of the respective manufacturer.

For details about other licensing agreements for third-party products, you must read the JADEReadMe.txt file.

EncycloSys2 - 2018.0.01

Contents

Contents iii

Before You Begin xxxiiiWho Should Read this Encyclopaedia xxxiiiWhat’s Included in this Encyclopaedia xxxiiiRelated Documentation xxxiiiConventions xxxiv

Chapter 1 System Classes 35JadeSkinApplication Class 44

JadeSkinApplication Properties 44myFormSkins 44myControlSkins 44

JadeSkinApplication Method 45updateSkinTimeStamp 45

JadeSkinArea Class 46JadeSkinArea Class Constants 48JadeSkinArea Properties 48

backColor 48imgBorderBottomLeft 49imgBorderBottomRight 49imgBorderBottomStrip 49imgBorderLeftStrip 50imgBorderRightStrip 50imgBorderTopLeft 50imgBorderTopRight 50imgBorderTopStrip 50imgInner 50innerIsBrush 51

JadeSkinCategory Class 52JadeSkinControl Class and Subclasses 53

JadeSkinControl Class Constants 53JadeSkinControl Properties 54

applyCondition 54borderStyle 55focusBackColor 55focusForeColor 57fontBold 58fontItalic 59fontName 59fontSize 60fontStrikethru 60fontUnderline 61foreColor 61foreColorDisabled 61

JadeSkinBaseControl Class 62JadeSkinBrowseButtons Class 62

JadeSkinBrowseButtons Properties 62myFirstButton 62myLastButton 62myNextButton 63myPriorButton 63

JadeSkinButton Class 63JadeSkinButton Properties 63

createRegionFromMask 64myButtonDisabled 64myButtonDown 64myButtonFocus 64


myButtonFocusDown 64myButtonRollOver 65myButtonRollUnder 65myButtonUp 65

JadeSkinCheckBox Class 65JadeSkinCheckBox Properties 66

myFalseImage 66myTrueImage 66

JadeSkinComboBox Class 66JadeSkinComboBox Properties 67

buttonRightOffset 67imgComboButtonDownRollOver 67myComboButton 68myListBoxSkin 68mySimpleComboTextBoxSkin 68

JadeSkinFolder Class 68JadeSkinFolder Properties 68

myTabsButton 69tabActiveColor 69tabHeight 69tabInactiveColor 70

JadeSkinFrame Class 70JadeSkinGroupBox Class 70

JadeSkinGroupBox Class Constants 71JadeSkinGroupBox Properties 71

captionPosition 71captionPositionLeftOffset 72captionPositionTopOffset 72myLabelSkin 72

JadeSkinHScroll Class 73JadeSkinHScroll Properties 73

myLeftButton 73myRightButton 73

JadeSkinJadeDockBar Class 74JadeSkinJadeDockBase Class 74

JadeSkinJadeDockBase Properties 74myHorizontalGripBar 74myHorizontalResizeBar 74myVerticalGripBar 75myVerticalResizeBar 75

JadeSkinJadeDockContainer Class 75JadeSkinJadeEditMask Class 75JadeSkinJadeMask Class 75

JadeSkinJadeMask Property 76myButtonSkin 76

JadeSkinJadeRichText Class 76JadeSkinLabel Class 76JadeSkinListBox Class 76

JadeSkinListBox Properties 77alternatingRowBackColor 77alternatingRowBackColorCount 78imgPictureClosed 78imgPictureLeaf 79imgPictureMinus 79imgPictureOpen 79imgPicturePlus 79selectionColor 79selectionColorText 80

JadeSkinOleControl Class 80JadeSkinOptionButton Class 80

JadeSkinOptionButton Properties 80

Encyclopaedia of Classes(Volume 2)

Contents iv


myFalseImage 81myTrueImage 81

JadeSkinPicture Class 81JadeSkinProgressBar Class 81

JadeSkinProgressBar Property 81myProgressImage 82

JadeSkinScrollBar Class 82JadeSkinScrollBar Properties 82

imgHighLightBrush 82myThumbTrack 83myThumbTrackDisabled 83myThumbTrackDown 83myThumbTrackRollOver 83

JadeSkinSheet Class 83JadeSkinSheet Property 84

myTabButton 84JadeSkinStatusLine Class 84JadeSkinTable Class 84

JadeSkinTable Properties 84alternatingRowBackColor 85alternatingRowBackColorCount 86fixed3D 86fixedColumnsBackColor 86fixedRowColorHasPrecedence 87fixedRowsBackColor 87myCheckBoxSkin 87selectionColor 88selectionColorText 88tabActiveColor 88tabInactiveColor 88

JadeSkinTextBox Class 88JadeSkinTextBox Properties 89

hintBackColor 89hintForeColor 89

JadeSkinVScroll Class 90JadeSkinVScroll Properties 90

myBottomButton 90myTopButton 90

JadeSkinEntity Class 91JadeSkinEntity Class Constant 91JadeSkinEntity Properties 91

description 91myOwners 92mySkinRoot 92name 92

JadeSkinForm Class 93JadeSkinForm Properties 94

captionActiveForeColor 96captionFontBold 96captionFontItalic 97captionFontName 97captionFontSize 98captionInactiveForeColor 98captionLeft 98captionTop 98centerCaption 99drawMenuSelectionFlat 99imgInactiveBorderBottomLeft 99imgInactiveBorderBottomRight 99imgInactiveBorderBottomStrip 100imgInactiveBorderLeftStrip 100


Contents v


imgInactiveBorderRightStrip 100imgInactiveBorderTopLeft 100imgInactiveBorderTopRight 100imgInactiveBorderTopStrip 101imgMenuLeft 101imgMenuRight 101imgMenuStrip 101menuBackColor 101menuBackColorSelected 102menuFontBold 102menuFontItalic 102menuFontName 102menuFontSize 102menuForeColor 102menuForeColorDisabled 103menuForeColorSelected 103menuLeftPosition 103menuTopPosition 103myChildMinimizeBtn 103myChildRestoreBtn 104myChildTerminateBtn 104myMaximizeBtn 104myMaximizedBtn 104myMenuSkin 105myMinimizeBtn 105myTerminateBtn 105showMenuLineAlways 105transparentColorForButtons 105useMenuLineSkinForMenus 106

JadeSkinMenu Class 107JadeSkinMenu Properties 107

backColorSelected 108borderStyle 108drawMenuSelectionFlat 109fontBold 109fontItalic 109fontName 110fontSize 110foreColor 110foreColorDisabled 110foreColorSelected 111imgCheckMark 111imgRightArrow 111imgSeparator 111lineHeight 112pixelsAfterCheckMark 112pixelsAfterPicture 112pixelsBeforeAccelerator 112pixelsBeforeCheckMark 113pixelsBeforeRightArrow 113

JadeSkinRoot Class 114JadeSkinRoot Properties 114

allApplicationSkins 114allControlSkins 114allFormSkins 115allMenuSkins 115allSimpleButtonSkins 115allSkinCategories 115allSkinEntities 115allWindowStateImages 116

JadeSkinSimpleButton Class 117


Contents vi


JadeSkinSimpleButton Properties 117imgDisabled 117imgDown 118imgRollOver 118imgUp 118

JadeSkinWindow Class 119JadeSkinWindow Properties 119

myImageMask 119mySkinCategory 119

JadeSkinWindowStateImage Class 121JadeSkinWindowStateImage Properties 121

foreColor 121isImageMask 121

JadeSOAPException Class 123JadeSSLContext Class 124

JadeSSLContext Class Constants 125JadeSSLContext Properties 125

caFile 126caPath 126cipherList 126methodType 126verifyDepth 127verifyRemoteCertificate 127x509 127

JadeSSLContext Methods 127getActiveCipher 128getPeerCertificate 128

JadeTableCell Class 129JadeTableCell Properties 129

column 130comboIndex 130hyperLink 131mergeCells 131picture 133row 133sheet 134text 134

JadeTableCell Methods 134delete 134getCellWidth 135positionLeft 135positionTop 135setPictureDescription 136

JadeTableColumn Class 137JadeTableColumn Properties 137

column 138maxColumnWidth 138sheet 139sortAsc 139sortCased 139sortOrder 139sortType 140visible 140width 140widthPercent 141

JadeTableColumn Methods 141delete 141findObject 142findString 142restoreAutoSize 142

JadeTableElement Class 143


Contents vii


JadeTableElement Properties 144alignment 145backColor 145cellControl 145comboList 146decimals 146editMask 146enabled 146fontBold 147fontItalic 147fontName 147fontSize 147fontStrikethru 148fontUnderline 148foreColor 148gridBottom 148gridRight 149inputType 150itemObject 150marginBottom 150marginLeft 151marginRight 151marginTop 152maxLength 152partialTextIndication 152selected 153wordWrap 153

JadeTableRow Class 154JadeTableRow Properties 154

height 154row 155sheet 155visible 155

JadeTableRow Methods 156delete 156findObject 156findString 156restoreAutoSize 157

JadeTableSheet Class 158JadeTableSheet Properties 158

alternatingRowBackColor 159alternatingRowBackColorCount 160caption 161column 161columns 161currentRowImage 162displaySorting 162extendedColumn 163fixed3D 164fixedColumns 164fixedRows 164gridColor 164gridLines 165leftColumn 165myTable 165pixelHorzScrollIncrement 165pixelVertScrollIncrement 166row 166rows 167scrollBars 167scrollHorzPos 167


Contents viii


scrollMode 168scrollVertPos 168sheet 169showCurrentRowImage 169showPartialTextBubbleHelp 169tabInitialPosition 170tabOffEnds 171topRow 171visible 171widthPercentStyle 171

JadeTableSheet Methods 172accessCell 173accessColumn 173accessRow 174addItem 174addItemAt 174clear 175delete 175findColumnObject 175findObject 175findRowObject 176findString 176getCollection 177getCellFromPosition 177insertColumn 177moveColumn 177moveRow 178positionCollection 178refreshEntries 178removeItem 179resort 179restoreAutoSize 179selectedCount 179selectedNext 179setCollectionObject 180

JadeTcpIpProxy Class 181Proxy Communication Code Examples 181Considerations when Implementing JadeTcpIpProxy Class Features 183JadeTcpIpProxy Class Constants 184JadeTcpIpProxy Properties 184

browserType 184domain 185host 185password 185port 186proxyType 186userName 187

JadeTcpIpProxy Method 188connect 188

JadeTestCase Class 189JadeTestCase Methods 189

assert 190assertEquals 190assertEqualsMsg 190assertFalse 191assertFalseMsg 191assertNotNull 192assertNotNullMsg 192assertNull 192assertNullMsg 193assertTrue 193


Contents ix


assertTrueMsg 194expectedException 194info 195

JadeTestListenerIF Interface 196JadeTestListenerIF Interface Callback Method Signatures 197

finish 197message 198methodSuccess 198start 198testFailure 199testSkipped 199testSuccess 199

JadeTestRunner Class 201JadeTestRunner Class Methods 201

runTests 201setDebugOnAssert 202setDebugOnException 202setDebugOnUnexpectedException 202setLogCallStack 202setTestListener 202

JadeTransactionTrace Class 204JadeTransactionTrace Class Constants 204JadeTransactionTrace Properties 205

myProcess 205startTime 205status 205stopTime 205tranId 206

JadeTransactionTrace Methods 206clear 206getEntry 206getEntryCount 207

JadeUserCollClass Class 208JadeUserCollClass Methods 208

addExternalKey 208addMemberKey 209clearKeys 210endKeys 210setLength 210setMembership 210

Using JadeUserCollClass Collections 211JadeWebService Class 212

JadeWebService Class Constants 212JadeWebService Methods 212

isNilItem 213setAnyPropType 213setError 214

JadeWebServiceConsumer Class 215JadeWebServiceConsumer Class Constants 215JadeWebServiceConsumer Properties 215

characterConversionException 216handleCharConversionException 216logStatistics 217password 217proxyHostName 217proxyPassword 217proxyUsername 217soapHeaders 218soapRequest 218soapResponse 218timeout 218


Contents x


unknownHeaders 218userName 219workerApp 219

JadeWebServiceConsumer Methods 219addHttpHeader 220getEndpointURL 220getHttpHeader 221getHttpHeaderClient 221getHttpHeaderServer 221getLastStatistics 222getTimeouts 224invoke 224invokeAsync 225invokeAsyncWithVerb 226invokeWithVerb 227processReply 228reset 228sendRequest 228setEndpointURL 228setTimeouts 229

JadeWebServiceProvider Class 230JadeWebServiceProvider Properties 230

deleteTransientReturnType 230incomingMessage 230rawXML 230unknownHeaders 231

JadeWebServiceProvider Methods 231createVirtualDirectoryFile 231deleteVirtualDirectoryFile 232getLastStatistics 232getServerVariable 234initialize 236isVDFilePresent 236processMessage 236processRequest 236processRequestPostHeaders 237reply 237

JadeWebServiceSoapHeader Class 238JadeWebServiceSoapHeader Properties 238

actor 238didUnderstand 238mustUnderstand 239

JadeWebServiceUnknownHeader Class 240JadeWebServiceUnknownHeader Properties 240

headerXML 240webService 240

JadeWebSocket Class 241JadeWebSocket Property 241

id 241JadeWebSocket Methods 241

onClose 241onMsg 242onOpen 242send 242sendText 242

JadeWebSocketServer Class 243JadeWebSocketServer Methods 243

getWebSocket 243run 243stop 244

JadeX509Certificate Class 245


Contents xi


JadeX509Certificate Properties 245endDate 245issuer 245purpose 245startDate 246subject 246

JadeX509Certificate Methods 246readCertificateDataFromFile 246readPrivateKeyDataFromFile 246

JadeXMLAttribute Class 248JadeXMLAttribute Properties 248

element 248localName 248name 248namespaceURI 248value 249

JadeXMLAttribute Method 249namespacePrefix 249

JadeXMLCDATA Class 250JadeXMLCharacterData Class 251

JadeXMLCharacterData Property 251data 251

JadeXMLComment Class 252JadeXMLDocument Class 253

JadeXMLDocument Properties 253docType 253endOfLine 254indentString 254keepWhitespace 254outputDeclaration 254rootElement 254

JadeXMLDocument Methods 254addComment 255addCommentObject 255addDocumentType 256addDocumentTypeObject 256addElement 256addElementNS 257addElementObject 257addElementObjectNS 257addProcessingInstruction 257addProcessingInstructionObject 257findElementByNameNS 257findElementByTagName 258findElementsByNameNS 258findElementsByTagName 258getElementByTagName 259getElementByTagNameNS 259getElementsByTagName 259getElementsByTagNameNS 259parseFile 260parseString 260writeToFile 260

JadeXMLDocumentParser Class 261JadeXMLDocumentParser Methods 261

comment 261parseDocumentFile 261parseDocumentString 262processingInstruction 262setClassMapping 262startCDATA 262


Contents xii


JadeXMLDocumentType Class 263JadeXMLDocumentType Properties 263

internalSubset 263name 263publicId 263systemId 263

JadeXMLElement Class 264JadeXMLElement Properties 264

attributes 264localName 264namespaceURI 265tagName 265textData 265

JadeXMLElement Methods 265addAttribute 266addAttributeNS 266addAttributeObject 266addAttributeObjectNS 267addCDATA 267addCDATAObject 267addComment 267addCommentObject 267addElement 267addElementNS 268addElementObject 268addElementObjectNS 268addProcessingInstruction 268addProcessingInstructionObject 268addText 268addTextObject 269findAllElementsByNameNS 269findAllElementsByTagName 269getAllElementsByTagName 269getAllElementsByTagNameNS 270getAttributeByName 270getAttributeByNameNS 270getElementByTagName 270getElementByTagNameNS 270getElementsByTagName 271getElementsByTagNameNS 271namespacePrefix 271parentElement 271setText 271text 271

JadeXMLException Class 272JadeXMLException Class Constants 272JadeXMLException Properties 273

columnNumber 273fileName 273lineNumber 273

JadeXMLNode Class 274JadeXMLNode Properties 274

childNodes 274document 274parentNode 274

JadeXMLNode Methods 275copyAfter 275copyAsChildOf 275copyBefore 275descendsFrom 275moveAfter 276


Contents xiii


moveAsChildOf 276moveBefore 276remove 276writeToString 276

JadeXMLParser Class 278JadeXMLParser Methods 278

characters 279columnNumber 279comment 279endCDATA 279endDTD 280endElement 280fileName 280getAttribute 280getAttributeValueByName 281getAttributeValueByNameNS 281lineNumber 282parseFile 282parseString 282processingInstruction 283startCDATA 283startDTD 283startElement 284

JadeXMLProcessingInstruction Class 285JadeXMLProcessingInstruction Properties 285

data 285target 285

JadeXMLText Class 286List Class 287

List Methods 287clear 287copy 287purge 288

Locale Class 289Locale Class Constants 289Locale Properties 289

cloneOf 289clones 290forms 290languageId 290schema 290translatableStrings 290

Locale Methods 290getAllTranslatableStrings 291getForms 291getStringValue 291getTranslatableStringLocal 291getTranslatableStrings 291getTranslatableStringsByNum 291hasClones 291isClone 292makeLocaleName 292

LocaleFormat Class 293LocaleFormat Property 293

schema 293LocaleFullInfo Class 294

LocaleFullInfo Class Constants 294LocaleFullInfo Properties 294

currencyInfo 295dateInfo 295defaultCodePage 295


Contents xiv


defaultCountryCode 295defaultLanguageId 295listSeparator 296measurementSystem 296nativeDigits 296numericInfo 296timeInfo 297

LocaleNameInfo Class 298LocaleNameInfo Properties 298

abbreviatedCountryName 298abbreviatedLangName 299countryCode 299englishCountryName 299englishLangName 299languageId 299localeId 299localizedCountryName 300localizedLangName 300nativeCountryName 300nativeLangName 300

Lock Class 301Lock Class Constants 301Lock Properties 301

duration 302elapsedTime 302kind 302lockedBy 303requestedBy 303requestTime 304type 304waitTime 304

Lock Method 305target 305

LockArray Class 306LockContentionInfo Class 307

LockContentionInfo Properties 307maxWaitTime 307totalContentions 307totalWaitTime 307

LockContentionInfo Method 308target 308

Example of Displaying Lock Contention Information 308LockException Class 310

LockException Properties 310lockDuration 310lockTimeout 311lockType 312retryCount 312targetLockedBy 312

LockException Methods 312lockTarget 313retryLock 313showDialog 314

MemberKeyDictionary Class 315MemberKeyDictionary Methods 315

add 315includes 316indexNear 316indexNear64 317purge 317remove 317


Contents xv


MenuItem Class 318MenuItem Class Constants 319MenuItem Properties 319

allChildren 320caption 320checked 321children 321description 322disableReason 322enabled 322form 322helpContextId 323helpKeyword 323index 324name 324picture 324securityLevelEnabled 325securityLevelVisible 325userObject 325visible 326webFileName 326

MenuItem Methods 326getLevel 327getMenuItem 327loadMenu 327loadSubMenu 328setEventMapping 328setEventMappingEx 329setShortCutKey 330

MenuItem Events 330click 331select 331

MergeIterator Class 332MergeIterator Property 333

ignoreDuplicates 333MergeIterator Methods 333

addCollection 334back 334current 334getCollectionAt 335getCollectionCount 335getCurrentCollection 335getCurrentKey 335getCurrentKeys 335isValid 336next 336removeCollection 337reset 337startAtObject 337startKeyGeq 337startKeyGtr 338startKeyLeq 338startKeyLss 338

MethodCallDesc Class 339MethodCallDesc Properties 339

invocationMode 339method 340position 340

MethodCallDesc Methods 340getName 340getReceiver 340


Contents xvi


logSelf 341MultiMediaType Class 342

MultiMediaType Property 342usePresentationFileSystem 342

NamedPipe Class 343NamedPipe Property 343

serverName 344NamedPipe Methods 344

close 344closeAsynch 345getMaxMessageSize 345listen 345listenAsynch 346open 346openAsynch 347readBinary 347readBinaryAsynch 347writeBinary 348writeBinaryAsynch 348

Node Class 350Node Class Constants 350Node Properties 351

accessPatterns 351name 352osID 352processes 352system 352userExitCode 352

Node Methods 353beginIndividualRequestsLogging 356beginSample 357clearMethodCache 358createExternalProcess 358downloadCount 360endIndividualRequestsLogging 360endSample 360getAppServerGroupName 361getCacheSizes 361getCacheSizes64 361getCharacterSize 361getCommandLine 362getComputerName 362getDefaultLCID 362getEnvironmentVariable 363getExecuteFlagValue 363getIniFileName 363getJadeInstallDirectory 364getJadeHomeDirectory 364getJadeWorkDirectory 364getLCIDFromCharacterSet 364getLineDelimiter 365getLocks 365getMutexCounts 366getNotes 367getObjectCaches 367getOSDetails 369getOSPlatform 371getProfileString 372getProgramDataDirectory 373getQueuedLocks 374getRequestStats 375


Contents xvii


getRpcServerStatistics 376getTempPath 377getUserDataDirectory 378isApplicationServer 378isCacheCoherencyEnabled 378isReadOnlySchema 379isReadOnlySystemSchema 379isServerNode 379isService 379logObjectCaches 379logRequestStatistics 380logUserCommand 381networkAddress 382nodeRole 382nodeType 382osProcessId 383processDump 383setCacheSizes 383setCacheSizes64 384setExecuteFlagValue 384setProfileString 385wbemListClasses 386wbemListInstanceNames 387wbemQueryQualifiers 388wbemRetrieveData 390

NormalException Class 394Notification Class 396

Notification Properties 396elapsedTime 396eventType 396featureNumber 397isInterface 397requestedBy 397requestTime 397responseType 397serialNumber 398typeNumber 398userTag 398

Notification Methods 398subscriber 398target 399

NotificationArray Class 400NotificationException Class 401

NotificationException Method 401notificationTarget 401

NumberFormat Class 402NumberFormat Class Constants 402NumberFormat Properties 402

decimalPlaces 403decimalSeparator 403groupings 403negativeFormat 403negativeSign 404positiveSign 404showLeadingZeros 404thousandSeparator 404

NumberFormat Method 404defineNumberFormat 404

Object Class 406Object Methods 406

autoPartitionIndex 410


Contents xviii


beginClassNotification 410theClass 411transients 412eventType 412responseType 412eventTag 412

beginClassNotificationForIF 413theInterface 413

beginClassesNotification 414theClass 415includeSubclasses 415transients 416eventType 416responseType 416eventTag 416

beginClassesNotificationForIF 417theInterface 418

beginNotification 418theObj 419eventType 419responseType 419eventTag 420Example of Beginning Notifications 420

beginNotificationForIF 421theInterface 422

beginTimer 422beginTimerForIF 423causeEvent 424changeObjectVolatility 425class 426cloneSelf 426cloneSelfAs 426copySelf 426copySelfAs 427creationTime 427deletePropertyValue 427display 427edition 428endClassNotification 428

theClass 428transients 428eventType 428

endClassNotificationForIF 429theInterface 429

endClassesNotification 430theClass 430includeSubclasses 430transients 430eventType 430

endClassesNotificationForIF 431theInterface 431

endNotification 432theObj 432eventType 432

endNotificationForIF 432theInterface 433

endNotificationForSubscriber 433endTimer 434endTimerForIF 434exclusiveLock 434getClassForObject 434


Contents xix


getClassNumberForObject 435getInstanceIdForObject 435getInstanceIdForObject64 435getLockCallStack 435getLockStatus 436getModifiedBy 436getName 436getObjectStringForObject 436getObjectVolatility 437getOidString 437getOidStringForObject 438getOwnerForObject 438getPropertyValue 438getTimerStatus 439getTimerStatusForIF 439getUpdateTranID 440hasMembers 440inspect 440inspectModal 440invokeIOMethod 441invokeMethod 442isImportedObject 443isKindOf 444isLockedByMe 444isObjectFrozen 444isObjectNonSharedTransient 444isObjectPersistent 444isObjectSharedTransient 444isObjectStable 444isObjectTransient 445isObjectVolatile 445isSharedTransient 445isSystemObject 445isTransient 445jadeReportWriterCheck 445jadeReportWriterDisplay 446latestEdition 446lock 446makeObjectFrozen 447makeObjectStable 448makeObjectVolatile 448moveToPartition 448reserveLock 449respondsTo 449resynch 449resynchObject 449sdeCauseEvent 450sdsCauseEvent 451sendMsg 453sendMsgWithIOParams 453sendMsgWithParams 454sendTypeMsg 454sendTypeMsgWithIOParams 455sendTypeMsgWithParams 455setPartitionID 456setPartitionIndex 456setPropertyValue 456sharedLock 457sysNotification 457

eventType 457theObject 458


Contents xx


eventTag 458timerEvent 458tryGetPropertyValue 458tryLock 459unlock 460updateLock 460updateObjectEdition 460userNotification 461

eventType 461theObject 461eventTag 461userInfo 461

version 462ObjectArray Class 463

ObjectArray Method 464addAll 464

ObjectByObjectDict Class 465ObjectLongNameDict Class 466ObjMethodCallDesc Class 467

ObjMethodCallDesc Property 467interfaceMethod 467

ObjMethodCallDesc Method 467getReceiver 467

ObjectSet Class 468ODBCException Class 469

ODBCException Properties 469nativeError 469state 469

ODBCException Method 469showDialog 470

OleObject Class 471OleObject Properties 471

compressed 471fullName 471oleData 472shortName 472

OleObject Methods 472copy 472getData 473isServerRegistered 473setData 473

PointArray Class 474PrimMethodCallDesc Class 475

PrimMethodCallDesc Property 475primNo 475

PrimMethodCallDesc Method 475getReceiver 475

Printer Class 476Defining Your JADE Report Layouts 477

Layering Print Output 478Printer Class Constants 479Printer Properties 480

autoPaging 481bottomOfPage 481collate 481copies 481documentType 482drawFillColor 484drawFillStyle 485drawFontBold 485drawFontItalic 485


Contents xxi


drawFontName 486drawFontSize 486drawFontStrikethru 486drawFontUnderline 486drawStyle 487drawTextAlign 487drawTextCharRotation 488drawTextRotation 488drawWidth 488duplex 489footerFrame 489headerFrame 489leftMargin 490orientation 490pageBorderWidth 491pageNumber 491paperSource 491printPreview 492printPreviewAllowPrint 493printPreviewAllowSelect 493printPreviewReduce 493retainCMDValues 493rightMargin 494suppressDialog 494title 494topOfPage 494

Printer Methods 495abort 497centreFrame 497close 497drawArc 498drawChord 499drawEllipse 499drawFilledRectangle 500drawGrid 501drawLine 502drawPie 502drawRectangle 503drawRoundRectangle 504drawSolidRectangle 505drawTextAt 505drawTextIn 506drawTextSize 507drawTextSizeIn 507frameFits 508getAllPaperSources 508getAllPrinterPaperSources 509getAllPrinters 509getDefaultDocumentType 510getDefaultPaperSource 510getFooter 511getHeader 511getPrintedStatus 511getPrinterName 511getPrintPosition 512getReport 512isPrinterOpen 512newPage 512pageHeight 513pageWidth 513print 513


Contents xxii


printActive 516printPage 516printReport 516printUnformatted 516setCustomPaperSize 518setFooter 518setHeader 519setMargins 519setPrinter 520setPrintFileName 521setPrintPosition 522setReport 523useCustomPrinterSettings 523

Using the Common Print Setup Dialog 523Using the Print Progress Dialog 524Examples of Printer Methods 525Free-Format Printing 525Previewing Print Output 528

Using the Select Pages To Print Dialog 529Searching Previewed Output 530

Portable Printing 531Process Class 533

Process Class Constants 533Process Properties 533

adminInfo 534node 534number 534persistentApp 534schema 534signOnTime 535signOnUserCode 535status 535type 535userCode 536userExitCode 536userInfo 537

Process Methods 538addLockCallStackFilter 543adjustObjectCachePriority 543allowTransientToPersistentInvs 544allowTransientToSharedTranInvs 544allTransientInstances 544analyzeTransientFileUsage 545appServerPort 545beginMethodProfiling 545changeUserCode 546classAccessFrequenciesStatus 546clearLockCallStackFilter 546compactTransientFile 547countQueuedNotifications 547createTransientMethod 547currentStack 548debug 549deleteTransientMethod 549disableAllTransTraceCallbacks 549enableClassAccessFrequencies 549enableTransTraceCallback 550endMethodProfiling 550executeIOScript 551executeScript 552executeTransientIOMethod 553


Contents xxiii


executeTransientMethod 554extractRequestStatistics 555extractWebStatistics 557finalizePackages 558getAllApps 559getBufferStatistics 559getCallStackInfo 561getCommandLine 561getComputerName 562getDateTimeDelta 562getExceptionHandlerStack 562getErrorText 563getIniFileName 563getJadeInstallDirectory 563getJadeHomeDirectory 563getJadeWorkDirectory 564getLastExtFunctionCallError 564getLockCallStackFilter 564getMethodCacheLimit 564getMethodCacheStatistics 564getMethodProfileInfo 566getOSDetails 567getOSPlatform 570getPersistentDeadlockPriority 571getProcessApp 571getProfileString 571getProgramDataDirectory 572getRequestStatistics 573getRpcServerStatistics 573getSaveLockCallStack 574getSignOnUsage 575getStringPoolLimit 575getTempPath 575getTimers 575getTrackedMethod 576getTrackedMethodReceiver 577getTrackedMethodReturnValue 577getTrackedMethodStatus 577getTransactionId 577getTransactionId64 577getTransactionTraceCallbacks 578getTransactionTraceObject 578getTransientDeadlockPriority 578getTransientFileLength 579getTransientFileName 579getUserDataDirectory 579initializePackages 580isCommitting 580isInExceptionState 580isInImportedContext 580isInLoadState 581isInLockState 581isInTransactionState 581isInTransientTransactionState 582isRunningScript 582isUserDataPump 582isUsingThinClient 582iteratorsExcludeOfflineObjects 582networkAddress 582profileMethod 583profiler 583


Contents xxiv


prohibitBeginTransaction 584prohibitPersistentUpdates 584removeMethodProfileInfo 585resumeTimers 585rpsSuppressTransactionDeletes 585sendCallStackInfo 585sendMethodCacheStatistics 586sendRequestStatistics 587sendTransientFileAnalysis 588sendTransientFileInfo 589sendWebStatistics 590setDateTimeDelta 591setDefaultLockTimeout 591setMethodCacheLimit 592setObjectCachePriority 592setPersistentDeadlockPriority 593setProfileString 593setSaveLockCallStack 594setStringPoolLimit 595setTransientDeadlockPriority 595sleep 595startMethodTracking 596startTransactionTrace 597stopMethodTracking 597stopTransactionTrace 597suspendTimers 597transactionTraceStarted 598transientPersistentInvsEnabled 598transientSharedTranInvsEnabled 598truncateOnDecimalOverflow 598useUpdateLocks 599waitForMethods 599

ProcessDict Class 600ProcessStackArray Class 601RealArray Class 602Rectangle Class 603

Rectangle Properties 603bottom 603left 603right 603top 603

Rectangle Methods 604copy 604display 604isEmpty 604set 604

RelationalView Class 605RelationalView Class Constants 605RelationalView Properties 606

creator 606name 606rpsDatabaseName 607rpsDatabaseType 607rpsDefaultConnectionString 607rpsDefaultPassword 607rpsDefaultUserName 607rpsExceptionCreate 608rpsExceptionDelete 608rpsExceptionUpdate 608rpsLoggingOptions 608rpsShowMethods 609


Contents xxv


rpsShowVirtualProperties 609rpsTopSchemaName 609rpsUseOidClassInstMap 609schema 609timeCreated 610

RelationalView Methods 610addUserAttribute 611addUserTable 611changeColumnName 612columnExists 612createExcludedJcfFile 612excludeTableColumnName 613excludeTableName 613extractData 613extractDataAll 614extractDataUsingIniFileOptions 616generateRpsTableCreationScript 616getColumnFeature 617getExcludedTableColumnNames 617getExcludedTableNames 617getRpsMappedClasses 618getTableColumnNames 618getTableNames 618isODBCRelationalView 618isRpsMapping 619removeColumn 619removeTable 619tableExists 619versionRpsMapping 619

RootSchemaSession Class 621RootSchemaSession Properties 621

allowHiddenControlEvents 621userSecurityLevel 621

Schema Class 623Schema Class Constants 623Schema Properties 623

externalDatabases 623formsManagement 624jomVersion 624name 624needsReorg 624patchVersion 624superschema 624relationalViews 625rpsDatabases 625text 625

Schema Methods 625addCompileTranslatableString 628addUserCollectionSubclass 629addUserSubclass 629allClasses 629allDatabases 630allJadeInterfaces 630allLibraries 630allPrimitives 630allSubschemas 630buildFormData 630constantNames 631createWebServiceApplication 631deleteUserSubclass 633extractControlIdsCSV 633


Contents xxvi


extractControlIdsCSVforSchema 634findClassInBranch 634findClassInSubschema 635findFormForLocale 635findFormForLocaleInAllSchemas 635findFormForLocaleInSupers 635findGlobalConstantInBranch 635findMeForm 635findName 636findProperty 636findType 636generateWSDL 636getAllBaseLocales 637getAllClasses 637getAllFormTranslations 637getAllInheritedLocales 637getAllLocales 637getAllLocalLocales 637getAllSystemLocales 638getAllRpsMappings 638getAppliedPatches 638getBaseLocalesLocal 639getCategory 639getClass 639getClassByNumber 639getConstant 639getConstantCategory 639getControlClasses 640getCurrentLocaleId 640getDefaultLocale 640getExternalDatabase 640getFormatAnywhereInPath 640getFormatAnywhereInPathLatest 641getFormatAnywhereInSubs 641getFormatAnywhereInSubsLatest 641getFunction 641getGlobalClass 641getGlobalConstant 641getHtmlDocumentSource 641getImportedClass 642getImportedJadeinterface 642getInheritedFormats 642getInheritedXlatableStrings 643getJadeInterface 643getLibrary 643getLocalClass 643getLocale 643getLocaleCurrencyInfo 643getLocaleDateInfo 644getLocaleFullInfo 644getLocaleInSubschemas 645getLocaleLocal 645getLocaleNameInfo 645getLocaleNumericInfo 645getLocaleTimeInfo 646getLocalFormats 646getLocalLocaleInSubschemas 646getLocalPrimitive 647getName 647getOidForObject 647getPrimitive 647


Contents xxvii


getRelationalView 647getRpsMapping 647getSchema 647getSubschema 648getSubschemas 648getUserAppliedPatches 648getUserFormat 649getWebServiceConsumerNames 649globalException 649importWSDL 649isLocalLocale 650loadHTMLDocuments 650makeLocaleNameFromId 651nonGUIGlobalExceptionHandler 651regenerateRelationalView 651removeWebConsumer 652reorgInProgress 652reorgIsWaitingForTransition 652resetUserAppliedPatches 652setHtmlDocumentSource 653withAllSubschemas 653withAllSuperschemas 653

SchemaEntity Class 654SchemaEntity Class Constants 654SchemaEntity Properties 654

abstract 654access 655name 655number 655subAccess 655text 656

SchemaEntity Methods 656getName 656getPatchNumber 656

SchemaEntityNumberDict Class 657Script Class 658

Script Properties 658compiledOK 658errorCode 658errorLength 659errorPosition 659status 659warningCount 659

Script Methods 660getSource 660inError 660notCompiled 660

Set Class 661Set Methods 661

add 661copy 662createIterator 662getStatistics 663includes 664indexNear 664indexNear64 665remove 665

SetMergeIterator Class 665SetMergeIterator Property 666

ignoreDuplicates 666SetMergeIterator Methods 666


Contents xxviii


addCollection 667back 667current 667getCollectionAt 668getCollectionCount 668getCurrentCollection 668isValid 668next 668removeCollection 669reset 669startAtObject 669

SortActor Class 670SortActor Class Constants 671SortActor Properties 671

ascending 671fieldNo 672length 672numeric 672random 673sortType 673startPosition 674

SortActorArray Class 675SortActorArray Properties 675

kway 675lcid 675maxMem 675

Sound Class 676Sound Properties 676

data 676format 676name 677

Sound Methods 677isPlayable 677loadFromFile 677play 677

StringArray Class 679StringUtf8Array Class 680System Class 681

System Properties 681name 681nodes 681

System Methods 681activateDeltaDatabase 684beginIndividualRequestsLogging 685beginLockContentionStats 686beginObjectTracking 686beginSample 687beginSampleGroupDefinition 687clearLockContentionStats 688createSystemSequenceNumber 688disableRemoteSampling 689dumpCharacterEntityTable 690enableRemoteSampling 690endIndividualRequestsLogging 690endLockContentionStats 691endObjectTracking 691endSample 691endSampleGroupDefinition 692findCharacterEntityByName 692findCharacterEntityByNumber 692forceOffUser 693


Contents xxix


getAllUsers 693getClassAccessFrequencies 693getDatabaseRole 695getDatabaseStats 695getDatabaseSubrole 696getDbDiskCacheStats 697getDeltaDatabaseStatus 698getEnvironmentServerIdentity 698getLockContentionInfo 698getLockContentionStats 699getLocks 699getMostAccessedClasses 700getNotes 701getObjectLockProcesses 702getObjectPartitionID 703getQueuedLocks 703getRequestStats 704getRpcServerStatistics 705getStatistics 706getStatistics64 708getSystemSequenceNumberNext 709getTimeInTransactionState 710interruptUser 710isDatabaseEncryptionEnabled 711isDbArchival 711isRemoteSamplingEnabled 711isValidProcess 711logObjectCaches 712logRequestStatistics 713logUserCommand 713processDumpAllNodes 714queryLockContentionStats 714removeNode 714sdsAuditEnableSecondaryApps 715verifyDbEncryptionMasterKey 715

SystemException Class 716TcpIpConnection Class 717

TcpIpConnection Class Constants 717TcpIpConnection Properties 717

authenticationLibrary 718cryptLibrary 719decryptMethod 719encryptMethod 719genAuthChallengeMethod 720genAuthResponseMethod 720localInterface 721localIpAddress 721localPort 721networkProxy 721port 722protocolFamily 722remoteIpAddress 722remoteName 723remotePort 723resolveRemoteName 723usePresentationClient 723sslContext 723userObject 724verifyAuthResponseMethod 724

TcpIpConnection Methods 725close 725


Contents xxx


closeAsynch 726getMaxMessageSize 726listen 727listenAsynch 727listenContinuous 728listenContinuousAsynch 729open 730openAsynch 731readBinary 732readBinaryAsynch 732readUntil 733readUntilAsynch 734writeBinary 734writeBinaryAsynch 735

TimeArray Class 736TimeFormat Class 737

TimeFormat Properties 737amText 737ampmIsSuffix 737format 738is12HourFormat 738pmText 738separator 738showLeadingZeros 738showSeconds 738

TimeFormat Method 738defineTimeFormat 739

TimeStampArray Class 740TimeStampIntervalArray Class 741TranslatableString Class 742

TranslatableString Properties 742formBuildDataRefs 743locale 743

TranslatableString Method 743updateCompile 744

Type Class 745Type Properties 745

consts 745methods 745schema 745superschemaType 745

Type Methods 746allMethods 746findConstant 746findConstantInSuperschema 746findProperty 746getConstant 747getConstants 747getConstantsInSchema 747getMethod 747getMethods 747getName 748getProperty 748inheritsFrom 748instancesExist 748

UserInterfaceException Class 749WebSession Class 750

WebSession Class Constant 750WebSession Properties 750

lastAccessTime 750sessionId 751


Contents xxxi


startTime 751usePageSequencing 751

WebSession Methods 751browserType 752createVirtualDirectoryFile 752deleteVirtualDirectoryFile 753getCurrentLocale 753getHttpParam 754getHttpString 754getServerVariable 754getSessionForm 756getWebSessionCount 756isVDFilePresent 756processRequest 756removeSession 757removeSessionWithMessage 757reply 758setCurrentLocale 758timerEvent 759

WebSocketException Class 760


Contents xxxii


Before You Begin

The JADE Encyclopaedia of Classes is intended as a major source of information when you are developing ormaintaining JADE applications.

Who Should Read this EncyclopaediaThe main audience for the JADE Encyclopaedia of Classes is expected to be developers of JADE applicationsoftware products.

What’s Included in this EncyclopaediaThe JADE Encyclopaedia of Classes has two chapters, and is divided into three volumes.

Chapter 1 Gives a reference to system classes and the constants, properties, and methods that they provide

Chapter 2 Gives a reference to Window classes and the constants, properties, methods, and events that theyprovide

Note that this second volume contains system (non-GUI) classes in the range JadeSkinApplication class throughWebSession class, inclusive. Volume 1 (that is, EncycloSys1.pdf) contains system (non-GUI) classes in therange ActiveXAutomation class through JadeSkin class, inclusive. Chapter 2 (Window class and subclasses) iscontained in Volume 3 (that is, EncycloWin.pdf).

Related DocumentationOther documents that are referred to in this encyclopaedia, or that may be helpful, are listed in the following table,with an indication of the JADE operation or tasks to which they relate.

Title Related to…

JADE Database Administration Guide Administering JADE databases

JADE Development EnvironmentAdministration Guide

Administering JADE development environments

JADE Development Environment User’sGuide

Using the JADE development environment

JADE Encyclopaedia of Primitive Types Primitive types and global constants

JADE Installation and Configuration Guide Installing and configuring JADE

JADE Initialization File Reference Maintaining JADE initialization file parameter values

JADE Object Manager Guide JADE Object Manager administration

JADE Report Writer User’s Guide Using the JADE Report Writer to develop and run reports

JADE Synchronized Database Service (SDS)Administration Guide

Administering JADE Synchronized Database Services (SDS),including Relational Population Services (RPS)

JADE Thin Client Guide Administering JADE thin client environments


ConventionsThe JADE Encyclopaedia of Classes uses consistent typographic conventions throughout.

Convention Description

Arrow bullet ( ) Step-by-step procedures. You can complete procedural instructions by using eitherthe mouse or the keyboard.

Bold Items that must be typed exactly as shown. For example, if instructed to type foreach,type all the bold characters exactly as they are printed.

File, class, primitive type, method, and property names, menu commands, and dialogcontrols are also shown in bold type, as well as literal values stored, tested for, andsent by JADE instructions.

Italic Parameter values or placeholders for information that must be provided; for example,if instructed to enter class-name, type the actual name of the class instead of the wordor words shown in italic type.

Italic type also signals a new term. An explanation accompanies the italicized type.

Document titles and status and error messages are also shown in italic type.

Blue text Enables you to click anywhere on the cross-reference text (the cursor symbolchanges from an open hand to a hand with the index finger extended) to take youstraight to that topic. For example, click on the "Object Methods" cross-reference todisplay that topic.

Bracket symbols ( [ ] ) Indicate optional items.

Vertical bar ( | ) Separates alternative items.

Monospaced font Syntax, code examples, and error and status message text.

ALL CAPITALS Directory names, commands, and acronyms.

SMALL CAPITALS Keyboard keys.

Key combinations and key sequences appear as follows.

Convention Description

KEY1+KEY2 Press and hold down the first key and then press the second key. For example, "press Shift+F2"means to press and hold down the Shift key and press the F2 key. Then release both keys.

KEY1,KEY2 Press and release the first key, then press and release the second key. For example, "pressAlt+F,X" means to hold down the Alt key, press the F key, and then release both keys beforepressing and releasing the X key.


Before You Begin xxxiv


Chapter 1 System Classes

JADE provides system classes. System classes are standard classes whose instances provide properties andmethods to encapsulate the behavior of objects in your JADE applications. This chapter contains the classessummarized in the following table, and is divided into two volumes.

Note This volume (Volume 2) contains system (non-GUI) classes in the range JadeSkinApplication classthrough WebSession class, inclusive. Volume 1 (that is, EncycloSys1.pdf) contains system (non-GUI) classes inthe range ActiveXAutomation class through JadeSkin class, inclusive.

Class Description

ActiveXAutomation Provides a superclass for each subclass created when an ActiveXautomation object is imported

ActiveXInterface Provides a superclass for all interfaces of imported ActiveX automationand control objects

ActiveXInvokeException Defines behavior for exceptions that occur as a result of accessing anActiveX property or invoking an ActiveX method

Application Common superclass in the RootSchema for Application classes definedin subschemas

ApplicationContext Stores transient instances of the application, package, process, andschema for the main application in which a package is imported and foreach package application when a process begins

Array Encapsulates behavior required to access entries in an ordered collectionof like objects in which the member objects are referenced by theirposition in the collection

BinaryArray Stores and retrieves binaries in an array of Binary primitive types

BooleanArray Stores and retrieves Boolean values in an array of Boolean primitive types

Btree Encapsulates behavior required to access entries in a collection by a key(index)

ByteArray Stores and retrieves characters in an array of Byte primitive types

CharacterArray Stores and retrieves characters in an array of Character primitive types

Class Metaclass of all other JADE classes; that is, contains the definition of allJADE classes

CMDialog Encapsulates behavior for the common dialog subclasses

CMDColor Enables access to the common Color dialog

CMDFileOpen Enables access to the common File Open dialog

CMDFileSave Enables access to the common File Save dialog

CMDFont Enables access to the common Font dialog

CMDPrint Enables access to the common Print dialogs

Collection Defines the common protocol for all collection subclasses

Connection Provides a generalized interface for communicating with external systems


Chapter 1 36


Class Description

ConnectionException Defines behavior for exceptions that occur as a result of communicatingwith external systems

ConstantNDict Stores references to instances of the Constant class (or instances ofsubclasses)

CurrencyFormat Stores Windows locale currency information

Database Encapsulates the definition of a database for a schema, including thedatabase files and the class mappings to those files

DateArray Stores and retrieves dates in an array of Date primitive types

DateFormat Stores Windows locale date information

DbFile Encapsulates the definition of a database file and provides methods toperform file-level operations

DbFileArray Stores and retrieves objects from an array of database files

DeadlockException Defines behavior for exceptions that occur as a result of deadlocks

DecimalArray Stores and retrieves decimals in an array of Decimal primitive types

Dictionary Encapsulates behavior for storing and retrieving objects in a collection bya user-defined key

DynaDictionary Encapsulates the behavior required to access entries in member keydictionary subclasses (that is, in dictionaries in which the keys areproperties in the member objects)

Exception Defines the protocol for raising and responding to exception conditions

ExceptionHandlerDesc Describes an exception handler that is currently armed

ExternalArray Represents rows in a result set generated from an SQL query containing asort specification

ExternalCollection Provides the common protocol for external collection classes

ExternalDatabase Represents a connection to an external database

ExternalDictionary Represents the rows in a result set generated from an SQL query with anORDER BY sort specification

ExternalIterator Encapsulates behavior required to sequentially access elements of acollection

ExternalObject Base class for all external database classes

ExternalSet Represents rows in a result set generated from an SQL query that has nosort specification

ExtKeyDictionary Encapsulates the behavior required to access entries in external keydictionary subclasses

FatalError Encapsulates behavior required for serious internal faults

File Enables you to read and write disk files, either sequentially or with randomaccess

FileException Defines behavior for exceptions that occur as a result of file handling


Chapter 1 37


Class Description

FileFolder Contains a collection of files or subdirectories

FileNode Contains the properties and methods common to the File class andFileFolder class

FileNodeArray Stores and retrieves objects from an array of file nodes

Global Provides a means by which application-specific data can be sharedamong users of an application

GUIClass Metaclass containing the definition of all Graphical User Interface (GUI)classes

HugeStringArray Stores and retrieves large strings in an array of String primitive types

IDispatch Provides a superclass for all ActiveX automation and control classescreated in JADE during the ActiveX type library import process

IDispatchArray Stores and retrieves objects from an array of IDispatch objects

Integer64Array Stores and retrieves integers in an array of Integer64 primitive types

IntegerArray Stores and retrieves integers in an array of Integer primitive types

IntegrityViolation Defines the behavior of exceptions raised as a result of integrity ruleviolations

InternetPipe Provides an interface for communicating with JADE applications from theInternet through an Internet server

Iterator Encapsulates behavior required to sequentially access elements of acollection

IUnknown Encapsulates behavior implemented by all COM objects and inherited byall ActiveX interfaces

JadeAuditAccess Provides access to information recorded in database transaction journalsin a form convenient for consumption by JADE applications

JadeBytes Stores and retrieves instances of unstructured data of arbitrary size

JadeDatabaseAdmin Provides an Application Programming Interface (API) to perform databaseoperations

JadeDbFilePartition Provides an administrative API for manipulating and querying the state ofdatabase partitions

JadeDotNetInvokeException Defines behavior for exceptions that occur as a result of accessing a .NETproperty or invoking a .NET method

JadeDotNetType Provides a superclass for all imported .NET non-GUI types

JadeDynamicObject Encapsulates the behavior required to access entries in dynamic objects(that is, in objects that represent collection statistics)

JadeDynamicObjectArray Stores and retrieves objects from an array of JadeDynamicObject objects

JadeDynamicPropertyCluster Stores one or more dynamic properties used to extend a class

JadeGenericMessage Encapsulates the building and analysis of messages

JadeGenericMessagingIF Provides message arrival and queue management callback methods


Chapter 1 38


Class Description

JadeGenericQueue Encapsulates a destination for the transmission and retrieval of messages

JadeGenericQueueManager Encapsulates the management of a single messaging queue

JadeHTMLClass Implements the interface that enables you to support HTML pages in yourJADE applications

JadeHTTPConnection Enables applications to access the standard Internet protocol HTTP

JadeIdentifierArray Stores and retrieves strings with a maximum length of 100 characters,which is the maximum length of a JADE identifier

JadeInternetTCPIPConnection Implements the interface defined by the TcpIpConnection classspecifically for the Internet Transmission Control Protocol / InternetProtocol (TCP/IP) API

JadeJson Standalone JSON functionality that is independent of theRepresentational State Transfer (REST) Application ProgrammingInterface (API)

JadeLicenceInfo Encapsulates behavior required to get license information

JadeLog Encapsulates behavior required to create text log files in JADEapplications

JadeMessagingException Defines the behavior of exceptions that arise when using the messagingframework

JadeMessagingFactory Encapsulates the behavior for creating and opening messaging queues

JadeMetadataAnalyzer Encapsulates behavior required to analyze JADE metadata

JadeMethodContext Provides an interface for invoking asynchronous method calls

JadeMultiWorkerTcpConnection Provides an interface for sharing the messages arriving on client socketsamong a pool of worker server JADE applications

JadeMultiWorkerTcpTransport Encapsulates behavior required for multiple user TCP/IP connectionsbetween JADE systems

JadeMultiWorkerTcpTransportIF Provides TCP/IP multiple worker connection event callback methods

JadePatchControlInterface Encapsulates behavior required to dynamically access patch versioninginformation

JadePrintData Encapsulates the behavior required for report output data subclasses (thatis, for direct print or preview)

JadePrintDirect Provides output report output to be sent directly to the printer

JadePrintPage Encapsulates behavior required to hold a page of printed output forpreview

JadeProfiler Encapsulates behavior required to configure what is profiled and reportedin the JADE Interpreter

JadeRelationalAttributeIF Provides an interface to expose soft attributes

JadeRelationalEntityIF Provides an interface to expose soft entities, which are mapped to a tablein the relational view


Chapter 1 39


Class Description

JadeRelationalQueryProviderIF Provides a search implementation that optimally finds and filters instancesof a soft entity

JadeReport Encapsulates behavior required to access an entire printed report

JadeReportWriterManager Provides a superclass for each JADE Report Writer Configuration orDesigner application

JadeReportWriterReport Provides methods that enable you to dynamically override JADE ReportWriter details at run time

JadeReportWriterSecurity Provides a superclass for all user JadeReportWriterSecurity subclasses

JadeRestService Defines the behavior of REST-style Web service applications

JadeRpsDataPumpIF Provides an interface for managing output sent to a relational databasefrom an RPS Datapump application

JadeSerialPort Provides methods for communicating with external systems through aserial port

JadeSkin Stores JADE skins and encapsulates behavior required to maintain JADEskins

JadeSkinApplication Stores JADE skins for forms and controls in applications

JadeSkinArea Encapsulates behavior required to define and maintain rectangular skinareas

JadeSkinCategory Stores skin category definitions

JadeSkinControl Encapsulates behavior required to define and maintain skins for controls

JadeSkinEntity Encapsulates behavior required to define and maintain skin entities

JadeSkinForm Encapsulates behavior required to define and maintain skins for forms

JadeSkinMenu Encapsulates behavior required to define and maintain skins for menus

JadeSkinRoot Stores dictionaries that reference skin entities

JadeSkinSimpleButton Stores skin definitions for simple buttons in all four states (that is, up,down, disabled, and rollover)

JadeSkinWindow Stores the defined image and category of all skins

JadeSkinWindowStateImage Stores images of window areas for specific states (that is, up, down,disabled, and rollover)

JadeSOAPException Defines the behavior of exceptions that occur as a result of Web services

JadeSSLContext Implements the Secure Sockets Layer (SSL) protocol that supports digitalcertificates over secure connections

JadeTableCell Internally created proxy class providing direct access to table cells

JadeTableColumn Internally created proxy class providing direct access to table columns

JadeTableElement Internally created proxy class encapsulating behavior required to directlyaccess table elements

JadeTableRow Internally created proxy class providing direct access to table rows

JadeTableSheet Internally created proxy class providing direct access to table sheets


Chapter 1 40


Class Description

JadeTcpIpProxy Implements TCP/IP network proxy support that enables you to open aTCP/IP network connection through a proxy host

JadeTestCase Provides unit testing functionality for user-written test subclasses

JadeTestListenerIF Provides callback methods on the progress and results of unit testing

JadeTestRunner Enables you to run unit test methods in subclasses of the JadeTestCaseclass

JadeTransactionTrace Enables you to identify objects that are updated, created, and deletedwithin a transaction

JadeUserCollClass Enables you to create a user collection class at run time

JadeWebService Maintains all Web service information

JadeWebServiceConsumer Defines the behavior of Web service consumers loaded into yourapplication

JadeWebServiceProvider Defines the behavior of Web service provider applications

JadeWebServiceSoapHeader Defines the behavior of SOAP headers in Web service providerapplications

JadeWebServiceUnknownHeader Represents an unknown SOAP header in a Web service providerapplication

JadeWebSocket Base class for handling a WebSocket connection

JadeWebSocketServer Handles all incoming TCP/IP connections from theJadeWebsocketIISNativeModule on a specific interface and TCP port

JadeX509Certificate Stores digital certificates in X509 format for use with the JadeSSLContextclass that provides secure connections

JadeXMLAttribute Represents an attribute of an XML element in an XML document tree

JadeXMLCDATA Represents a CDATA section in an XML document tree

JadeXMLCharacterData Abstract superclass of character-based nodes in an XML document tree

JadeXMLComment Represents a comment in an XML document tree

JadeXMLDocument Represents an XML document as a tree of nodes

JadeXMLDocumentParser Represents the interface for parsing XML documents into a tree of objects

JadeXMLDocumentType Represents the document type declaration in an XML document tree

JadeXMLElement Represents an XML element in an XML document tree

JadeXMLException Defines behavior for exceptions that occur as a result of XML processing

JadeXMLNode Abstract superclass of all nodes in an XML document tree

JadeXMLParser Abstract transient-only class that provides the interface for parsing XMLdocuments

JadeXMLProcessingInstruction Represents a processing instruction in an XML document tree

JadeXMLText Represents the textual content within an XML document tree


Chapter 1 41


Class Description

List Encapsulates behavior required to reference objects by their position inthe collection

Locale Defines the locales (languages) supported by a schema

LocaleFormat Defines the common protocol for locale format information

LocaleFullInfo Provides Windows locale information for the current workstation

LocaleNameInfo Provides Windows locale name information for the current workstation

Lock Describes the lock requests maintained by the system

LockArray Stores and retrieves objects in an array of locks

LockContentionInfo Stores information about lock contentions for a target persistent object

LockException Defines the behavior of exceptions raised as a result of locking conflicts

MemberKeyDictionary Encapsulates the behavior required to access entries in member keydictionary subclasses

MenuItem Contains the definition of each menu command (item) on a menu

MergeIterator Encapsulates behavior required to sequentially access elements of two ormore compatible dictionaries

MethodCallDesc Provides information at run time about currently active method calls

MultiMediaType Provides the behavior for all types of multimedia subclasses

NamedPipe Provides a generalized interface for communicating with external systems

Node Class for which an instance exists for each node in a system

NormalException Superclass of all non-fatal exceptions

Notification Superclass for objects that describe the notifications maintained by thesystem

NotificationArray Stores and retrieves objects from an array of notifications

NotificationException Defines behavior for exceptions that occur as a result of notifications

NumberFormat Stores Windows locale numeric information

Object Defines default behavior for all other classes in the schema

ObjectArray Stores and retrieves objects in an array

ObjectByObjectDict Encapsulates the behavior required to map one object to another object

ObjectLongNameDict Encapsulates the behavior for accessing the long names of objects

ObjMethodCallDesc Provides information at run time about currently active method calls madeto object methods (that is, methods defined on classes as opposed toprimitive types)

ObjectSet Stores and retrieves objects in a set

ODBCException Defines behavior for exceptions that occur as a result of ODBCcommunications

OleObject Stores the Object Linking and Editing (OLE) object images for theOleControl class


Chapter 1 42


Class Description

PointArray Stores and retrieves points in an array of Point primitive types

PrimMethodCallDesc Provides information at run time about currently active methods callsmade to primitive methods

Printer Handles printing

Process Class for which an instance exists for each process in the system

ProcessDict Encapsulates the behavior required to access process objects in adictionary

ProcessStackArray Encapsulates the behavior required to access method calls in the processstack array

RealArray Stores and retrieves Real values in an array of Real primitive types

Rectangle Encapsulates the dimensions of a rectangle

RelationalView Enables views to be defined for use by the RPS Datapump applicationand to allow relational tools to access JADE

RootSchemaSession Defines the common protocol for all Web session classes in subschemas

Schema Represents the object model for a specific application domain

SchemaEntity Superclass of a number of classes that participate in the definition of aschema

SchemaEntityNumberDict Stores references to instances of subclasses of the SchemaEntity class

Script Encapsulates the behavior of schema entities that have source code

Set Encapsulates the behavior of collection set classes

SetMergeIterator Encapsulates behavior required to sequentially access elements of two ormore sets

SortActor Contains properties that enable you to specify the precedence of recordsin the File class

SortActorArray Container for SortActor objects

Sound Contains the properties and methods for the sound multimedia type

StringArray Stores and retrieves strings in an array of String primitive types

StringUtf8Array Stores and retrieves strings in an array of StringUtf8 primitive types

System One instance of this class exists, representing an entire JADE system (thatis, the installed JADE environment)

SystemException Superclass of all exceptions relating to errors detected by the JADE kernel

TcpIpConnection Implements the interface defined by the Connection class specifically forthe TCP/IP API

TimeArray Stores and retrieves times in an array of Time primitive types

TimeFormat Stores Windows locale time information

TimeStampArray Stores and retrieves timestamps in an array of TimeStamp primitive types


Chapter 1 43


Class Description

TimeStampIntervalArray Stores and retrieves timestamp intervals in an array of TimeStampIntervalprimitive types

TranslatableString Stores locale-dependent text to be displayed when a client is running anapplication

Type Superclass of all class, primitive type, and interface meta classes

UserInterfaceException Defines behavior for exceptions relating to the handling of windows

WebSession Maintains Internet session information

WebSocketException Defines behavior for WebSocket protocol exceptions

For details about user-interface (GUI) classes and their associated constants, properties, methods, and events,see Chapter 2, "Window Classes", in Volume 3.


JadeSkinApplication Class Chapter 1 44


JadeSkinApplication ClassThe JadeSkinApplication class stores JADE skins for forms and controls in applications.

An application skin definition consists of a collection of form and control skins. You can define a skin with no formskins (that is, with control skins only) and the reverse.

For details about the properties defined in the JadeSkinApplication class, see "JadeSkinApplication Properties"and "JadeSkinApplication Method", in the following subsections. For details about defining and maintaining skins,see "Defining and Maintaining JADE Skins at Run Time", in Chapter 2 of the JADE Runtime Application Guide.

Inherits From: JadeSkinEntity

Inherited By: (None)

JadeSkinApplication PropertiesThe properties defined in the JadeSkinApplication class are summarized in the following table.

Property Collection of…

myFormSkins Form skins to be applied to the application

myControlSkins Control skins to be applied to the an application

myFormSkinsType: JadeSkinFormNameDict

Availability: Read or write at any time

The myFormSkins property of the JadeSkinApplication class contains a reference to a collection of form skins tobe applied to an application.

This collection can contain multiple form skins where each form skin references a different skin category.

Each form skin is applied only to forms that have the same defined skin category (for details, see the Windowclass skinCategoryName property).

myControlSkinsType: JadeSkinControlNameDict


The myControlSkins property of the JadeSkinApplication class contains a reference to a collection of the controlskins to be applied to an application.

Each control class that can be skinned has an equivalent associated skin class. The myControlSkins collectioncan include multiple skins for each control type when they reference a different skin category.

A control skin is applied only to controls of the same type with the same defined skin category (for details, see theWindow class skinCategoryName property).


JadeSkinApplication Class Chapter 1 45


JadeSkinApplication MethodThe method defined in the JadeSkinApplication class is summarized in the following table.

Method Description

updateSkinTimeStamp Resets the instance timestamp and causes the skin build data to be rebuilt.

updateSkinTimeStampSignature updateSkinTimeStamp() updating;

The updateSkinTimeStamp method defined in the JadeSkinApplication class resets the instance timestamp andcauses the skin build data to be rebuilt.

You would typically call this method if you updated a skin by any other means than using theJadeSkinMaintenance form or by loading a form and data definition (.ddb or .ddx) file.


JadeSkinArea Class Chapter 1 46


JadeSkinArea ClassThe JadeSkinArea class is the abstract class that defines the way in which a rectangular area is drawn.

Note Before you can define a skin area, a picture file (for example, a .gif, .png, .bmp, or .jpg file) must exist foreach of the images that you want to specify.

The following image illustrates the layout of a skin, which is made up of eight border segments and an innersegment.

A JadeSkinArea is drawn as follows.

Segment 1

The top-left image (imgBorderTopLeft) is drawn at actual size. The top-left of the image is positioned at the top-left of the control.

The height drawn is usually the minimum of the top-left image height and the top-center strip height.

The exception is if the top-left image height is greater than the top-center strip height and the top-left image widthis less than the left-center strip width. In that case, the top-left image height is used.

The top-left image can be higher than the top-center strip if the left-center strip is at least the same width.

Segment 2

The top-right image (imgBorderTopRight) is drawn at actual size. The top-right of the image is positioned at thetop-right of the control.

The height drawn is usually the minimum of the top-right image height and the top-center strip height.

The exception is if the top-right image height is greater than the top-center strip height and the top-right imagewidth is less than the right-center strip width. In that case, the top-right image height is used.

The top-right image can be higher than the top-center strip if the right-center strip is at least the same width.

Segment 3

The top center strip (imgBorderTopStrip) is drawn at actual image height and stretched horizontally between thetop-left and top-right images.

Segment 4

The bottom-left image (imgBorderBottomLeft) is drawn at actual size. The bottom-left of the image is positionedat the bottom-left of the control.

The height drawn is usually the minimum of the bottom-left image height and the bottom-center strip height.

The exception is if the bottom-left image height is greater than the bottom-center strip height and the bottom-leftimage width is less than the left-center strip width. In that case, the bottom-left image height is used.




This allows the bottom-left image to be higher than the bottom-center strip if the left-center strip is at least the samewidth.

Segment 5

The bottom-right image (imgBorderBottomRight) is drawn at actual size. The bottom-right of the image ispositioned at the bottom-right of the control.

The height drawn is usually the minimum of the bottom-right image height and the bottom-center strip height.

The exception is if the bottom-right image height is greater than the bottom-center strip height and the bottom-rightimage width is less than the right-center strip width. In that case, the bottom-right image height is used.

This allows the bottom-right image to be higher that bottom-center strip if the right-center strip is at least the samewidth.

Segment 6

The bottom center strip (imgBorderBottomStrip) is drawn at actual image height and stretched horizontallybetween the bottom-left and bottom-right images.

Segment 7

The left-center strip (imgBorderLeftStrip) is drawn at actual image width and stretched vertically between the top-left and the bottom-left images.

Segment 8

The right-center strip (imgBorderRightStrip) is drawn at actual image width and stretched vertically between thetop-right and the bottom-right images

Segment 9

The center image (imgInner) is drawn stretched from the left-center image to the right-center image and from thetop-center image to the bottom-center image. If there is no center image, it is filled with the background colorspecified for the skin.

Notes Segments 3 and 6 determine the respective top and bottom heights of the border. Segments 7 and 8determine the respective left and right widths of the border.

Unexpected results may occur if an image has a size that is inappropriate or does not correspond to a specificarea.

A corner segment is drawn to its full height if the width is the same as the corresponding left or right strip. Forexample, segment 1 can be higher that segment 3, provided that segment 1 is the same width as segment 7. Youcan use this to achieve rounded border effects. For details, see "JadeSkinWindow Class", later in this chapter.

The following characteristics of the JadeSkinArea class are affected by additional subclass property values.

If optional border images (that is, areas 1 through 8 in the above image) are not present, the inner area of theskin is the entire area.

You can define the optional inner image by setting the value of the imgInner property to a brush that isrepeatedly drawn over the entire inner area or an image that is drawn centered in the inner area.

A backColor property value is used only if the inner image (that is, the imgInner property) is not defined or itis not a brush.




For details about the JadeSkinArea class constants and the properties defined in the JadeSkinArea class, see"JadeSkinArea Class Constants" and "JadeSkinArea Properties", in the following subsections. For details aboutdefining and maintaining skins, see "Defining and Maintaining JADE Skins at Run Time", in Chapter 2 of the JADERuntime Application Guide.


Inherited By: JadeSkinMenu, JadeSkinWindow, JadeSkinWindowStateImage

JadeSkinArea Class ConstantsThe constants provided by the JadeSkinArea class are listed in the following table.

Constant Integer Value Constant Integer Value

BorderStyle_3DRaised 3 BorderStyle_3DSunken 2

BorderStyle_Images 4 BorderStyle_None 0

BorderStyle_Single 1

JadeSkinArea PropertiesThe properties defined in the JadeSkinArea class are summarized in the following table.

Property Description

backColor Background color of the area if the inner image is not supplied or it is not a brush

imgBorderBottomLeft Optional bottom left of the area

imgBorderBottomRight Optional bottom right of the area

imgBorderBottomStrip Optional bottom strip of the area

imgBorderLeftStrip Optional left strip of the area

imgBorderRightStrip Optional right strip of the area

imgBorderTopLeft Optional top left of the area

imgBorderTopRight Optional top right of the area

imgBorderTopStrip Optional top strip of the area

imgInner Optional inner image for the area

innerIsBrush Specifies whether the optional inner image is a brush for the entire area or acentered image (set to true by default)

backColorType: Integer


The backColor property of the JadeSkinArea class contains the global background color of the area if the innerimage is not defined or it is not a brush. The default value of Default_Color for this property means that thedefined value of the Window class backColor property is used, subject to the following rules.




The rules for the backColor of a form are:

If the form has a JadeSkinForm skin set, the JadeSkinForm.backColor value is not Default_Color, and thebackColor of the form is 3D Face, the backColor value of the skin is used.

If the above does not apply, the backColor value of the form is used.

The rules for the backColor of a control are:

If the control is transparent, the background area of the control is not erased and backColor is ignored.

If the backColor of the control is set to Default_Color, the effective backColor of the first parent whosebackColor is not Default_Color is used, regardless of whether a skin is applied.

If the control has its default backColor value set or if the skin was individually set on the control, as shown inthe following example.

label1.setSkin(myJadeSkinLabel);

If the control has a skin and the backColor of the skin is not Default_Color, the backColor of the skin isused.

If the default backColor of the control is 3D Face, the control is not a button or browse button, and the formhas a JadeSkinForm skin set, the JadeSkinForm.backColor value is used unless its value is Default_Color.

If either of the above does not apply, the backColor value of the control is used.

For more details about the backColor property, see the Window class backColor property.

imgBorderBottomLeftType: Binary


The imgBorderBottomLeft property of the JadeSkinArea class contains the optional image for the bottom leftarea of the skin. This image is drawn unstretched.

imgBorderBottomRightType: Binary


The imgBorderBottomRight property of the JadeSkinArea class contains the optional image for the bottom rightarea of the skin. This image is drawn unstretched.

imgBorderBottomStripType: Binary


The imgBorderBottomStrip property of the JadeSkinArea class contains the optional image for the bottom stripof the skin. This image is drawn stretched.




imgBorderLeftStripType: Binary


The imgBorderLeftStrip property of the JadeSkinArea class contains the optional image for the left strip of theskin. This image is drawn stretched.

imgBorderRightStripType: Binary


The imgBorderRightStrip property of the JadeSkinArea class contains the optional image for the right strip of theskin. This image is drawn stretched.

imgBorderTopLeftType: Binary


The imgBorderTopLeft property of the JadeSkinArea class contains the optional image for the top left area of theskin. This image is drawn unstretched.

imgBorderTopRightType: Binary


The imgBorderTopRight property of the JadeSkinArea class contains the optional image for the top right area ofthe skin. This image is drawn unstretched.

imgBorderTopStripType: Binary


The imgBorderTopStrip property of the JadeSkinArea class contains the optional image for the top strip of theskin. This image is drawn stretched.

imgInnerType: Binary


The imgInner property of the JadeSkinArea class contains the optional image for the inner area of the skin.

You can define a brush that is repeatedly drawn over the entire inner area or an image that is drawn centered inthe inner area.




If you do not define an image for this property or it is not a brush, the backColor property value is used for theinner area of the skin.

innerIsBrushType: Boolean


The innerIsBrush property of the JadeSkinArea class specifies whether the optional inner image (defined in theimgInner property) is a brush for the entire area or a centered image.

This property is set to true by default.


JadeSkinCategory Class Chapter 1 52


JadeSkinCategory ClassThe JadeSkinCategory class holds the skin category definitions for applications, forms, and controls.

For details about defining and maintaining skins, see "Defining and Maintaining JADE Skins at Run Time", inChapter 2 of the JADE Runtime Application Guide.


Inherited By: (None)


JadeSkinControl Class and Subclasses Chapter 1 53


JadeSkinControl Class and SubclassesThe JadeSkinControl class is the abstract superclass that provides the definition of elements common for eachcontrol that can be skinned.

Use the properties of the JadeSkinArea class to define the image drawn for the active border and the inner (clientarea) of each control. When erasing the inner area of a control:

1. If the control backBrush property of the form is not null, the inner area is erased using that brush.

2. If the control skin has a JadeSkinArea class imgInner property value that is a brush, the inner area is erasedusing that brush.

3. If the backColor property of the skin area is not Default_Color and the backColor property of the control isthe default value or the skin was set by using the Control class setSkin method, erase using the backColorproperty value of the skin.

4. If the value of the backColor property of the control is Color_3DFace and the form of the control has a skinwhose backColor property is not set to Default_Color, the inner area is erased using the backColorproperty value of the form’s skin.

5. Erase using the backColor property value of the control.

6. If the control was erased using a color and the skin of the control has an inner image defined in theJadeSkinArea class imgInner property that is not a brush (that is, the JadeSkinArea class innerIsBrushproperty is set to false), that image is drawn centered in the inner area.

Skins do not apply to the ActiveXControl, MultiMedia, and Ocx control classes, as these are totally drawn by thecontrols themselves.

Note If an application is active with a skin set, a second application initiated from the same jade.exe executableis now drawn using the current Windows theme if that application does not have a skin set.

For details about the class constants and properties defined in the JadeSkinControl class, see "JadeSkinControlClass Constants", and "JadeSkinControl Properties", in the following subsections. For details about defining andmaintaining skins, see "Defining and Maintaining JADE Skins at Run Time", in Chapter 2 of the JADE RuntimeApplication Guide.

Inherits From: JadeSkinWindow

Inherited By: JadeSkinBaseControl, JadeSkinBrowseButtons, JadeSkinButton, JadeSkinCheckBox,JadeSkinComboBox, JadeSkinFolder, JadeSkinFrame, JadeSkinGroupBox,JadeSkinJadeDockBase, JadeSkinJadeEditMask, JadeSkinJadeMask, JadeSkinJadeRichText,JadeSkinLabel, JadeSkinListBox, JadeSkinOleControl, JadeSkinOptionButton, JadeSkinPicture,JadeSkinProgressBar, JadeSkinScrollBar, JadeSkinSheet, JadeSkinStatusLine, JadeSkinTable,JadeSkinTextBox

JadeSkinControl Class ConstantsThe constants provided by the JadeSkinControl class are listed in the following table.

Constant Integer Value Constant Integer Value

ApplyCondition_3D 2 ApplyCondition_All 0

ApplyCondition_Border 1




JadeSkinControl PropertiesThe properties defined in the JadeSkinControl class and inherited by all subclasses are summarized in thefollowing table.

Property Description

applyCondition Determines whether the border area of a control uses a skin

borderStyle Contains the type of border to be drawn

focusBackColor Contains the color to be used for the background of the control when the control hasfocus

focusForeColor Contains the color to be used for drawing the text of the control when the control hasfocus

fontBold Specifies whether the control font is bold when the control uses the default applicationfont

fontItalic Specifies whether the control font is italicized when the control uses the defaultapplication font

fontName Font with which the control is drawn (the default null value indicates the control uses itsown default font)

fontSize Specifies the size of the control font when the control uses the default application font

fontStrikethru Specifies whether the control font is strikethrough when the control uses the defaultapplication font

fontUnderline Specifies whether the control font is underlined when the control uses the defaultapplication font

foreColor Contains the color to be used for drawing the text of the control

foreColorDisabled Contains the color to be used for drawing the text of the control when it is disabled

applyConditionType: Integer


The applyCondition property of the JadeSkinControl class determines whether the border area of the controluses a skin.

The applyCondition property values are listed in the following table.

Class Constant Integer Value Description

ApplyCondition_3D 2 The skin is applied to the control but the border area of the skinis displayed only if the borderStyle property for the control is setto BorderStyle_3DSunken (2) or BorderStyle_3DRaised (3). Ifthe borderStyle property of the control is set to BorderStyle_None (0), the skin is displayed without showing a border. If theborderStyle property of the control is set to BorderStyle_Single(1), the single border is displayed and the rest of the control isdisplayed with a skin.




Class Constant Integer Value Description

ApplyCondition_All 0 The skin is applied to the control, including the border areadefinition of the skin.

ApplyCondition_Border 1 The skin is applied to the control but the border area of the skinis displayed only if the borderStyle property of the control is setto a value other than BorderStyle_None (0).

The default value is ApplyCondition_Border (1) for BaseControl, Frame, JadeDockBar, JadeDockContainer,Label, ListBox, OleControl, Picture, StatusLine, Table, and TextBox controls. For all other controls, the defaultvalue is ApplyCondition_All (0). For example, you can define a skin for a Label control with a border and if theapplyCondition property of the skin is not ApplyCondition_All (0), the border displays depends on the value ofthe borderStyle property of the label.

borderStyleType: Integer


The borderStyle property of the JadeSkinControl class contains the ty