diff --git a/docs/xml/lcl/dbctrls.xml b/docs/xml/lcl/dbctrls.xml index e8fb083740..fe7b87ccb4 100644 --- a/docs/xml/lcl/dbctrls.xml +++ b/docs/xml/lcl/dbctrls.xml @@ -62,8 +62,9 @@ - - Maintains an association between a control, an action, and a field in a linked dataset. + + + Maintains an association between a control, an action, and a field in a linked dataset.

@@ -685,13 +686,15 @@ - + Performs the notification message received for a component in the class instance.

Notification is an overridden method in TDBLookup. It calls the inherited method, and ensures that the ListSource property is set to Nil when the component is being removed.

- + + TComponent.Notification + Component for the notification. @@ -1056,7 +1059,7 @@ Message examined and updated in the method. - + Gets the value for the ReadOnly property.

@@ -1068,13 +1071,14 @@ + TCustomEdit.GetReadOnly TDataLink.ReadOnly Value for the property. - + Sets the value for the ReadOnly property.

@@ -1092,7 +1096,7 @@ New value for the property. - + Handles key down events in the control.

@@ -1150,7 +1154,7 @@ UTF-8 character examined in the method. - + Handles notifications when a component is added or removed from the control. @@ -1159,6 +1163,7 @@ TDataLink.DataSource + TComponent.Notification @@ -1167,7 +1172,7 @@ Operation for the notification. - + Indicates if the control can modify the text for the control value.

@@ -1181,6 +1186,7 @@ + TCustomMaskEdit.EditCanModify @@ -1188,7 +1194,7 @@ - + Performs actions needed when the value for the control has been changed.

@@ -1206,7 +1212,7 @@ TDataLink.UpdateRecord - + Cancels pending changes to the linked dataset.

@@ -1219,30 +1225,37 @@ + TCustomMaskEdit.Reset TDataLink.DataSource - + Ensures that the control has the input focus. -

- WMSetFocus is an overridden method in TDBEdit. WMSetFocus ensures that the text for the control is updated before calling the inherited method. This includes applying an edit mask assigned to the control when it has input focus. +

+ WMSetFocus is an overridden method in TDBEdit. WMSetFocus ensures that the text for the control is updated before calling the inherited method. This includes applying an edit mask assigned to the control when it has input focus. +

- + + TCustomEdit.WMSetFocus + - + Window message handled for the control. - - Ensures that the liked dataset is updated when the modified control loses input focus. + + + Ensures that the liked dataset is updated when the modified control loses input focus. - + + TCustomEdit.WMKillFocus + - + Window message handled for the control. - + Handles the specified LCL message for the control.

@@ -1259,7 +1272,6 @@

- @@ -1268,12 +1280,13 @@ LM_CLEAR LM_CUT LM_PASTE + TCustomEdit.WndProc LCL message examined and applied in the method. - + Constructor for the class instance.

@@ -1304,7 +1317,7 @@ TCustomEdit.Destroy - + Provides support for TBasicAction in the control.

@@ -1440,7 +1453,7 @@ - + Indicates if the control cannot modify the field in the linked dataset.

@@ -1459,6 +1472,7 @@ + TCustomEdit.ReadOnly TDataLink.ReadOnly TDataLink.DataSource TDataLink.DataSet @@ -1466,40 +1480,13 @@ - - -

Anchors determines how the control is to be anchored to its client or parent control. -

-

One of the standard properties, which should be supported by all descendants. -

-

Either reads a flag containing the set of anchors to be used, or writes a set of anchors. When Anchors has been written, this is indicated in IsAnchorsStored. -

- - - + - - -

One of the standard properties, which should be supported by all descendants. -

-

AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption. -

-

Reads a logical (Boolean) flag to see whether auto-sizing has been performed, or writes the flag to say it should be done. The default value is False, and indicates that auto-sizing is not used. -

- - - + - - -

One of the standard properties, which should be supported by all descendants. -

-

Determines the border spacing for this control. Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing. The properties are defined in the parent class TControlBorderSpacing. -

- - + - +

Indicates how text is displayed in a text editing control in the following ways:

@@ -1508,9 +1495,11 @@
  • Upper case letters
  • Lower case letters
    • -

    The rules can, of course, be overridden by use of the shift key.

    +

    The rules can be overridden by use of the Shift key.

     - + + TCustomEdit.CharCase +     @@ -1534,61 +1523,51 @@ - - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList. -

    -

    Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored. -

    -     - -     + - - -

    Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate. -

    -     - -     + - + + Event handler signalled when a key is down while control has focus.

    - OnKeyDown is an event handler signalled when a key is down while control has focus. -

    -

    Differs from OnKeyPress in that the key may have already been down when the control received focus; with OnKeyPress the key needs to become pressed while the control has focus. + OnKeyDown differs from the method in TWinControl in that the key may have already been down when the control received focus; with OnKeyPress the key needs to become pressed while the control has focus.

    - + + TWinControl.OnKeyDown +     - + + + Event handler signalled when a key is being pressed while the control has focus. +

    - OnKeyPress is an event controller signalled when a key is being pressed while the control has focus. -

    -

    Differs from OnKeyDown in that the key needs to become pressed while the control has focus; with OnKeyDown the key may have already been down when the control received focus. + OnKeyPress differs from the method in TWInControl in that the key needs to become pressed while the control has focus; with OnKeyDown the key may have already been down when the control received focus.

    - + + TWinControl.OnKeyPress +     - + + + Event handler signalled when a key becomes up (not pressed) while the control has focus. +

    - OnKeyUpis an event handler signalled when a key is up (not pressed) while the control has focus. -

    -

    The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus. + OnKeyUpis an event handler signalled when a key is up (not pressed) while the control has focus. The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.

    - + + TWinControl.OnKeyUp +     @@ -1601,8 +1580,7 @@ - Displays a string value stored in a dataset field. - + Displays a string value stored in a dataset field.

    TDBText is a @@ -1787,7 +1765,7 @@ TGraphicControl.Destroy - + Implements support for standard actions in the control.

    @@ -1804,8 +1782,8 @@ - - TControl.ExecuteAction + TDataLink.ExecuteAction + TComponent.ExecuteAction TBasicAction @@ -1815,7 +1793,7 @@ Standard action examined in the method. - + Updates the specified action to reflect the current state in the linked dataset. @@ -1937,7 +1915,7 @@ - + Indicates if text is wrapped at the right edge of the control.

    @@ -1946,7 +1924,9 @@

    The default value for the property is False.

    - + + TCustomLabel.WordWrap +     @@ -2101,7 +2081,8 @@ Object for the event notification. - + + Handles key down events for the control.

    KeyDown is an overridden method in @@ -2212,7 +2193,7 @@ - + Implements support for standard actions in the control.

    @@ -2229,7 +2210,7 @@ TDataLink.ExecuteAction TDataLink.UpdateAction - TControl.ExecuteAction + TComponent.ExecuteAction TBasicAction @@ -2240,7 +2221,7 @@ Action examined and executed in the method. - + Updates the state for the specified action.

    @@ -2256,6 +2237,7 @@ TDataLink.UpdateAction TDataLink.ExecuteAction + TComponent.UpdateAction TBasicAction @@ -2342,7 +2324,7 @@ TDataLink.ReadOnly - + Implements a data-aware version of TListBox. @@ -2363,7 +2345,7 @@ How To Use Data-aware Controls - + Implements the event handler signalled when data in the linked dataset has been changed. @@ -2379,18 +2361,18 @@ - + TCustomListBox.ItemIndex TDataLink.DataSource Object for the event notification. - + Performs actions needed when the current selection in the listbox control is changed. @@ -2409,19 +2391,19 @@

    - + TCustomListBox.DoSelectionChange     Indicates if the change results from user interaction with the control. - + Performs actions needed to update the linked dataset when the value for the control has changed. @@ -2436,10 +2418,10 @@ - + TCustomListBox.ItemIndex @@ -2462,41 +2444,10 @@ - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Either reads a flag containing alignment instructions (FAlign) or writes alignment instructions (SetAlign). -

    -

    May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right. -

    -     - -     - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Determines how the control is to be anchored to its client or parent control. -

    -

    Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in the IsAnchorsStored property. -

    -     - -     + + - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Determines the border spacing for this control. -

    -

    Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing. -

    -

    The properties are defined in the parent class TControlBorderSpacing. -

    -     -     + @@ -2512,69 +2463,68 @@ - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList. -

    -

    Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored. -

    -     - -     + - - -

    Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate. -

    -     - -     + - + + + Event handler signalled to draw an Item on the data-aware list box. +

    - OnDrawItemis an event handler used to draw an Item in the data-aware list box. + OnDrawItemis an event handler used to draw an Item on the data-aware list box.

    -

    For example, selecting an item may require it to be highlighted or have its font or background changed. +

    + For example, selecting an item may require it to be highlighted or have its font or background changed.

    - + + TCustomListBox.OnDrawItem +     - + + + Event handler signalled when a key is pressed while the control has focus. +

    - OnKeyPress is an event handler signalled for a key being pressed while the control has focus. -

    -

    Differs from OnKeyDown in that the key needs to become pressed while the control has focus; with OnKeyDown the key may have already been down when the control received focus. + OnKeyPress differs from OnKeyDown in that the key needs to become pressed while the control has focus; with OnKeyDown the key may have already been down when the control received focus.

    - + + TWinControl.OnKeyPress +     - + + + Event handler signalled when a key is down while the control has focus. +

    - OnKeyDown is an event handler signalled when a key is down while control has focus. -

    -

    Differs from OnKeyPress in that the key may have already been down when the control received focus; with OnKeyPress the key needs to become pressed while the control has focus. + OnKeyDown differs from OnKeyPress in that the key may have already been down when the control received focus; with OnKeyPress the key needs to become pressed while the control has focus.

    - + + TWinControl.OnKeyDown +     - + + + Event handler signalled when a key is up (not pressed) while the control has focus. +

    - OnKeyUp is an event handler signalled when a key is up (not pressed) while the control has focus. -

    -

    The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus. + In OnKeyUp, the key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.

    - + + TWinControl.OnKeyUp +     @@ -2593,38 +2543,25 @@ - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by the OnShowHint event handler. -

    -     - -     + - - -

    Reads or writes Boolean flag; default is False. -

    -

    Use the TabStop to allow or disallow access to the control using the Tab key. -

    -

    If TabStop is True, the control is in the tab order. If TabStop is False, the control is not in the tab order and the user can't use the Tab key to move to the control. -

    -     - -     + - + + + Indicates if the control is visible on the parent. +

    The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets Visible to True. Setting Visible to False is equivalent to calling Hide method.

    - The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility. + The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get the real visibility.     - + + TControl.Visible +     Implements a data-aware listbox control with database lookup capabilities. @@ -2756,7 +2693,7 @@ Indicates if the selection change is due to user interaction with the control. - + Initializes the window handle for the control.

    @@ -2766,12 +2703,12 @@

    - TCustomListBox.InitializeWnd + TCustomListBox.Items     - + Frees the window handle and updates the address used for the Items in the controls. @@ -2806,8 +2743,9 @@ Modifier for the virtual key code. - - Performs actions needed when the control has loaded using the LCL streaming mechanism. + + + Performs actions needed when the control has loaded using the LCL streaming mechanism.

    @@ -2818,7 +2756,7 @@

    - TComponent.Loaded + TComponent     @@ -3114,7 +3052,7 @@     - + Sets the DataSource to Nil when the control is destroyed. @@ -3130,6 +3068,7 @@ + TComponent @@ -3292,9 +3231,8 @@ TCustomRadioGroup.Destroy - - Performs actions needed when the user has finished editing. - + + Performs actions needed when the user has finished editing.

    EditingDone is an overridden method in TDBRadioGroup. It is used to perform actions needed when the user has finished editing using the control. It occurs when the focus changes to another control, or when the user selects another item using the mouse. @@ -3313,7 +3251,7 @@ TControl.OnEditingDone - + Implements support for standard actions in the control.

    @@ -3329,7 +3267,7 @@ - + TDataLink.ExecuteAction TBasicAction TComponent.ExecuteAction @@ -3434,32 +3372,16 @@ - - -

    One of the standard properties, which should be supported by all descendants.

    -

    Either reads a flag containing alignment instructions (FAlign) or writes alignment instructions (SetAlign). -

    -

    May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right. -

    -     - -     - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Determines how the control is to be anchored to its client or parent control. -

    -

    Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in IsAnchorsStored. -

    -     - -     + + - + + + Text displayed as the caption for the control. +

    Gets caption as a text-string (GetText), or stores the new caption (SetText). Shows flag if caption is stored (IsCaptionStored).

    @@ -3474,17 +3396,25 @@

    To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.

    - + + TControl.Caption +     - + + + Number of columns displayed for the radio buttons on the control. + -

    Don't confuse this with the Columns entity in a DBGrid, nor with the COLUMNS entity in a SQL database - it simply refers to the number of columns of radiobuttons to be displayed. +

    + Don't confuse this with the Columns entity in a DBGrid, nor with the COLUMNS entity in a SQL database - it simply refers to the number of columns of radiobuttons to be displayed.

    - + + TCustomRadioGroup.Columns +     @@ -3527,25 +3457,16 @@ TDataSource - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Whether the control is Enabled. If not, it usually appears 'greyed-out'. -

    -

    Reads a flag to see whether the control is enabled, or stores a new value. If stored, a flag is set to reflect the condition. -

    -     - -     + - - Contains the string values used as captions for radio buttons in the grouped data-aware control. + + + Contains the string values used as captions for radio buttons in the grouped data-aware control.

    @@ -3565,6 +3486,7 @@ + TCustomRadioGroup.Items @@ -3652,14 +3574,19 @@ - + + Indicates if the control is visible on its parent. -

    The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets, among others, Visible to True. Setting Visible to False is equivalent to calling Hide method. +

    + The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets, among others, Visible to True. Setting Visible to False is equivalent to calling Hide method.

    - The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility. + + The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.     - + + TControl.Visible +     Implements a data-aware checkbox control. @@ -3825,7 +3752,7 @@ Object for the event notification. - + Performs actions needed when the control is clicked.

    @@ -3843,6 +3770,7 @@ + TButtonControl.DoOnChange TDataLink.UpdateRecord @@ -3876,7 +3804,7 @@ Object for the event notification. - + Handles notification events for components used in the class instance.

    @@ -4021,50 +3949,15 @@ - - -

    If AllowGrayed is set to True, the check box has three possible states: checked, unchecked and grayed. If AllowGrayed is set to False, the check box has only two possible states: checked and unchecked. -

    -     - -     - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Determines how the control is to be anchored to its client or parent control. -

    -

    Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in IsAnchorsStored. -

    -     - -     - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption. -

    -

    Reads a logical (Boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is False, i.e. no auto-sizing. -

    -     - -     + + + - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Determines the border spacing for this control. -

    -

    Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing. -

    -

    - The properties are defined in the parent class TControlBorderSpacing. -

    -     -     - + + + + Text displayed as the caption for the control. +

    Gets the caption for the control as a text-string (GetText), or stores the new caption (SetText). Updates an internal flag if the caption is stored (IsCaptionStored).

    @@ -4079,18 +3972,11 @@

    To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.

    - -     - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Reads the value for color, or stores the value, and sets a flag if the color is stored. -

    -

    The default color is the same as the window in which the control is located. -

    -     + + TControl.Caption +     + The name (as a string) of the field with which the checkbox is to be associated. @@ -4139,39 +4025,11 @@ - - -

    One of the standard properties, which should be supported by all descendants.

    -

    Whether the control is Enabled. If not, it usually appears 'greyed-out'. -

    -

    Reads a flag to see whether the control is enabled, or stores a new value. If stored, a flag is set to reflect the condition. -

    -     - -     + - - -

    - Hint is a small informative pop-up box that appears when the mouse 'hovers' over a control. -

    -

    Requires the ShowHint property to be set to True to enable the pop-up display. -

    -     - -     + - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList. -

    -

    Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored. -

    -     - -     + @@ -4193,15 +4051,7 @@ - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Reads the details of the pop-up menu, or stores them. Properties are defined in the parent class TPopupMenu -

    -     - -     + ReadOnly - if @@ -4210,31 +4060,9 @@ - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by the OnShowHint event handler. -

    -     - -     - - -

    Reads or writes information in flag; default is -1. -

    -     - -     - - -

    Use TabStop to allow or disallow navigational access to the control using the Tab key. -

    -

    If TabStop is set to True, the control is accessible in the tab order. If TabStop is set to False, the control is not in the tab order and the user can't press the Tab key to move to the control. -

    -     - -     + + + ValueChecked is the value to use when the box is checked, for example @@ -4251,14 +4079,19 @@ - + + + Indicates if the control is visible on its parent. +

    The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets, among others, Visible to True. Setting Visible to False is equivalent to calling Hide method.

    The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.     - + + TControl.Visible +     @@ -4637,7 +4470,7 @@ True when the action was updated in the method. - + EditingDone - updates data through the link, then calls inherited EditingDone. @@ -4749,7 +4582,7 @@ TDataLink.DataSet - + TDBComboBox - a data-aware version of TComboBox to allow selection of a value from a list of entries into a database field. @@ -4766,8 +4599,8 @@

    - How To Use Data-aware Controls + How To Use Data-aware Controls     @@ -4796,7 +4629,7 @@ Object for the event notification. - + Applies standard keystrokes to the control.

    @@ -4814,7 +4647,7 @@ Keystroke character examined in the method. - + Applies the changed value for the control to the field in its linked dataset. @@ -4839,7 +4672,7 @@ - + Indicates if the drop-down is automatically displayed when the control gets the input focus. @@ -4890,31 +4723,12 @@ TCustomComboBox.MaxLength - - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList. -

    -

    Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored. -

    -     - -     - + - - - -

    - Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate. -

    -     -     + @@ -4923,35 +4737,44 @@ - + + + Event handler signalled when a key is down while the control has focus. +

    - OnKeyDown is an event handler signalled when a key is down while control has focus. -

    -

    Differs from OnKeyPress in that the key may have already been down when the control received focus; with OnKeyPress the key needs to become pressed while the control has focus. + OnKeyDown differs from OnKeyPress in that the key may have already been down when the control received focus; with OnKeyPress the key needs to become pressed while the control has focus.

    - + + TWinControl.OnKeyDown +     - + + + Event handler signalled when a key is pressed while the control has focus. +

    - OnKeyPress is an event handler signalled when a key is pressed while the control has focus. -

    -

    Differs from OnKeyDown in that the key needs to become pressed while the control has focus; with OnKeyDown the key may have already been down when the control received focus. + OnKeyPress differs from OnKeyDown in that the key needs to become pressed while the control has focus; with OnKeyDown the key may have already been down when the control received focus.

    - + + TWinControl.OnKeyPress +     - + + + Event handler signalled when when a key is released while the control has focus. +

    - OnKeyUp is an event handler signalled when when a key is released (not pressed) while the control has focus. -

    -

    The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus. + In OnKeyUp, the key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.

    - + + TWinControl.OnKeyUp +     @@ -4976,14 +4799,17 @@ - + + Indicates if the control is visible on its parent.

    The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets, among others, Visible to True. Setting Visible to False is equivalent to calling Hide method.

    The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.

    - + + TControl.Visible +     @@ -5539,7 +5365,7 @@ Object for the event notification. - + Handles the notification when a component is added or removed from the control. @@ -5569,7 +5395,7 @@ Object for the event notification. - + Performs actions needed when the value for the control has been changed.

    @@ -5707,7 +5533,7 @@ - + Provides support for TBasicAction in the control.

    @@ -5731,7 +5557,7 @@ Action examined and executed in the method. - + Updates the specified action to reflect the current state in the linked dataset. @@ -6045,7 +5871,7 @@ Operation for the notification event. - + Constructor for the class instance.

    @@ -6084,7 +5910,7 @@ TWinControl.Destroy - + Provides support for TBasicAction in the control.

    @@ -6108,7 +5934,7 @@ Action examined and executed in the method. - + Updates the specified action to reflect the current state in the linked dataset. @@ -6164,7 +5990,10 @@ - + + + Text displayed as the caption for the control. +

    Gets caption as a text string (GetText), or stores the new caption (SetText). Sets an internal flag if the caption is stored (IsCaptionStored).

    @@ -6237,30 +6066,9 @@ - - -

    One of the standard properties, which should be supported by all descendants.

    -

    This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList. -

    -

    Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored. -

    -     - - TControl.OnClick - -     - + - - - -

    Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate. -

    -     - - TControl.OnDblClick - -     + @@ -6276,17 +6084,26 @@     - + + + Event handler signalled when a key is being pressed while the control has focus. +

    OnKeyPress is an event controller signalled when a key is being pressed while the control has focus.

    -

    Differs from OnKeyDown in that the key needs to become pressed while the control has focus; with OnKeyDown the key may have already been down when the control received focus. +

    + Differs from OnKeyDown in that the key needs to become pressed while the control has focus; with OnKeyDown the key may have already been down when the control received focus.

    - + + TWinControl.OnKeyPress +     - + + + Event handler signalled when a key is up (not pressed) while the control has focus. +

    OnKeyUp is an event handler signalled when a key is up (not pressed) while the control has focus. @@ -6294,7 +6111,9 @@

    The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.

    - + + TWinControl.OnKeyUp +     @@ -6313,18 +6132,13 @@ - - -

    One of the standard properties, which should be supported by all descendants. -

    -

    Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by the OnShowHint event handler. -

    -     - -     + + + Indicates if the control is visible on its parent. +

    The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets, among others, Visible to True. Setting Visible to False is equivalent to calling Hide method.

    @@ -6380,7 +6194,7 @@     - + Value for the DataSource property. Gets the value for the Field property. @@ -6388,7 +6202,7 @@ - + Value for the Field property. Gets the value for the ReadOnly property. @@ -6396,7 +6210,7 @@ - + Value for the ReadOnly property. Sets the value for the AutoDisplay property. @@ -6404,7 +6218,7 @@ - + Value for the AutoDisplay property. Sets the value for the DataField property. @@ -6412,7 +6226,7 @@ - + New value for the DataField property. Sets the value for the DataSource property. @@ -6420,7 +6234,7 @@ - + New value for the DataSource property. Sets the value for the ReadOnly property. @@ -6428,7 +6242,7 @@ - + New value for the ReadOnly property. Implements the CM_GETDATALINK message for the control. @@ -6438,11 +6252,21 @@ Message for the handler. - - Performs notifications when a component in the class instance is added or removed. + + + Handles notifications when a component in the class instance is added or removed. - - + +

    + Notification is an overridden method in TDBImage used to handle the notification received when a component for the control is added or removed. It calls the inherited method on entry. +

    +

    + Notification ensures that the Datasource member is set to Nil when its component is removed from the control. Needed when the data link for the control has been assigned. +

    +     + + TComponent.Notification +     Component for the notification. @@ -6495,8 +6319,9 @@ Object for the event notification. - - Performs actions needed when the Picture property in the image control has been changed. + + + Performs actions needed when the Picture property in the image control has been changed.

    PictureChanged is an overridden method in TDBImage, and calls the inherited method. PictureChanged ensures that the Change method is called if it has not already been executed. @@ -6943,7 +6768,7 @@

    - + TDBCalendar - a data-aware version of TCalendar, for selecting a date to store in a database field. @@ -7074,11 +6899,18 @@ Implements the CM_GETDATALINK message for the control. - - Notification is an overridden method in TDBCalendar. It ensures that the DataSource is set to Nil when the component is freed. + + + Handles the notification when a component on the control is added or removed. + + +

    + Notification is an overridden method in TDBCalendar. It ensures that the DataSource is set to Nil when the component is freed. +

    + TControl.Notification     @@ -7284,7 +7116,7 @@ - + Indicates if the control cannot modify the field in the linked dataset.

    @@ -7756,7 +7588,7 @@ - + Object for the event notification. @@ -7767,7 +7599,7 @@ - + Object for the event notification. @@ -7940,17 +7772,23 @@ - - - - - + - Set with the style values for TDBNavigator buttons. + Set with the style values for the navigator button. - - + +

    + NavStyle is a TDBNavButtonStyle property which contains the style values used for the navigator button. It contains zero or more values representing the features enabled for the button. See TDBNavButtonStyle for more information about the values in the set type and their meanings. +

    +

    + NavStyle is used in the TDBCustomNavigator.UpdateButtons method to enable the timer used for Previous (nbPrior) and Next (nbNext) buttons. +

    +     + + + +     @@ -8075,15 +7913,16 @@ TDBCustomNavigator control for the data link. - + TDBNavigator - a data-aware Button-Bar to facilitate navigating between records of a dataset.

    - TDBNavigator is an advanced tool for navigating through datasets held locally in response to a query sent to the database. + TDBNavigator is a tool used to navigate local datasets in a response to a query sent to the database. It consists of a series of toolbuttons used to perform navigation and maintenance for records in the linked dataset.

    -

    It consists of a series of toolbuttons used to perform navigation and maintenance for records in the linked dataset. For example: +

    + For example:

    Navigation