From 9b0ab24c141621263e943de4a18bc4f966285c65 Mon Sep 17 00:00:00 2001 From: dsiders Date: Mon, 6 Feb 2023 19:08:00 +0000 Subject: [PATCH] Docs: DateTimeCtrls/dbdatetimepicker. Adds missing content and links to inherited topics. --- .../datetimectrls/docs/dbdatetimepicker.xml | 576 +++++------------- 1 file changed, 137 insertions(+), 439 deletions(-) diff --git a/components/datetimectrls/docs/dbdatetimepicker.xml b/components/datetimectrls/docs/dbdatetimepicker.xml index d392e5e4c5..06b15d13e8 100644 --- a/components/datetimectrls/docs/dbdatetimepicker.xml +++ b/components/datetimectrls/docs/dbdatetimepicker.xml @@ -6,13 +6,6 @@ DBDateTimePicker ==================================================================== --> - - - Implements a database-aware version of the date/time picker control. @@ -71,7 +64,23 @@ DateTimeCtrls Package Implements a database-aware version of the TDateTimePicker control. - + +

+TDBDateTimePicker is a TCustomDateTimePicker descendant +which implements a database-aware date/time picker control. +

+ +

+It adds properties and methods needed to read and write the date/time value +for the control using a DataSource, DataField, and an internal TFieldDataLink +class instance. It provides support for displaying and storing a value in a +database field which has a null value. +

+

+TDBDateTimePicker sets the visibility for properties and events introduced in +ancestor classes. +

+ TCustomDateTimePicker @@ -110,7 +119,22 @@ Implements a database-aware version of the TDateTimePicker control. Performs actions needed when the value for the control has been changed. - + +

+Change is an overridden method in TDBDateTimePicker. It ensures +that the field data link is assigned and changes have occurred in the date/ +time value before it is stored to the linked dataset. No actions are performed +in the method if either conditions is not met. +

+

+Change calls the Edit method in the field link to ensure that the field can be +modified in the linked dataset. If Edit returns True, the field is in +an edit state and ready for the modification. The inherited Change method is +called to signal the OnChange event handlers assigned for the control. If Edit +returns False, the Reset method in the data link is called to revert +the field to its previous state. +

+ TCustomDateTimePicker.Change TFieldDataLink @@ -130,7 +154,8 @@ Validates and applies a user-specified date/time value for the control. Reverts changes to the date/time value in the control and its linked dataset. - + + @@ -138,8 +163,18 @@ Reverts changes to the date/time value in the control and its linked dataset. Constructor for the class instance. - - + +

+Create is the overridden constructor for the class instance, and +calls the inherited constructor on entry. It allocates resources for the +internal TFieldDataLink in the class instance, and assigns private methods in +the class which implement handler routines to the event handlers in the field +link. +

+ + +TCustomDateTimePicker.Create + @@ -151,7 +186,14 @@ Owner of the class instance. Destructor for the class instance. - + +

+Destroy is the overridden destructor for the class instance. It +clears the event handlers and frees the internal field link used in the class +instance. It calls the inherited method prior to exit to free the class +instance. +

+ @@ -160,19 +202,24 @@ Destructor for the class instance. Provides access to the TField instance for the date/time value in the linked dataset. - + +

+Field is a read-only TField property which provides access to the +field where the date/time value is stored in the linked dataset. The value for +the property is read from the Field property in the internal TFieldDataLink +instance used in the class. +

+ - -String with the field name where the date/time value is stored in the linked -dataset. +Name for the field where the date/time value is stored in the linked dataset. @@ -188,435 +235,86 @@ Provides access to the dataset for the date/time value. -Indicates whether the data/time value can be modified. +Indicates whether the data/time value can be modified using the control. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +