BoundLabel

Qualified name: delphivcl.BoundLabel

class BoundLabel

Bases: Control

TBoundLabel is the type of a labeled edit control’s label. TBoundLabel implements the label of a labeled edit control. Unlike other label controls such as TLabel, TBoundLabel “belongs” to the labeled edit control (it is a subcomponent of the edit control). This means that the bound label’s Owner is the edit control rather than the form, and the edit control is responsible for loading and saving the bound label. Use the properties of TBoundLabel to specify how you want the labeled edit control’s label to appear. For example, you can use the Caption property to specify the text that appears in the label. You can use the Alignment and Layout properties to specify the placement of that caption within the label.

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.
Create	Creates a new TBoundLabel object.
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.
Anchors	Specifies how the control is anchored to its parent.
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.
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.
Font	Specifies the attributes of text written on or in the control.
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.
IsLabelModified	Embarcadero Technologies does not currently have any additional information.
LRDockWidth	Specifies the width of the control when it is docked horizontally.
Layout	<Delphi property Layout of type TBoundLabel at 21141D0CC60>
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 TBoundLabel at 21141D0CED0>
OnContextPopup	<Delphi property OnContextPopup of type TBoundLabel at 21141D0CFA0>
OnDblClick	<Delphi property OnDblClick of type TBoundLabel at 21141D0D070>
OnDragDrop	<Delphi property OnDragDrop of type TBoundLabel at 21141D0D140>
OnDragOver	<Delphi property OnDragOver of type TBoundLabel at 21141D0D210>
OnEndDock	<Delphi property OnEndDock of type TBoundLabel at 21141D0D2E0>
OnEndDrag	<Delphi property OnEndDrag of type TBoundLabel at 21141D0D3B0>
OnGesture	<Delphi property OnGesture of type TBoundLabel at 21141D0D480>
OnMouseActivate	<Delphi property OnMouseActivate of type TBoundLabel at 21141D0D550>
OnMouseDown	<Delphi property OnMouseDown of type TBoundLabel at 21141D0D620>
OnMouseMove	<Delphi property OnMouseMove of type TBoundLabel at 21141D0D6F0>
OnMouseUp	<Delphi property OnMouseUp of type TBoundLabel at 21141D0D7C0>
OnStartDock	<Delphi property OnStartDock of type TBoundLabel at 21141D0D890>
OnStartDrag	<Delphi property OnStartDrag of type TBoundLabel at 21141D0D960>
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 TBoundLabel at 21141D0C850>
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 TBoundLabel at 21141D0CB90>
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 TBoundLabel at 21141D0CD30>

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.

Create(AOwner: Component)

Creates a new TBoundLabel object. Do not create instances of TBoundLabel. Bound labels are instantiated by the labeled edit controls to which they belong. AOwner specifies the labeled edit control that acts as the bound label’s Owner.

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.

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

Height

Specifies the vertical size of the control in pixels. Use the Height property to read or change the height of the control.

Hide()

Hides the wrapped Control

Invalidate()

Completely repaint control.

IsLabelModified

Embarcadero Technologies does not currently have any additional information.

Layout

<Delphi property Layout of type TBoundLabel at 21141D0CC60>

Left

Specifies the horizontal coordinate of the left edge of a component relative to its parent. Use the Left property to determine where the left side of the control begins or to reposition the left side of the control. If the control is contained in another control, the Left and Top properties are relative to the parent control. If the control is contained directly by the form, the property values are relative to the form. For forms, the value of the Left property is relative to the screen in pixels.

OnClick

<Delphi property OnClick of type TBoundLabel at 21141D0CED0>

OnContextPopup

<Delphi property OnContextPopup of type TBoundLabel at 21141D0CFA0>

OnDblClick

<Delphi property OnDblClick of type TBoundLabel at 21141D0D070>

OnDragDrop

<Delphi property OnDragDrop of type TBoundLabel at 21141D0D140>

OnDragOver

<Delphi property OnDragOver of type TBoundLabel at 21141D0D210>

OnEndDock

<Delphi property OnEndDock of type TBoundLabel at 21141D0D2E0>

OnEndDrag

<Delphi property OnEndDrag of type TBoundLabel at 21141D0D3B0>

OnGesture

<Delphi property OnGesture of type TBoundLabel at 21141D0D480>

OnMouseActivate

<Delphi property OnMouseActivate of type TBoundLabel at 21141D0D550>

OnMouseDown

<Delphi property OnMouseDown of type TBoundLabel at 21141D0D620>

OnMouseMove

<Delphi property OnMouseMove of type TBoundLabel at 21141D0D6F0>

OnMouseUp

<Delphi property OnMouseUp of type TBoundLabel at 21141D0D7C0>

OnStartDock

<Delphi property OnStartDock of type TBoundLabel at 21141D0D890>

OnStartDrag

<Delphi property OnStartDrag of type TBoundLabel at 21141D0D960>

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 TBoundLabel at 21141D0C850>

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.

Top

Specifies the Y coordinate of the upper-left corner of a control, relative to its parent or containing control in pixels. Use Top to locate the top of the control or reposition the control to a different Y coordinate. The Top property, like the Left property, is the position of the control relative to its container. Thus, if a control is contained in a TPanel, the Left and Top properties are relative to the panel. If the control is contained directly by the form, it is relative to the form. For forms, the value of the Top property is relative to the screen in pixels.

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 TBoundLabel at 21141D0CB90>

Update()

Processes any pending paint messages immediately.

Width

Specifies the horizontal size of the control or form in pixels. Use the Width property to read or change the width of the control.

Note: For tab sheet controls, changing this property at run time has no effect.

WordWrap

<Delphi property WordWrap of type TBoundLabel at 21141D0CD30>