Objectpal Reference Manual
Total Page：16
File Type：pdf, Size：1020Kb
ObjectPAL™ Reference Guide Copyright © 1999 COREL CORPORATION and COREL CORPORATION LIMITED. All rights reserved. For more complete copyright information please refer to the About section in the Help menu of the software. TABLE OF CONTENTS Introduction..........1 Chapter 2: What’s in the Paradox 9 ObjectPAL Reference Guide ....1 ObjectPAL Level................1 Object type reference .....39 Syntax notation ...............2 ActionEvent type ..............39 ObjectPAL prototypes ..............2 User-defined constants .............40 Required elements ...............2 actionClass method ..............40 Informational elements .............3 id method .................41 Alternate syntax ...............3 setId method ................41 Using ObjectPAL in calculated fields .........4 AddinForm type ..............42 AnyType type ...............43 Example of using conditional logic and ObjectPAL methods blank method/procedure ............44 5 dataType method ...............45 Derived methods ...............6 fromHex procedure ..............45 isAssigned method ..............46 isBlank method ...............47 Chapter 1: isFixedType method ..............47 Basic language elements ....7 toHex procedure ...............48 ; { } (comments) keyword ............7 unAssign method ...............48 = (Assignment/Comparison operator) keyword .....8 view method ................49 const keyword ................9 Application type ..............49 disableDefault keyword .............10 Array type ................50 doDefault keyword ..............10 addLast method ...............51 enableDefault keyword .............11 append method ...............52 for keyword ................11 contains method ...............53 forEach keyword ...............12 countOf method ...............54 if keyword .................13 empty method................54 iif keyword.................14 exchange method...............55 loop keyword ................14 fill method.................55 method keyword ...............15 grow method ................56 passEvent keyword ..............16 indexOf method ...............57 proc keyword ................16 insert method ................58 quitLoop keyword...............17 insertAfter method ..............58 return keyword ...............18 insertBefore method ..............59 scan keyword ................18 insertFirst method ..............59 switch keyword ...............19 isResizeable method ..............60 try keyword ................21 remove method ...............60 type keyword ................22 removeAllItems method .............61 uses keyword ................22 removeItem method ..............62 ObjectPAL uses block .............23 replaceItem method ..............63 DLL uses block ...............28 setSize method ...............63 Calling external routines ............32 size method ................64 Using C++ ................32 view method ................64 Passing by value ...............33 Binary type ................65 Passing by pointer ..............34 clipboardErase method .............65 Returning values ...............35 clipboardHasFormat procedure ..........65 Notes on Graphic and Binary data (CHANDLE) .....35 enumClipboardFormats method ..........66 var keyword ................35 readFromClipboard method ...........66 while keyword................36 readFromFile method .............67 Reserved Keywords ..............37 size method ................68 Built-in object variables ............37 writeToClipboard method ............69 writeToFile method ..............69 Currency type ...............70 currency procedure ..............71 Database type ...............73 Table of contents i beginTransaction method ............74 setDestDelimitedFields method ..........114 close method ................76 setDestDelimiter method ............114 commitTransaction method............76 setDestFieldNamesFromFirst method ........115 delete method/procedure ............77 setDestSeparator method ............116 enumFamily method/procedure ..........77 setKeyviol method ..............116 getMaxRows method ..............78 setProblems method .............117 isAssigned method ..............79 setSource method ..............117 isSQLServer method ..............79 setSourceCharSet method ............118 isTable method/procedure ............80 setSourceDelimitedFields method .........119 open method/procedure.............81 setSourceDelimiter method ...........119 rollBackTransaction method ...........82 setSourceFieldNamesFromFirst method ........120 setMaxRows method ..............82 setSourceRange method ............121 transactionActive method ............83 setSourceSeparator method ...........122 DataTransfer type ..............83 transferData method .............123 appendASCIIFix procedure ............84 Date type ................123 appendASCIIVar procedure ............85 date method ................124 dlgExport procedure..............85 dateVal procedure ..............125 dlgImport procedure..............85 today procedure...............125 dlgImportASCIIFix procedure ...........86 DateTime type ..............126 dlgImportASCIIVar procedure ...........87 dateTime method ..............127 dlgImportSpreadsheet procedure ..........87 day method ................127 dlgImportTable procedure ............88 daysInMonth method .............128 empty method................89 dow method ................128 enumSourcePageList method ...........89 dowOrd method ...............129 enumSourceRangeList method...........90 doy method ................129 exportASCIIFix procedure ............90 hour method ................130 exportASCIIVar procedure ............91 isLeapYear method ..............130 exportParadoxDOS procedure ...........92 milliSec method ...............131 exportSpreadsheet procedure ...........93 minute method ...............131 getAppend method ..............94 month method ...............132 getDestCharSet method .............94 moy method ................133 getDestDelimitedFields method ..........95 second method ...............133 getDestDelimiter method ............96 year method ................134 getDestFieldNamesFromList method .........97 DDE type ................134 getDestName method .............97 close method................135 getDestSeparator method ............98 execute method ...............136 getDestType method ..............99 open method ................136 getKeyviol method ..............100 setItem method ...............137 getProblems method .............100 DynArray type ..............138 getSourceCharSet method ............101 contains method...............139 getSourceDelimitedFields method .........102 empty method ...............140 getSourceDelimiter method ...........103 getKeys method ...............141 getSourceFieldNamesFromFirst method........104 removeItem method .............142 getSourceName method ............104 size method ................142 getSourceRange method ............105 view method ................143 getSourceSeparator method ...........106 ErrorEvent type ..............144 getSourceType method .............106 User-defined error constants ...........144 importASCIIFix procedure ............107 reason method ...............145 importASCIIVar procedure............108 setReason method ..............145 importSpreadsheet procedure ..........109 loadDestSpec method .............111 Event type ................146 loadSourceSpec method ............111 errorCode method ..............146 setAppend method ..............112 getTarget method ..............147 setDest method ...............112 isFirstTime method ..............148 setDestCharSet method.............113 isPreFilter method ..............149 isTargetSelf method..............149 ii Table of contents reason method ...............150 create method ...............193 setErrorCode method .............150 delayScreenUpdates..............193 setReason method ..............151 deliver method ...............195 FileSystem type ..............152 design method ...............195 accessRights method .............153 disableBreakMessage procedure ..........196 clearDirLock procedure ............153 disablePreviousError procedure ..........196 copy method ................154 dmAddTable method/procedure ..........197 delete method ...............154 dmAttach method/procedure ...........197 deleteDir method ..............155 dmBuildQueryString method/procedure .......198 drives method ...............156 dmEnumLinkFields method/procedure ........199 enumFileList method .............157 dmGet method/procedure............200 existDrive method ..............158 dmGetProperty method/procedure .........201 findFirst method ..............158 dmHasTable method/procedure ..........203 findNext method ..............160 dmLinkToFields method/procedure .........203 freeDiskSpace method .............161 dmLinkToIndex method/procedure .........206 freeDiskSpaceEx method ............162 dmPut method/procedure............208 fullName method/procedure ...........162 dmRemoveTable method/procedure.........208 getDir method ...............163 dmResync method/procedure...........208 getDrive method...............163 dmSetProperty method/procedure .........210 getFileAccessRights procedure ..........164 dmUnlink method/procedure ...........211 getValidFileExtensions procedure .........164 enumDataModel method/procedure .........212 isAssigned method ..............165 Property Names for enumDataModel ........212 isDir procedure ...............165 enumSource method .............213 isFile procedure ...............166 enumSourceToFile ..............214