[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'DbCtrls' (#lcl)

TDBEdit

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TDBEdit - a data-aware edit box for processing a single text-string from a dataset

Declaration

Source position: dbctrls.pp line 168

type TDBEdit = class(TCustomMaskEdit) end;

protected

  function GetReadOnly; override;

  procedure SetReadOnly(); override;

  procedure KeyDown(); override;

  

Invokes the OnKeyDown handler.

  procedure UTF8KeyPress(); override;

  procedure Notification(); override;

  

  function EditCanModify; override;

  

If True, the Edit box is allowed to modify the contents

  function GetEditText; override;

  

Get the text in the edit box (the string that has been masked)

  procedure Change; override;

  procedure Reset; override;

  

Reset - put back to its default state with mask appearing in Text box and no string input

  procedure WMSetFocus(); message;

  

Handler for receiving Focus event.

  procedure WMKillFocus(); message;

  

Handler for loosing Focus event. Eventually triggers #lcl.Controls.TControl.EditingDone.

  procedure WndProc(); override;

public

  constructor Create(); override;

  

Create - Constructor for TDBEdit: calls inherited Create then sets up data links and actions

  destructor Destroy; override;

  

Destroy - destructor for TDBEdit: frees data links then calls inherited Destroy

  function ExecuteAction(); override;

  function UpdateAction(); override;

  property Field: TField; [r]

  

The field in the DataSet from which data are to be displayed in the Edit

published

  property CustomEditMask: Boolean; [rw]

  property DataField: string; [rw]

  

The name (as a string) of the field whose data are to be displayed

  property DataSource: TDataSource; [rw]

  

The DataSource to be used for supplying the data in the required Field. Ususally the result of a data query

  property ReadOnly: Boolean; [rw]

  

Prevents the user from changing the text.

  property Align: TAlign;

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoSize: Boolean;

  

Allows to automatically adjust the size of the control, according to its content.

  property BiDiMode: TBiDiMode;

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderStyle: TBorderStyle;

  property CharCase: TEditCharCase;

  

Allows to force the text into all upper or lower case.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragKind: TDragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property EditMask: string;

  

EditMask - the sequence of characters used to obscure the string being typed (typically a sequence of asterisks)

  property Font: TFont;

  

The font to be used for text display in this control.

  property MaxLength: Integer;

  

The maximum length of the text; zero for unlimited.

  property ParentBiDiMode: Boolean;

  property ParentColor: Boolean;

  

If true, the Color of the control will be the same as the one from the Parent. Default is true.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property ParentShowHint: Boolean;

  

If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.

  property PasswordChar: Char;

  

Allows to obfuscate the displayed text, showing all characters as PasswordChar.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control

  property ShowHint: Boolean;

  

Enables the Hint display.

  property TabOrder: TTabOrder;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property Visible: Boolean;

  

Allows to show or hide the control, and all of its children.

  property OnChange: TNotifyEvent;

  

Event handler for any change in text.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEditingDone: TNotifyEvent;

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus. This is a good place for checking the finished user input.

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  property OnMouseLeave: TNotifyEvent;

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

Inheritance

TDBEdit

  

TDBEdit - a data-aware edit box for processing a single text-string from a dataset

|

TCustomMaskEdit

  

TCustomMaskEdit - base class for TMaskEdit, an Edit box with characters masked out to avoid unauthorised reading

|

TCustomEdit

  

The base class for controls presenting editable text.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

See also

HowToUseDataAwareControls

  

HowToUseDataAwareControls - Hints for accessing databases

The latest version of this document can be found at lazarus-ccr.sourceforge.net.