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

TLabel

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

Control used to display static text, possibly in multiple lines.

Declaration

Source position: stdctrls.pp line 1622

type TLabel = class(TCustomLabel)

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Alignment: TAlignment;

  

Horizontal text justification in the control (centered, left- or right-justified).

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoSize: Boolean;

  

Enables or disables auto-sizing for the control to its content.

  property BidiMode: TBiDiMode;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property Caption: TCaption;

  

The text describing the control to the user.

  property Color: TColor;

  

Sets the color used for the background in the control.

  property Constraints: TSizeConstraints;

  

The minimum and maximum Width and Height for the control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragKind: TDragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property FocusControl: TWinControl;

  

The control associated with the label and its accelerator key (AccelChar).

  property Font: TFont;

  

The font to be used for text display in this control.

  property Layout: TTextLayout;

  

Vertical alignment for control text (at the top, bottom, or center).

  property ParentBidiMode: Boolean;

  

Allows to use the BiDiMode settings in the Parent control. Default is true.

  property ParentColor: Boolean;

  

Uses the color from the parent control, when enabled.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  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 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 the Hint display.

  property Transparent: Boolean;

  

Indicates whether the viewer can see through the control.

  property Visible: Boolean;

  

Allows the control, and all of its children, to be displayed or hidden.

  property WordWrap: Boolean;

  

Allows the caption to wrap into multiple lines when it is too long for the available Width.

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnMouseWheelHorz: TMouseWheelEvent;

  

Event handler for horizontal movements of the mouse wheel.

  property OnMouseWheelLeft: TMouseWheelUpDownEvent;

  

Event handler for left movements of the mouse wheel.

  property OnMouseWheelRight: TMouseWheelUpDownEvent;

  

Event handler for right movements of the mouse wheel.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OptimalFill: Boolean;

  

If True, the font size is adjusted for optimal fill of the available space.

end;

Inheritance

TLabel

  

Control used to display static text, possibly in multiple lines.

|

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

TLabel is a TCustomLabel descendant which implements a control to display static text on a form. The value in the control is not editable visually, and can be used to label or describe another control on the form or a container. 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.

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

See also

HowToUseStdCtrls

  

How to use StdCtrls, ComCtrls or ExtCtrls.

TStaticText

  

Control to display a text value which does not change.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.