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

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 inside its Parent.

  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;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

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 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 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 ParentBidiMode: Boolean;

  

Allows to use the BiDiMode settings in the Parent control. Default is true.

  property ParentColor: Boolean;

  

Use the Color from the Parent control, when enabled.

  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 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 the Hint display.

  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 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 OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  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 for the start of a dragging operation.

  property OptimalFill: Boolean;

  

If True, the font size is adjusted for optimal fill of the available space.

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.

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