[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 186

type TDBEdit = class(TCustomMaskEdit)

protected

  function GetReadOnly; override;

  

GetReadOnly - returns the boolean ReadOnly status

  procedure SetReadOnly(); override;

  

SetReadOnly - specifies whether ReadOnly applies

  procedure KeyDown(); override;

  

KeyDown - emulate the action of pressing the specified key (makes OnKeyDown respond)

  procedure KeyPress(); override;

  

KeyPress - simulates the action of pressing the specified key

  procedure Loaded; 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;

  

Change - software emulation of the OnChange event

  procedure Reset; override;

  

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

  procedure WMSetFocus(); message;

  

WMSetFocus - LCL Message to set focus

  procedure WMKillFocus(); message;

  

WMKillFocus - LCL Message to kill focus

  procedure LMPasteFromClip(); message;

  

LMPasteFromClip - LCL message method for pasting from clipboard

  procedure LMCutToClip(); message;

  

LMCutToClip - LCL message method for cutting to clipboard

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

  property Field: TField; [r]

  

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

published

  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]

  

ReadOnly - the contents of the edit box may only be read, not written or erased

  property Anchors;

  

The set of anchor definitions for this control

  property AutoSize;

  

Whether auto-size is to be used

  property BorderSpacing;

  

Determines the border spacing for this control

  property BorderStyle;

  property CharCase;

  

CharCase - rules for what case to use (upper or lower) to display text

  property Color;

  

Determine the colour for the current control

  property Constraints;

  

Determine Constraints (max and min height and width) for this control

  property DragCursor;

  

DragCursor - the style of cursor to be used during the Drag process

  property DragKind;

  

DragKind - what sort of dragging? Drag or Dock

  property DragMode;

  

DragMode - whether manual or automatic

  property Enabled;

  

Whether the control is Enabled (read/write). If not, it usually appears 'greyed-out'

  property EditMask;

  

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

  property Font;

  

The font to be used for text in this control (read/write).

  property MaxLength;

  

MaxLength: maximum length allowed for text string

  property ParentColor;

  

ParentColor - should the control have the same colour as the parent? Default is true

  property ParentFont;

  

ParentFont - should the control use the same font as the parent? Default is true

  property ParentShowHint;

  

ParentShowHint - does the control adopt the same hinting behaviour as its parent? Default is true

  property PasswordChar;

  

PasswordChar : the character which appears in the Edit box replacing and masking the actual character typed

  property PopupMenu;

  

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

  property ShowHint;

  

Flag to determine: Is hint to be displayed for this control?

  property TabOrder;

  

The place this control occupies in the list of tabs

  property TabStop;

  

Is the control in the sequence of controls accessed by successive presses of the Tab key?

  property Visible;

  

Visible - can the control be seen?

  property OnChange;

  

OnChange - event handler for any change in text

  property OnClick;

  

Event Handler for mouse click

  property OnDblClick;

  

Event Handle for mouse double-click

  property OnDragDrop;

  

Event handler for the drop of a control onto this control.

  property OnDragOver;

  

Event handler for the case when a control is dragged over another control

  property OnEditingDone;

  property OnEndDrag;

  

Event handler for the end of a dragging process

  property OnEnter;

  

OnEnter - event handler for when the mouse enters the control, and the control receives focus

  property OnExit;

  

OnExit - event handler for when the mouse leaves the control and it loses focus

  property OnKeyDown;

  

OnKeyDown - event handler for instance when key is down while control has focus

  property OnKeyPress;

  

OnKeyPress - event controller for a key being pressed while the control has focus. To properly handle national chars use UTF8KeyPress instead.

  property OnKeyUp;

  

OnKeyUp - event handler for instance when a key is up (not pressed) while the control has focus

  property OnMouseDown;

  

Event handler for when a mouse button is pressed down

  property OnMouseMove;

  

Event handler for mouse movement within the current control

  property OnMouseUp;

  

Event handler for when the mouse button is released, ie "up"

  property OnStartDrag;

  

Event handler for start of dragging operation

  property OnUTF8KeyPress;

  

UTF8KeyPress - event controller for a key being pressed while the control has focus.

end;

Inheritance

TDBEdit

  

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

|

TCustomMaskEdit

?

TObject

See also

HowToUseDataAwareControls

  

HowToUseDataAwareControls - Hints for accessing databases

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