Label#

Qualified name: delphivcl.Label

class Label#

Bases: Control

TLabel is a nonwindowed control that displays text on a form. Use TLabel to add text that the user cannot edit on a form. This text can be used to label another control, and can set focus to that control when the user types an accelerator key. The Caption property can be used to define an accelerator key to a label control. Because TLabel is not a descendant of TWinControl, it does not have its own window and cannot receive direct input from the keyboard. To add an object to a form that can respond to keyboard input (other than setting focus to another object when an accelerator key is typed) in addition to displaying text, use TStaticText. To add an object to a form that displays text that a user can scroll or edit, use TEdit.

Methods

`BringToFront`	Puts the control in front of all other controls in its parent control.
`ClientToScreen`	Translates a given point from client area coordinates to global screen coordinates.
`Hide`	Hides the wrapped Control
`Invalidate`	Completely repaint control.
`Repaint`	Forces the control to repaint its image on the screen.
`ScreenToClient`	Converts the screen coordinates of a specified point on the screen to client coordinates.
`SendToBack`	Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.
`SetBounds`	Sets the Left, Top, Width, and Height properties all at once.
`Show`	Shows the wrapped Control
`Update`	Processes any pending paint messages immediately.

Attributes

`Action`	Specifies the action associated with the control.
`Align`	Determines how the control aligns within its container (parent control).
`AlignWithMargins`	Specifies whether a control should be constrained by margins.
`Alignment`	<Delphi property Alignment of type TLabel at 211413F61D0>
`Anchors`	Specifies how the control is anchored to its parent.
`AutoSize`	Specifies whether the control sizes itself automatically to accommodate its contents.
`BiDiMode`	Specifies the bidirectional mode for the control.
`BoundsRect`	Specifies the bounding rectangle of the control, expressed in the coordinate system of the parent control.
`Caption`	Specifies a text string that identifies the control to the user.
`ClassName`	Returns the TObject.ClassName
`ClientHeight`	Specifies the height of the control's client area in pixels.
`ClientOrigin`	Specifies the screen coordinates (in pixels) of the upper-left corner of a control's client area.
`ClientRect`	Specifies the size of a control's client area in pixels.
`ClientWidth`	Specifies the horizontal size of the control's client area in pixels.
`Color`	Specifies the background color of the control.
`ComObject`	Specifies the interface reference implemented by the component.
`ComponentCount`	Indicates the number of components owned by the component.
`ComponentIndex`	Indicates the position of the component in its owner's Components property array.
`ComponentState`	Describes the current state of the component, indicating when a component needs to avoid certain actions.
`ComponentStyle`	Governs the behavior of the component.
`Components`	<Delphi indexed property Components of type TComponent at 21141642500>
`Constraints`	Specifies the size constraints for the control.
`ControlState`	Specifies the current state of a control at run time.
`ControlStyle`	Determines style characteristics of the control.
`CurrentPPI`	Embarcadero Technologies does not currently have any additional information.
`Cursor`	Specifies the image used to represent the mouse pointer when it passes into the region covered by the control.
`CustomHint`	CustomHint is a custom hint for the control.
`DesignInfo`	Contains information used by the Form designer.
`DockOrientation`	DockOrientation specifies how the control is docked relative to other controls docked in the same parent.
`DragCursor`	Specifies the image used to represent the mouse pointer when the control is being dragged.
`DragKind`	Specifies whether the control is being dragged normally or for docking.
`DragMode`	Specifies how the control initiates drag-and-drop or drag-and-dock operations.
`EllipsisPosition`	<Delphi property EllipsisPosition of type TLabel at 211413F69F0>
`Enabled`	Controls whether the control responds to mouse, keyboard, and timer events.
`ExplicitHeight`	Specifies the explicit vertical size of the control in pixels.
`ExplicitLeft`	Specifies the explicit horizontal pixel coordinate of the left edge of a component relative to its parent.
`ExplicitTop`	Specifies the explicit vertical pixel coordinate of the top edge of a component relative to its parent.
`ExplicitWidth`	Specifies the explicit horizontal size of the control in pixels.
`Floating`	Specifies whether the control is floating.
`FloatingDockSiteClass`	Specifies the class of the temporary control that hosts the control when it is floating.
`FocusControl`	<Delphi property FocusControl of type TLabel at 211413F6B90>
`Font`	Specifies the attributes of text written on or in the control.
`GlowSize`	<Delphi property GlowSize of type TLabel at 211413F6D30>
`Height`	Specifies the vertical size of the control in pixels.
`HelpContext`	The HelpContext property contains the numeric context ID that identifies the Help topic for the control.
`HelpKeyword`	The HelpKeyword property contains the keyword string that identifies the Help topic for the control.
`HelpType`	Specifies whether the control's context-sensitive Help topic is identified by a context ID or by keyword.
`Hint`	Hint contains the text string that appears when the user moves the mouse over the control.
`HostDockSite`	Specifies the control in which the control is docked.
`LRDockWidth`	Specifies the width of the control when it is docked horizontally.
`Layout`	<Delphi property Layout of type TLabel at 211413F7550>
`Left`	Specifies the horizontal coordinate of the left edge of a component relative to its parent.
`Margins`	Specifies the margins of the control.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`OnClick`	<Delphi property OnClick of type TLabel at 211413F7960>
`OnContextPopup`	<Delphi property OnContextPopup of type TLabel at 211413F7A30>
`OnDblClick`	<Delphi property OnDblClick of type TLabel at 211413F7B00>
`OnDragDrop`	<Delphi property OnDragDrop of type TLabel at 211413F7BD0>
`OnDragOver`	<Delphi property OnDragOver of type TLabel at 211413F7CA0>
`OnEndDock`	<Delphi property OnEndDock of type TLabel at 211413F7D70>
`OnEndDrag`	<Delphi property OnEndDrag of type TLabel at 211413F7E40>
`OnGesture`	<Delphi property OnGesture of type TLabel at 211413F7F10>
`OnMouseActivate`	<Delphi property OnMouseActivate of type TLabel at 211413F7FE0>
`OnMouseDown`	<Delphi property OnMouseDown of type TLabel at 211413F80B0>
`OnMouseEnter`	<Delphi property OnMouseEnter of type TLabel at 211413F8320>
`OnMouseLeave`	<Delphi property OnMouseLeave of type TLabel at 211413F83F0>
`OnMouseMove`	<Delphi property OnMouseMove of type TLabel at 211413F8180>
`OnMouseUp`	<Delphi property OnMouseUp of type TLabel at 211413F8250>
`OnStartDock`	<Delphi property OnStartDock of type TLabel at 211413F84C0>
`OnStartDrag`	<Delphi property OnStartDrag of type TLabel at 211413F8590>
`Owner`	Indicates the component that is responsible for streaming and freeing this component.
`Parent`	Returns/Sets the Control Parent
`ParentBiDiMode`	Specifies whether the control uses its parent's BiDiMode.
`ParentColor`	Specifies where a control looks for its color information.
`ParentCustomHint`	Specifies where a control looks for its custom hint.
`ParentFont`	Specifies where a control looks for its font information.
`ParentShowHint`	Specifies where a control looks to find out if its Help Hint should be shown.
`PopupMenu`	Specifies the pop-up menu associated with the control.
`ScaleFactor`	Embarcadero Technologies does not currently have any additional information.
`ShowAccelChar`	<Delphi property ShowAccelChar of type TLabel at 211413F7210>
`ShowHint`	ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control.
`StyleElements`	Specifies the style elements that are used by the control.
`StyleName`	Embarcadero Technologies does not currently have any additional information.
`TBDockHeight`	Specifies the height of the control when it is docked vertically.
`Tag`	Stores a NativeInt integral value as a part of a component.
`Top`	Specifies the Y coordinate of the upper-left corner of a control, relative to its parent or containing control in pixels.
`Touch`	Specifies the touch manager component associated with the control.
`Transparent`	<Delphi property Transparent of type TLabel at 211413F7480>
`UndockHeight`	Specifies the height of the control when it is floating.
`UndockWidth`	Specifies the width of the control when it is floating.
`VCLComObject`	Represents information used internally by components that support COM.
`Visible`	Specifies whether the component appears onscreen.
`Width`	Specifies the horizontal size of the control or form in pixels.
`WindowProc`	<Delphi property WindowProc of type TControl at 211418EC1C0>
`WordWrap`	<Delphi property WordWrap of type TLabel at 211413F76F0>

Align#

Determines how the control aligns within its container (parent control). Use Align to align a control to the top, bottom, left, or right of a form or panel and have it remain there even if the size of the form, panel, or component that contains the control changes. When the parent is resized, an aligned control also resizes so that it continues to span the top, bottom, left, or right edge of the parent. For example, to use a panel component with various controls on it as a tool palette, change the panel’s Align value to alLeft. The value of alLeft for the Align property of the panel guarantees that the tool palette remains on the left side of the form and always equals the client height of the form. The default value of Align is alNone, which means a control remains where it is positioned on a form or panel.

Tip: If Align is set to alClient, the control fills the entire client area so that it is impossible to select the parent form by clicking it. In this case, select the parent by selecting the control on the form and pressing ESC, or by using the Object Inspector. Any number of child components within a single parent can have the same Align value, in which case they stack up along the edge of the parent. The child controls stack up in z-order. To adjust the order in which the controls stack up, drag the controls into their desired positions.

Note: To cause a control to maintain a specified relationship with an edge of its parent, but not necessarily lie along one edge of the parent, use the Anchors property instead.

Alignment#: <Delphi property Alignment of type TLabel at 211413F61D0>

Anchors#

Specifies how the control is anchored to its parent. Use Anchors to ensure that a control maintains its current position relative to an edge of its parent, even if the parent is resized. When its parent is resized, the control holds its position relative to the edges to which it is anchored. If a control is anchored to opposite edges of its parent, the control stretches when its parent is resized. For example, if a control has its Anchors property set to [akLeft, akRight], the control stretches when the width of its parent changes. Anchors is enforced only when the parent is resized. Thus, for example, if a control is anchored to opposite edges of a form at design time and the form is created in a maximized state, the control is not stretched because the form is not resized after the control is created.

Note: If a control should maintain contact with three edges of its parent (hugging one side of the parent and stretching the length of that side), use the Align property instead. Unlike Anchors, Align allows controls to adjust to changes in the size of other aligned sibling controls as well as changes to the parent’s size.

AutoSize#: Specifies whether the control sizes itself automatically to accommodate its contents. Use AutoSize to specify whether the control sizes itself automatically. When AutoSize is True, the control resizes automatically when its contents change. By default, AutoSize is False.

BiDiMode#: Specifies the bidirectional mode for the control. Use BiDiMode to enable the control to adjust its appearance and behavior automatically when the application runs in a locale that reads from right to left instead of left to right. The bidirectional mode controls the reading order for the text, the placement of the vertical scroll bar, and whether the alignment is changed. Alignment does not change for controls that are known to contain number, date, time, or currency values. For example, with data-aware controls, the alignment does not change for the following field types: ftSmallint, ftInteger, ftWord, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftAutoInc.

BringToFront()#: Puts the control in front of all other controls in its parent control.

Caption#

Specifies a text string that identifies the control to the user. Use Caption to specify the text string that labels the control. To underline a character in a Caption that labels a component, include an ampersand (&) before the character. This type of character is called an accelerator character. The user can then select the component by pressing ALT while typing the underlined character. To display an ampersand character in the caption, use two ampersands (&&).

Notes: Controls that display text use either the Caption property or the Text property to specify the text value. The property that is used depends on the type of control. In general, Caption is used for text that appears as a window title or label, while Text is used for text that appears as the content of a control. For some controls, such as TButton, it is not possible to change the color of the Caption. If you want to change the color of a button caption, you should use an alternate button type such as TSpeedButton or TBitBtn instead of TButton. With either TSpeedButton or TBitBtn, you can change the color of the Caption property by using the Font property. For TLinkLabel, an HTML tag is declared inside the Caption property either at run time or at design time.

ClientToScreen()#: Translates a given point from client area coordinates to global screen coordinates.

Color#: Specifies the background color of the control. Use Color to read or change the background color of the control. If a control’s Vcl.Controls.TControl.ParentColor property is True, then changing the Color property of the control’s parent automatically changes the Color property of the control. When the value of the Color property is changed, the control’s ParentColor property is automatically set to False. The Color of a TLabel is always the color of the background unless you set TLabel.Transparent to False.

Constraints#

Specifies the size constraints for the control. Use Constraints to specify the minimum and maximum width and height of the control. When Constraints contains maximum or minimum values, the control cannot be resized to violate those constraints.

Note: Constraints apply to the height of the form. However, the height of the form depends on how large Windows makes the title bar. For example, Windows XP uses much larger title bars than other windowing systems. To work around this, note the ClientHeight when you design your form and set the constraints in the FormCreate event. In the following example, ClientHeight is represented by x: Constraints.MinHeight?:= x + Height - ClientHeight. Warning: Do not set up constraints that conflict with the value of the Align or Anchors property. When these properties conflict, the response of the control to resize attempts is not well-defined.

DragCursor#

Specifies the image used to represent the mouse pointer when the control is being dragged. Use the DragCursor property to change the cursor image presented when the control is being dragged.

Note: To make a custom cursor available for the DragCursor property, see the Cursor property.

DragKind#: Specifies whether the control is being dragged normally or for docking. Use DragKind to get or set whether the control participates in drag-and-drop operations or drag-and-dock operations.

DragMode#: Specifies how the control initiates drag-and-drop or drag-and-dock operations. Use DragMode to control when the user can drag the control. Disable the drag-and-drop or drag-and-dock capability at run time by setting the DragMode property value to dmManual. Enable automatic dragging by setting DragMode to dmAutomatic. For more information about dmManual and dmAutomatic, see TDragMode.

EllipsisPosition#: <Delphi property EllipsisPosition of type TLabel at 211413F69F0>

Enabled#

Controls whether the control responds to mouse, keyboard, and timer events. Use Enabled to change the availability of the control to the user. To disable a control, set Enabled to False. Some disabled controls appear dimmed (for example: buttons, check boxes, labels), while others (container controls) simply lose their functionality without changing their appearance. If Enabled is set to False, the control ignores mouse, keyboard, and timer events. To re-enable a control, set Enabled to True.

Note: This property applies to all TControl descendants.

FocusControl#: <Delphi property FocusControl of type TLabel at 211413F6B90>

Font#

Specifies the attributes of text written on or in the control. To change to a new font, specify a new TFont object. To modify a font, change the value of the Charset, Color, Height, Name , Pitch, Size, or Style of the TFont object.

Note: Changing the font color of the Caption is not supported for some controls (such as TButton). In most cases, there is an alternate control you can use whose Font property will change the color of the caption or text (such as TBitBtn or TSpeedButton).

GlowSize#: <Delphi property GlowSize of type TLabel at 211413F6D30>

Hide()#: Hides the wrapped Control

Invalidate()#: Completely repaint control.

Layout#: <Delphi property Layout of type TLabel at 211413F7550>

OnClick#: <Delphi property OnClick of type TLabel at 211413F7960>

OnContextPopup#: <Delphi property OnContextPopup of type TLabel at 211413F7A30>

OnDblClick#: <Delphi property OnDblClick of type TLabel at 211413F7B00>

OnDragDrop#: <Delphi property OnDragDrop of type TLabel at 211413F7BD0>

OnDragOver#: <Delphi property OnDragOver of type TLabel at 211413F7CA0>

OnEndDock#: <Delphi property OnEndDock of type TLabel at 211413F7D70>

OnEndDrag#: <Delphi property OnEndDrag of type TLabel at 211413F7E40>

OnGesture#: <Delphi property OnGesture of type TLabel at 211413F7F10>

OnMouseActivate#: <Delphi property OnMouseActivate of type TLabel at 211413F7FE0>

OnMouseDown#: <Delphi property OnMouseDown of type TLabel at 211413F80B0>

OnMouseEnter#: <Delphi property OnMouseEnter of type TLabel at 211413F8320>

OnMouseLeave#: <Delphi property OnMouseLeave of type TLabel at 211413F83F0>

OnMouseMove#: <Delphi property OnMouseMove of type TLabel at 211413F8180>

OnMouseUp#: <Delphi property OnMouseUp of type TLabel at 211413F8250>

OnStartDock#: <Delphi property OnStartDock of type TLabel at 211413F84C0>

OnStartDrag#: <Delphi property OnStartDrag of type TLabel at 211413F8590>

Parent#: Returns/Sets the Control Parent

ParentBiDiMode#: Specifies whether the control uses its parent’s BiDiMode. Use ParentBiDiMode to get or set whether the control uses its parent’s BiDiMode. When ParentBiDiMode is true, the control’s BiDiMode property is always equal to that of its parent. If ParentBiDiMode is false, the control uses its own BiDiMode property. Set ParentBiDiMode to true for all controls in a form to ensure that the entire user interface adjusts to Middle Eastern locales in a uniform manner. When the value of the control’s BiDiMode property changes, ParentBiDiMode becomes false automatically.

ParentColor#: Specifies where a control looks for its color information. To have a control use the same color as its parent control, set ParentColor to True. If ParentColor is False, the control uses its own Color property. Set ParentColor to True for all controls to ensure that all the controls on a form have a uniform appearance. For example, if ParentColor is True for all controls in a form, changing the background color of the form to gray causes all the controls on the form to also have a gray background. When the value of a control’s Color property changes, ParentColor becomes False automatically.

ParentFont#: Specifies where a control looks for its font information. To have a control use the same font as its parent control, set ParentFont to true. If ParentFont is false, the control uses its own Font property. Many controls default ParentFont to true so that all the controls in a form or other container present a uniform appearance. When the value of a control’s Font property changes, ParentFont becomes false automatically. When ParentFont is true for a form, the form uses the default font. Currently, the default font is Tahoma 8 pt.

ParentShowHint#

Specifies where a control looks to find out if its Help Hint should be shown. Use ParentShowHint to ensure that all the controls on a form either uniformly show their Help Hints or uniformly do not show them. If ParentShowHint is True, the control uses the ShowHint property value of its parent. If ParentShowHint is False, the control uses the value of its own ShowHint property. To provide Help Hints only for selected controls on a form, set the ShowHint property for those controls that should have Help Hints to True, and ParentShowHint becomes False automatically.

Note: Enable or disable all Help Hints for the entire application using the ShowHint property of the application object.

PopupMenu#: Specifies the pop-up menu associated with the control. Assign a value to PopupMenu to make a pop-up menu appear when the user selects the control and clicks the right mouse button. If the TPopupMenu’s AutoPopup property is True, the pop-up menu appears automatically. If the menu’s AutoPopup property is False, display the menu with a call to its Popup method from the control’s OnContextPopup event handler.

Repaint()#: Forces the control to repaint its image on the screen.

ScreenToClient()#: Converts the screen coordinates of a specified point on the screen to client coordinates.

SendToBack()#: Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.

SetBounds(Left, Top, Width, Height)#: Sets the Left, Top, Width, and Height properties all at once.

Show()#: Shows the wrapped Control

ShowAccelChar#: <Delphi property ShowAccelChar of type TLabel at 211413F7210>

ShowHint#

ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control. ShowHint determines whether the Help Hint appears for the control. The Help Hint is the value of the TControl.Hint property. The Help Hint appears in a box just beneath the control when the mouse pointer moves over the control. To enable Help Hints for a particular control, two conditions must be satisfied:

The application’s ShowHint property must be True. Either the control’s own ShowHint property must be True, or the control’s ParentShowHint property must be True and its parent’s ShowHint property must be True. For example, imagine a check box within a group box. If the ShowHint property of the group box is True and the ParentShowHint property of the check box is True, but the ShowHint property of the check box is False, the check box still displays its Help Hint. Changing the ShowHint value automatically sets the ParentShowHint property to False.

StyleElements#: Specifies the style elements that are used by the control. Use StyleElements to customize the style of the control. If a custom style is enabled, you can enable or disable style elements in the control. StyleElements is a set of values that specify which elements of the current style are to be applied to this control. By default, all the elements of the style are enabled.

StyleName#: Embarcadero Technologies does not currently have any additional information.

Touch#

Specifies the touch manager component associated with the control. Use the Touch property to access gesturing options associated with a control. Touch specifies a class of type TTouchManager. Touch is used to:

Associate a TGestureManager. (TGestureManager manages all the gestures that can be used by the control.) Select the standard, interactive, or custom gestures to associate with the control. (You can also connect each gesture to an action; see Assigning Actions to Gestures.) Specify a set of options for interactive or tablet gestures.

Transparent#: <Delphi property Transparent of type TLabel at 211413F7480>

Update()#: Processes any pending paint messages immediately.

Visible#: Specifies whether the component appears onscreen. Use the Visible property to control the visibility of the control at run time. If Visible is True, the control appears. If Visible is False, the control is not visible. Calling the Show method sets the control’s Visible property to True. Calling the Hide method sets it to False. For TCustomForm descendants, the Show and ShowModal methods set Visible to True and bring the form to the front of all open windows. For TTabSheet descendants, Visible does not control the visibility of the control at run time. For more information, see the description of the TabVisible property.

WordWrap#: <Delphi property WordWrap of type TLabel at 211413F76F0>