TLabeledEdit class

In unit ExtCtrls

Implements an edit control with a label bound to the control.

Declaration

pascal

TLabeledEdit = class(TCustomLabeledEdit)

Inheritance

Description

TLabeledEdit is a TCustomLabeledEdit descendant which implements an edit control with a label bound to the control. It saves time and effort over placing separate Label and Edit Box on Form. The properties are described in the parent component, TCustomLabeledEdit from which most of the properties are inherited.

Note particularly the EditLabel property (see TBoundLabel), which contains the label attached to the Edit control.

Use LabelPosition to specify the location where EditLabel is displayed relative to the edit box in the control. Use LabelSpacing to set the spacing (in pixels) between EditLabel and the edit control.

About TCustomLabeledEdit / TLabeledEdit

TCustomLabeledEdit and TLabeledEdit are based on the similarly named controls from the Delphi VCL. While they offer code compatibility with the VCL class, they have some drawbacks when used in the LCL. For instance:

They do not work very well with the positioning and anchoring mechanisms used in LCL. They do not have an Align property used to position, align, and stack controls towards one of the edges on the parent control.
There are also shortcomings when using BorderSpacing; the extra spacing is inserted between the bound label and the edit box on the control instead around the composite control.
Labels with long captions are not ellipsified or aligned properly when longer than the associated edit control.
Multi-line captions on a label are not positioned as expected; the label often overlaps (or is obscured by) adjacent controls.
When EditLabel is placed above or below the Edit control, and its caption is wider than the Edit, the text will be clipped at the Edit's left/right sides. Likewise, when the EditLabel is placed at the left or right of the Edit control and is taller than the Edit, it will be clipped at the top and bottom edges of the Edit control.

Despite the convenience of TCustomLabeledEdit / TLabeledEdit, most will elect to use separate label and edit controls to avoid the shortcomings in the align and anchoring mechanisms for the composite control.

Properties

`Alignment`	published	The horizontal alignment for the text in the control (left, right, or centered).
`Anchors`	published	The set of anchor definitions for this control.
`AutoSelect`	published	Enables auto-selection of text when focused.
`AutoSize`	published	Allows automatic adjustment of the size for the control, according to its content.
`BidiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderStyle`	published	Indicates the border style displayed around the control.
`CharCase`	published	Controls the character case applied to values entered in the control.
`Color`	published	The background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DoubleBuffered`	published	When enabled, it reduces flicker when the control is painted.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragMode`	published	Determines how a drag operation is started for the control.
`EchoMode`	published	Allows to modify the text display, useful for entering passwords.
`EditLabel`	published	EditLabel - the label attached to the edit box.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Font`	published	The font to be used for text display in this control.
`LabelPosition`	published	Edge on the edge control where the bound label is aligned.
`LabelSpacing`	published	Number of pixels between the control and its bound label.
`MaxLength`	published	The maximum length of the value entered in Text, or 0 (zero) for unlimited length.
`NumbersOnly`	published	Indicates if the edit control accepts numeric values only.
`ParentBidiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`ParentDoubleBuffered`	published	Value for the DoubleBuffered property in a Parent control.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`PasswordChar`	published	Allows obfuscation of the displayed text, showing all characters as PasswordChar.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ReadOnly`	published	Indicates if the user is prevented from changing the value for the Text in the control.
`ShowHint`	published	Enables Hint display for the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`Text`	published	The text displayed and edited for the control.
`TextHint`	published	Default hint text shown when the Text property is empty for the control.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Events

`OnChange`	published	Event handler signalled when the text for the control is changed.
`OnClick`	published	Notification handler for mouse clicks.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnEditingDone`	published	Event handler signalled when editing is completed for the control.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnKeyDown`	published	Event handler signalled for key down keyboard events.
`OnKeyPress`	published	Event handler signalled for character data entered by the user.
`OnKeyUp`	published	Event handler signalled when a key up event has occurred for the control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.