Navigation: TextEd > Extension and Scripts > Visual components >

TLabel

 

 

 

TLabel is a nonwindowed control that displays text on a form. Use TLabel to add text to 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.

 

In some examples we assume a label has been created and is named "Label1".

 

TLabel Label1 = TLabel.Create(form);

 


Properties



 

property TAlign Align;

Determines how the control aligns within its container (parent control).

 

enum TAlign {

  alNone,

  alTop,

  alBottom,

  alLeft,

  alRight,

  alClient,

  alCustom

};

 

Ex. Label1.Align = alNone;


 

property TLeftRight Alignment;

Controls the horizontal placement of the text within the label. Set Alignment to specify how the text of the label is justified within the ClientRect of the label control.

The effect of the Alignment property is more obvious if the WordWrap property is true and the label includes more than one line of text.  

 

taLeftJustify   - This is the default value. Text is displayed from the left edge of the label.

taRightJustify  - The text is placed to the right of the label area.

taCenter        - Text is placed at the center of the label.


 

property Bool AlignWithMargins;

Indicates whether a control should be constrained by margins. If AlignWithMargins is true, use the Margins property of the control to govern the spacing relative to other controls that are aligned with this one.


 

property TAnchors Anchors;

Specifies how the control is anchored to its parent.

 

enum TAnchorKind {

  akLeft,

  akTop,

  akRight,

  akBottom

};


Ex. Label1.Anchors = akLeft + akTop;


 

property Bool AutoSize;

Determines whether the size of the label automatically resizes to accommodate the text.

Use AutoSize to make the label adjust its size automatically. When AutoSize is false, the label is fixed in size. When AutoSize is true, the size of the label readjusts whenever the text changes.


 

property String Caption;

Specifies a text string that identifies the control to the user.  It can be the text label of a radio button or the title text in a form. To underline a character in a Caption, include an ampersand (&) before the character.


 

property TColor Color;

Specifies the background color of the control. The color value can be an hexadecimal or a color constant.

 

Defined color constants are:

clAqua, clBlack, clBlue, clCream, clDkGray, clFuchsia, clGray, clGreen, clLime, clLtGray, clMaroon, clMedGray, clMoneyGreen, clNavy, clOlive, clPurple, clRed, clSilver, clSkyBlue, clTeal, clWhite, clYellow.


 

Defined system color constants:

clNone                     White on Windows 9x, Black on NT.

clScrollBar                Current color for the of scroll bar track.

clBackground               Current background color of the Windows desktop

clActiveCaption            Current color of the title bar of the active window

clInactiveCaption          Current color of the title bar of inactive windows

clMenu                     Current background color of menus

clWindow                   Current background color of windows

clWindowFrame              Current color of window frames

clMenuText                 Current color of text on menus

clWindowText               Current color of text in windows

clCaptionText              Current color of the text on the title bar of the active window

clActiveBorder             Current border color of the active window

clInactiveBorder           Current border color of inactive windows

clAppWorkSpace             Current color of the application workspace

clHighlight                Current background color of selected text

clHightlightText           Current color of selected text

clBtnFace                  Current color of a button face

clBtnShadow                Current color of a shadow cast by a button

clGrayText                 Current color of text that is dimmed

clBtnText                  Current color of text on a button

clInactiveCaptionText      Current color of the text on the title bar of an inactive window

clBtnHighlight             Current color of the highlighting on a button

cl3DDkShadow               Windows 95 or NT 4.0 only: Dark shadow for three-dimensional display elements

cl3DLight                  Windows 95 or NT 4.0 only: Light color for three-dimensional display elements (for edges facing the light source)

clInfoText                 Windows 95 or NT 4.0 only: Text color for tool tip controls

clInfoBk                   Windows 95 or NT 4.0 only: Background color for tool tip controls

clGradientActiveCaption    Windows 98 or Windows 2000: Right side color in the color gradient of an active window's title bar.

clActiveCaption            specifies the left side color.

clGradientInactiveCaption  Windows 98 or Windows 2000: Right side color in the color gradient of an inactive window's title bar. clInactiveCaption          specifies the left side color.

clDefault                  The default color for the control to which the color is assigned.


Ex. Label1.Color = 0x0000FF00;

Ex. Label1.Color = clGreen;


 

property Bool Enabled;

Controls whether the control responds to mouse, keyboard, and timer events.


 

property TFont Font;

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

 

Ex.

Label1.Font.Size = 12;

Label1.Font.Color = clRed;

Label1.Font.Style = fsBold + fsItalic;



 

property int Height;

Specifies the vertical size of the control in pixels.


Ex. Label1.Height = 16;


 

property String Hint;

Contains the text string that can appear when the user moves the mouse over the control.


 

property int Left;

Specifies the horizontal coordinate of the left edge of a component relative to its parent.


 

property TMargins Margins;

Specifies the margins for the control. TMargins help define the relative position between components on a form, and between the edges of the form and the component. For example, when you set a left margin for a component to 10 pixels, the component will not come closer than 10 pixels to the edge of the container, or to another component on the left edge. The number of pixels by which two components are separated is the sum of the pixels of both components.

TMargins have the class members top, bottom, left and right.


Ex. Label1.Margins.Left = 10;


 

property String Name;

Specifies the name of the component as referenced in code.


 

property TWinControl Parent;

Use the Parent property to get or set the parent of this control. The parent of a control is the control that contains the control. For example, if an application includes three radio buttons in a group box, the group box is the parent of the three radio buttons, and the radio buttons are the child controls of the group box.

 

Ex.

TLabel Label1 = TLabel.Create(form);

Label1.Parent = form;

Label1.Left = 8;


 

property Bool ParentColor;

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.


 

property Bool ParentFont;

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


 

property TPopupMenu PopupMenu;

Identifies the pop-up menu associated with the control.


 

property Bool ShowAccelChar;

Determines how an ampersand in the label text is displayed. Set ShowAccelChar to true to allow the label to display an underlined accelerator key value. When ShowAccelChar is true, any character preceded by an ampersand (&) appears underlined.


 

property Bool ShowHint;

Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.


 

property int Tag;

Stores an integer value as part of a component.


 

property int Top;

Specifies the Y coordinate of the top left corner of a control, relative to its parent or containing control in pixels.


 

property Bool Transparent;

Set Transparent to true to prevent the label from obscuring other controls on the form. For example, if the label is used to add text to a graphic, set Transparent to true so that the label does not stand out as a separate object.


 

property Boolean Visible;

Indicates whether the control is visible.


 

property int Width;

Specifies the horizontal size of the control or form in pixels.


 

property Bool WordWrap;

Specifies whether the button text wraps to fit the width of the control.


Set WordWrap to true to allow the display of multiple lines of text.


 


Methods



 

constructor Create(TComponent AOwner) 

Creates and initializes a new TLabel object.

 

Ex. TLabel Label1 = TLabel.Create(form);


 

procedure Free;

Destroys an object and frees its associated memory, if necessary. Visual controls added to a form is automatically destroyed when the form closes.

 

Ex.

TForm form = new TForm(nil);

TLabel Label1 = TLabel.Create(form);

...

Label1.Free;


 

procedure Hide;

Hides the control.


 

procedure Show;

Shows the control. Use Show to set the control's Visible property to true.


 


Events



 

OnClick 

Occurs when the user clicks the control.


Ex.

 

TForm form;

TLabel Label1;

void Label1Click(TObject Sender)

{

  // Do some work here

}

 

{

  form = new TForm(nil);  

 

  Label1 = TLabel.Create(form);

  Label1.Parent = form;

  Label1.OnClick = &Label1Click;

}


 

OnDblClick 

Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.


Ex.

 

TForm form;

TLabel Label1;

void Label1DblClick(TObject Sender)

{

  // Do some work here

}

 

{

  form = new TForm(nil);

  Label1 = TLabel.Create(form);

  Label1.Parent = form;

  Label1.OnDblClick = &Label1DblClick;

}


 

OnMouseDown 

Occurs when the user presses a mouse button with the mouse pointer over a control.


(ssShift, ssAlt, ssCtrl, ssLeft, ssRight, ssMiddle, ssDouble) TShiftState;

 

enum TMouseButton {

  mbLeft,

  mbRight,

  mbMiddle

};

 

Ex.

 

TForm form;

TLabel Label1;

void Label1MouseDown(TObject Sender, TMouseButton Button, TShiftState Shift, int X, int Y)

{

  // Do some work here if left mouse button was pressed

  if (Button == mbLeft) {

    // Left mouse button was pressed. Lets do something...

 

  }

}

 

{

  form = new TForm(nil);

 

  Label1 = TLabel.Create(form);

  Label1.Parent = form;

  Label1.OnMouseDown = &Label1MouseDown;

}


 

OnMouseEnter 

Occurs when the user moves the mouse into a control.

 

Ex.

 

TForm form;

TLabel Label1;

void Label1MouseEnter(TObject Sender)

{

  // Do some work here

}

 

{

  form = new TForm(nil);

 

  Label1 = TLabel.Create(form);

  Label1.Parent = form;

  Label1.OnMouseEnter = &Label1MouseEnter;

}


 

OnMouseLeave 

Occurs when the user moves the mouse outside of a control.


Ex.

 

TForm form;

TLabel Label1;

void Label1MouseLeave(TObject Sender)

{

  // Do some work here

}

 

{

  form = new TForm(nil);

 

  Label1 = TLabel.Create(form);

  Label1.Parent = form;

  Label1.OnMouseLeave = &Label1MouseLeave;

}


 

OnMouseMove 

Occurs when the user moves the mouse pointer while the mouse pointer is over a control.


Ex.

 

int FMouseX,FMouseY;

TForm form;

TLabel Label1;

void Label1MouseMove(TObject Sender, TMouseButton Button, TShiftState Shift, int X, int Y)

{

  // Do some work here

  FMouseX = X;

  FMouseY = Y;

}

 

{

  form = new TForm(nil);

 

  Label1 = TLabel.Create(form);

  Label1.Parent = form;

  Label1.OnMouseMove = &Label1MouseMove;

}


 

OnMouseUp 

Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.

 

Ex.

 

TForm form;

TLabel Label1;

void Label1MouseUp(TObject Sender, TMouseButton Button, TShiftState Shift, int X, int Y)

{

  // Do some work here

}

 

{

  form = new TForm(nil);

 

  Label1 = TLabel.Create(form);

  Label1.Parent = form;

  Label1.OnMouseUp = &Label1MouseUp;

}


 


 


 


 


 


 


 

Copyright © 2004-2020 by Rickard Johansson. All Rights Reserved.

 

 

 

Copyright © 2022 Rickard Johansson