TCustomLabeledEdit class

In unit ExtCtrls

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

Declaration

pascal

TCustomLabeledEdit = class(TCustomEdit)

Inheritance

Descends from it: TLabeledEdit

Description

TCustomLabeledEdit is a TCustomEdit descendant which defines an edit control with a label bound to the control. TCustomLabeledEdit is the base type for TLabeledEdit.

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

`EditLabel`	public	EditLabel - the label attached to the edit box.
`LabelPosition`	public	Edge on the edge control where the bound label is aligned.
`LabelSpacing`	public	Number of pixels between the control and its bound label.

Methods

`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`SetParent`	protected	Sets the value for the Parent property.
`SetName`	protected	Sets the value for the Name property and the Caption in the label.
`Loaded`	protected	Performs actions needed when the component has finished loading in the LCL streaming mechanism.
`DoPositionLabel`	protected	DoPositionLabel - perform the code for positioning the label.
`Notification`	protected	Handles a notification when a component is added to or removed from the control.
`CMBiDiModeChanged`	protected	Handles the CM_BIDIMODECHANGED control message for the control.
`CMVisibleChanged`	protected	Handles Focus changes, and forces UpdateControlState.
`CMEnabledChanged`	protected	Handler signalled when the Enabled property has been changed.
`CreateInternalLabel`	protected	CreateInternalLabel - method for internally creating label.
`Create`	public	Constructor for the class instance.