TBoundLabel class

In unit ExtCtrls

Implements a label bound to another control.

Declaration

pascal

TBoundLabel = class(TCustomLabel)

Inheritance

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.

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

Properties

`FocusControl`	public	Control focused when the accelerator key for the label is detected.
`Alignment`	published	Horizontal alignment for the Caption displayed on the bound label.
`AnchorSideLeft`	published	Contains anchor alignment information used to position the control with its left edge anchored to another control.
`AnchorSideTop`	published	Contains anchor alignment information used to position the control with its top edge anchored to another control.
`AnchorSideRight`	published	Contains anchor alignment information used to position the control with its right edge anchored to another control.
`AnchorSideBottom`	published	Contains anchor alignment information used to position the control with its bottom edge anchored to another control.
`Left`	published	The client coordinate with the left edge for the control.
`Top`	published	The client coordinate for the top edge of the control.
`Caption`	published	The text displayed for the control.
`Color`	published	The background color for the control.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragMode`	published	Determines how a drag operation is started for the control.
`Height`	published	The vertical size for the control.
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`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.
`Font`	published	The font to be used for text display in this control.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ShowAccelChar`	published	Underlines the character in the label that acts as the accelerator or short cut key.
`ShowHint`	published	Enables Hint display for the control.
`Layout`	published	Specifies the vertical alignment for the Caption text on the label.
`WordWrap`	published	Allows the caption to wrap to multiple lines when it is wider than a specified length.

Methods

Create public Constructor for the class instance.

Events

`OnClick`	published	Notification handler for mouse clicks.
`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.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`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.