home *** CD-ROM | disk | FTP | other *** search
/ Chip 1999 January / Chip_1999-01_cd.bin / zkuste / delphi / D3 / CLONED3.ZIP / readme.txt < prev   
Text File  |  1998-08-02  |  5KB  |  167 lines
  1. TGLDBCloneRecord
  2. ================
  3.  
  4. Version 1.0 (2 August 1998)
  5. Delphi 3 version
  6. Copyright (c) 1998 Greg Lief
  7.  
  8. ----------------------------------------------------------------------------
  9.  
  10. 1.  Description
  11. 2.  Installation
  12. 3.  Properties
  13. 4.  Events
  14. 5.  Methods
  15. 6.  Copyright Notice
  16. 7.  Disclaimer
  17. 8.  Technical Support
  18. 9.  Revision History
  19. 10. Purchasing Source Code
  20.  
  21. ----------------------------------------------------------------------------
  22.  
  23. Description
  24. ===========
  25.  
  26. TGLCloneRecord is a non-visual component that attaches to any dataset.
  27. When so attached, you can call its Execute method to automatically
  28. generate an exact duplicate of the current record in that dataset. You
  29. can customize the fields whose values should be assigned by setting the
  30. Fields property.
  31.  
  32. You may automatically post the new record by setting the AutoPost
  33. property, and you can perform custom logic just prior to the post by
  34. providing a BeforePost event handler.
  35.  
  36.  
  37. 2. Installation
  38. ===============
  39.  
  40. A. Choose the Component | Install Packages menu option.
  41.  
  42. B. Click upon the Add Button, and select CloneRecord.DPL.
  43.  
  44. C. Press OK twice.
  45.  
  46. D. TGLCloneRecord will now appear in the list of design-time packages. You
  47.    should also see a new tab entitled "Greg Lief" or "GLAD: Database", with 
  48.    the TGLCloneRecord icon upon it.
  49.  
  50.  
  51. 3. Properties
  52. =============
  53.  
  54. AutoPost property
  55.  
  56. property AutoPost : boolean ;
  57.  
  58. If set to True, the Execute method will automatically post the newly
  59. cloned record after calling your BeforePost event handler. (The default
  60. value is True.)
  61.  
  62.  
  63. DataSet property
  64.  
  65. property DataSet : TDataSet ;
  66.  
  67. This is the dataset for which you wish to create duplicate records. When
  68. you assign this property, the Fields property will automatically be
  69. filled in with all field definitions for the dataset. 
  70.  
  71.  
  72. ErrorMessage property
  73.  
  74. property ErrorMessage : string ;
  75.  
  76. If/when the Execute method returns False, this property will contain a
  77. description of the error which occurred.
  78.  
  79. Notes
  80.  
  81. This property is available at run-time only, and is read-only.
  82.  
  83.  
  84. property Fields : TStringList ;
  85.  
  86. This allows you to customize which fields will be assigned values when
  87. creating the new record. By default, this will contain all field
  88. definitions for the attached dataset.
  89.  
  90.  
  91. 4. Events
  92. =========
  93.  
  94. BeforePost event
  95.  
  96. property BeforePost : TDataSetNotifyEvent ;
  97.  
  98. If the AutoPost property is set to True, this event will be fired just
  99. prior to posting the newly cloned record.
  100.  
  101.  
  102. 5. Methods
  103. ==========
  104.  
  105. Execute method
  106.  
  107. function Execute ; boolean ;
  108.  
  109. This will create a new record in the attached dataset, then fill in the
  110. specified fields based upon the values in the current record. If the
  111. AutoPost property is set to True, the BeforePost event handler will be
  112. called and the record will be posted.
  113.  
  114. This method returns True if the record is successfully created. If it
  115. returns False, you may check the ErrorMessage property for further
  116. details.
  117.  
  118.  
  119. 6. Copyright Notice
  120. ===================
  121.  
  122. This component is fully functional.  My copyright notice will appear
  123. when you drop it upon a form at design-time, but that will not occur at
  124. run-time.  You can remove the copyright notice by purchasing the source
  125. code (see item #10 below).
  126.  
  127.  
  128. 7. Disclaimer
  129. =============
  130.  
  131. It is unfortunate that we live in a litigous society in which the
  132. lawyers are generally the only winners.  However, that makes the
  133. following verbiage necessary:
  134.  
  135. "THE CODE FOR THIS COMPONENT IS PROVIDED TO YOU AS IS BY ITS AUTHOR,
  136. GREG LIEF. THE AUTHOR HAS TESTED THE COMPONENT AND FEELS THAT IT WORKS
  137. AS BILLED, BUT MAKES ABSOLUTELY NO GUARANTEES OR WARRANTEES OF ANY KIND.
  138. IN OTHER WORDS, YOU ARE USING THIS ENTIRELY AT YOUR OWN RISK.  NEITHER
  139. THE AUTHOR NOR ANY OTHER ORGANIZATION WILL BE HELD RESPONSIBLE FOR ANY
  140. DIRECT OR INDIRECT DAMAGE RESULTING FROM THE USE OF EITHER THIS
  141. COMPONENT OR ANY DERIVATIVES THEREOF."
  142.  
  143.  
  144. 8. Technical Support
  145. ====================
  146.  
  147. The reason I am making this component available as freeware because I
  148. feel that it will be of use to other Delphi developers. However, always
  149. remember the old maxim "you get what you pay for".  In other words, do
  150. not get carried away by expecting technical support, because you will be
  151. sadly disappointed.
  152.  
  153.  
  154. 9. Revision History
  155. ===================
  156.  
  157. August 2, 1998 - initial public release
  158.  
  159.  
  160. 10. Purchasing Source Code
  161. ==========================
  162.  
  163. The TGLCLoneRecord source code is available for $5 US. See the ORDER.TXT
  164. (included in this .ZIP file) for more details.  TGLCloneRecord is also
  165. part of my G.L.A.D. component package, which consists of all 45+ of my
  166. components.  For more information about G.L.A.D., visit www.greglief.com.
  167.