TCustomLabel class

In unit StdCtrls

Control used to show static text optionally using multiple lines.

Declaration

pascal

TCustomLabel = class(TGraphicControl)

Inheritance

Descends from it: TBoundLabel TDBText TLabel

Description

TCustomLabel is a TWinControl descendant which displays static text on a form. The value in the control is not editable visually, and can be used to label or describe another control or a container on the form. Since it cannot be edited, it is not allowed to receive the input focus. It can, however, be used to set focus to an associated control using an accelerator key defined in the Caption for the control.

TCustomLabel is the ancestor class for TLabel. Do not create instances of TCustomLabel; use the TLabel descendant.

Use TStaticText to display static text and respond to keyboard input directly in the control.

Properties

`Alignment`	protected	Horizontal text justification in the control (left- or right-justified, or centered).
`FocusControl`	protected	The control associated with the label and its accelerator key (AccelChar).
`Layout`	protected	Vertical alignment for control text (at the top, bottom, or center).
`ShowAccelChar`	protected	Underlines the character in the label that acts as the accelerator or short cut key.
`Transparent`	protected	Indicates whether the viewer can see through the control.
`WordWrap`	protected	Allows the caption to wrap to multiple lines when it is wider than a specified length.
`WordWrapLength`	protected	Defines the maximum pixel of the label caption at which the text is wrapped to a new line.
`OptimalFill`	protected	If True, the font size is adjusted for optimal fill of the available space.
`AutoSize`	public	Enables or disables auto-sizing the control to its content.
`Color`	public	Contains the color used for the background on the control.

Methods

`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`CanTab`	protected	Always False, since you cannot tab into a label control.
`DoDrawText`	protected	Performs actions needed to draw the text of the label or to calculate its size.
`HasMultiLine`	protected	Checks for CR or LF characters in the label text for the control.
`CalculatePreferredSize`	protected	Calculates the preferred size of the control based on size restrictions such as anchoring, aligning, constraints and the WordWrapLength parameter.
`CalculateSize`	protected	Gets the height and width needed for the label text.
`CalcWordWrapLength`	protected	Calculates the maximum length of a word-wrapped line.
`DoAutoAdjustLayout`	protected	High-DPI related helper procedure, overridden to adjust the value of WordWrapLength when the monitor's pixels-per-inch value changes.
`DoAutoSize`	protected	For internal use only; call AdjustSize instead.
`DialogChar`	protected	Handles an accelerator key for the control.
`TextChanged`	protected	Performs actions when the CM_TEXTCHANGED message is handled for the control.
`DoSetBounds`	protected	Performs a bounds change for the control.
`FontChanged`	protected	Implements the OnChange event handler for the Font in the control.
`GetControlClassDefaultSize`	protected	Gets the size used for new instances of the class.
`WMActivate`	protected	Defers the focus to the control in the FocusControl property.
`Notification`	protected	Handles a notification that a component used in the control has been added or removed.
`GetLabelText`	protected	Returns the string value in the Caption for the control.
`GetTransparent`	protected	Gets the value for the Transparent property.
`SetAlign`	protected	Setter method for the Align property. Is overridden here to recalculate word-wrapping if required.
`SetFocusControl`	protected	Sets the value for the FocusControl property.
`SetLayout`	protected	Sets the value for the Layout property.
`SetShowAccelChar`	protected	Sets the value for the ShowAccelChar property.
`SetTransparent`	protected	Sets the value for the Transparent property.
`SetWordWrap`	protected	Sets the value for the WordWrap property.
`Loaded`	protected	Performs actions when the component has been loaded using LCL component streaming.
`UpdateSize`	protected	Adjusts the size for the control based on settings in AutoSize and OptimalFill.
`Create`	public	Constructor for the class instance.
`CalcFittingFontHeight`	public	Calculates the font height needed to fill the specified width and height constraints.
`AdjustFontForOptimalFill`	public	Adjusts the font height for the control text to fill the available client area.
`Paint`	public	Performs actions needed to draw the control on its Canvas.
`SetBounds`	public	Sets the bounds (Top, Left, Width, Height) for the control.