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

# TBoundLabel

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

Implements a label bound to another control.

## Declaration

Source position: extctrls.pp line 975

`type TBoundLabel = class(TCustomLabel)`
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`property FocusControl: TWinControl;` |  | Control focused when the accelerator key for the label is detected.
`published`
`property Alignment: TAlignment;` |  | Horizontal alignment for the Caption displayed on the bound label.
`property AnchorSideLeft: TAnchorSide; [s]` |  | Contains anchor alignment information used to position the control with its left edge anchored to another control.
`property AnchorSideTop: TAnchorSide; [s]` |  | Contains anchor alignment information used to position the control with its top edge anchored to another control.
`property AnchorSideRight: TAnchorSide; [s]` |  | Contains anchor alignment information used to position the control with its right edge anchored to another control.
`property AnchorSideBottom: TAnchorSide; [s]` |  | Contains anchor alignment information used to position the control with its bottom edge anchored to another control.
`property Left: Integer; [s]` |  | The client coordinate with the left edge for the control.
`property Top: Integer; [s]` |  | The client coordinate for the top edge of the control.
`property Caption: TCaption;` |  | The text displayed for the control.
`property Color: TColor;` |  | The background color for the control.
`property DragCursor: TCursor;` |  | The cursor shape shown during a drag operation.
`property DragMode: TDragMode;` |  | Determines how a drag operation is started for the control.
`property Height: Integer;` |  | The vertical size for the control.
`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 Font: TFont;` |  | The font to be used for text display in this control.
`property PopupMenu: TPopupMenu;` |  | A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`property ShowAccelChar: Boolean;` |  | Underlines the character in the label that acts as the accelerator or short cut key.
`property ShowHint: Boolean;` |  | Enables Hint display for the control.
`property Layout: TTextLayout;` |  | Specifies the vertical alignment for the Caption text on the label.
`property WordWrap: Boolean;` |  | Allows the caption to wrap to multiple lines when it is longer than the available Width.
`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 OnStartDrag: TStartDragEvent;` |  | Event handler signalled for the start of a dragging operation.
`end;`

## Inheritance

`TBoundLabel` |  | Implements a label bound to another control.
`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

TBoundLabel is a TCustomLabel descendant which implements a label bound to another control. TBoundLabel is the type used to implement the EditLabel property in TCustomLabeledEdit and TLabeledEdit.

Use Caption to assign the text displayed in the label. An accelerator key can be specified in Caption to activate the control to which it is bound.

The FocusControl property specifies the control given focus when a Dialog accelerator key or other input event in the class is handled. The AnchorSide* properties indicate the edge anchored to the FocusControl.

Use Alignment and Layout to specify the horizontal and vertical alignment used for the label Caption. Values in these properties may be ignored (in the implementing control) if they do not apply to the position for the bound label relative to its associated control. Alignment does not apply when the label is positioned on the left or right of its associated control. Layout does not apply when the label is positioned above or below its associated control.

## Version info

Modified in LCL version 4.0 to include the Alignment and Layout properties.

## See also

TBoundLabel.Alignment |  | Horizontal alignment for the Caption displayed on the bound label.
TBoundLabel.Layout |  | Specifies the vertical alignment for the Caption text on the label.
TBoundLabel.FocusControl |  | Control focused when the accelerator key for the label is detected.
TBoundLabel.Caption |  | The text displayed for the control.
TCustomLabeledEdit.EditLabel |  | EditLabel - the label attached to the edit box.
TCustomLabeledEdit.LabelPosition |  | Edge on the edge control where the bound label is aligned.
TLabeledEdit |  | Implements an edit control with a label bound to the control.
TCustomLabel |  | Control used to show static text optionally using multiple lines.