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

# TDBText

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

Displays a string value stored in a dataset field.

## Declaration

Source position: dbctrls.pp line 279

`type TDBText = class(TCustomLabel)`
`protected`
`procedure Notification(); override;` |  | Handles a notification when a component is added to or removed from the control.
`class procedure WSRegisterClass; override;` |  | Registers the class type used to create new instance of the control for the Widgetset.
`procedure Loaded; override;` |  | Performs actions when LCL component streaming has been completed.
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`destructor Destroy; override;` |  | Destructor for the class instance.
`function ExecuteAction(); override;` |  | Implements support for standard actions in the control.
`function UpdateAction(); override;` |  | Updates the specified action to reflect the current state in the linked dataset.
`property Field: TField; [r]` |  | Provides access to the field definition for the data-aware control.
`published`
`property Align: TAlign;` |  | Specifies the placement of the control on its Parent control.
`property Alignment: TAlignment;` |  | Horizontal text justification in the control (centered, left- or right-justified).
`property Anchors: TAnchors;` |  | The set of anchor definitions for this control.
`property AutoSize: Boolean;` |  | Allows automatic adjustment of the size for the control, according to its content.
`property BidiMode: TBiDiMode;` |  | Indicates whether text controls use in bi-directional reading.
`property BorderSpacing: TControlBorderSpacing;` |  | Determines the inner and outer border spacing for this control.
`property Color: TColor;` |  | The background color for the control.
`property Constraints: TSizeConstraints;` |  | Contains the minimum and maximum Width and Height for the control.
`property DataField: string; [rw]` |  | The name of the field, as a string (i.e. cannot be referred to as an Index).
`property DataSource: TDataSource; [rw]` |  | Provides access to the content displayed in the control.
`property DragCursor: TCursor;` |  | The cursor shape shown during a drag operation.
`property DragKind: TDragKind;` |  | Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`property DragMode: TDragMode;` |  | Determines how a drag operation is started for the control.
`property Enabled: Boolean;` |  | Determines whether the control responds to mouse or keyboard input.
`property FocusControl: TWinControl;` |  | The control associated with the label and its accelerator key (AccelChar).
`property Font: TFont;` |  | The font to be used for text display in this control.
`property Layout: TTextLayout;` |  | Vertical alignment for control text (at the top, bottom, or center).
`property OptimalFill: Boolean;` |  | If True, the font size is adjusted for optimal fill of the available space.
`property ParentBidiMode: Boolean;` |  | Indicates whether the BiDiMode settings in the Parent control are used.
`property ParentColor: Boolean;` |  | Use the Color from the Parent control, when enabled.
`property ParentFont: Boolean;` |  | Indicates if the Font from the Parent control is used in the control.
`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 PopupMenu: TPopupMenu;` |  | A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`property ShowAccelChar: Boolean;` |  | Enables or disables drawing of accelerator or shortcut keys for the label.
`property ShowHint: Boolean;` |  | Enables Hint display for the control.
`property Transparent: Boolean;` |  | Indicates whether the viewer can see through the control.
`property Visible: Boolean;` |  | Indicates if the control is displayed.
`property WordWrap: Boolean;` |  | Indicates if text is wrapped at the right edge of the control.
`property OnClick: TNotifyEvent;` |  | Notification handler for mouse clicks.
`property OnDblClick: TNotifyEvent;` |  | Event handler signalled when a mouse double click occurs in the control.
`property OnDragDrop: TDragDropEvent;` |  | Event handler signalled when an object is dropped onto the control.
`property OnDragOver: TDragOverEvent;` |  | Event handler signalled when a control is dragged over the control instance.
`property OnEndDrag: TEndDragEvent;` |  | Event handler signalled for the end of a drag-drop operation.
`property OnMouseDown: TMouseEvent;` |  | Event handler signalled when a mouse down event is handled for the control.
`property OnMouseEnter: TNotifyEvent;` |  | Event handler signalled when the mouse pointer has entered the control.
`property OnMouseLeave: TNotifyEvent;` |  | Event handler signalled when the mouse pointer has left the control.
`property OnMouseMove: TMouseMoveEvent;` |  | Event handler signalled when the mouse pointer is moved in the control.
`property OnMouseUp: TMouseEvent;` |  | Event handler signalled when a mouse up event is handled for the control.
`property OnMouseWheel: TMouseWheelEvent;` |  | Event handler for mouse wheel turned.
`property OnMouseWheelDown: TMouseWheelUpDownEvent;` |  | Event handler signalled for a downward movement of the mouse wheel.
`property OnMouseWheelUp: TMouseWheelUpDownEvent;` |  | Event handler signalled for an upward movement of the mouse wheel.
`property OnChangeBounds: TNotifyEvent;` |  | Event handler signalled when the Bounds for the control have been changed.
`property OnContextPopup: TContextPopupEvent;` |  | Invoked when a context-sensitive pop-up menu is requested.
`property OnResize: TNotifyEvent;` |  | Notification handler for a resize of the control.
`property OnStartDrag: TStartDragEvent;` |  | Event handler signalled for the start of a dragging operation.
`end;`

## Inheritance

`TDBText` |  | Displays a string value stored in a dataset field.
`TCustomLabel` |  | Control used to show static text optionally using multiple lines.
`TGraphicControl` |  | TGraphicControl is the base class for all lightweight controls.
`TControl` |  | The base class for visible controls.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

## Description

TDBText is a TCustomLabel descendant which implements a component to display the text content in a dataset field in the manner used for a label control. The stored field value is not editable in the control - just like a label component.

Use the Field property to access the field definition used to provide the value for the control.

## See also

TDBText.Field |  | Provides access to the field definition for the data-aware control.
TField
How To Use Data-aware Controls |  | HowToUseDataAwareControls - Hints for accessing databases.