Label

ClForms.Elements.Label
Represents a standard Windows label

public class Label: Control, IElementStyle<Label>

Inheritance Control -> Label
Derived IElementStyle<Label>

Examples

The following code example creates a Label, sets its Text, WordWrap, Background, Foreground and Margin properties. The label is added to the Window.

var targetLabel = new Label
{
    WordWrap = true,
    Foreground = Color.NotSet,
    Background = Color.NotSet,
    Text = "Now look at an example how to use…",
    Margin = new Thickness(left: 0, top: 0, right: 0, bottom: 1),
};
AddContent(targetLabel);

You can find more examples of using the Label in this project

Remarks

Label is designed to be lightweight, and is geared specifically at integrating small portions of flow content into a user interface (UI). Label is optimized for single-line display, and provides good performance for displaying up to a few lines of content.

Constructors

Syntax	Description
Label()	Initialize a new Label instance
Label(string text)	Initialize a new Label instance with text

Properties

Name	Type	Description
AutoSize	bool	Gets or sets a value indicating whether the control is resized in accordance with its contents
Background	Color	Gets or sets a brush that describes the background of a control
BackgroundIsTransparent	bool	Gets a value indicating whether the Background has `Color.NotSet`
Bounds	Rect	Gets the size and location of the control including its nonclient elements, in points, relative to the parent control
DesiredSize	Size	Gets the size that this element computed during the measure pass of the layout process
DrawingContext	IDrawingContext	Gets a value of the drawing context
Foreground	Color	Gets or sets a brush that describes the text of a control
ForegroundIsTransparent	bool	Gets a value indicating whether the Foreground has `Color.NotSet`
Height	int?	Gets or sets the height of the control
Id	long	Gets a value of the control's identifier
IsMeasureValid	bool	Gets a value indicating whether component sizing was performed
IsVisualValid	bool	Gets a value indicating whether the component is being re-rendered
Location	Point	Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container
Margin	Thickness	Gets or sets the outer margin of an element
Padding	Thickness	Gets or sets a Thickness value that describes the amount of space between a control and its child element
Parent	ContentControl	Gets or sets the parent container of the control
Tag	object	Gets or sets the object that contains data about the control
Text	string	Gets or sets the text associated with this control
TextAlignment	TextAlignment	Gets or sets the horizontal alignment of the contents of the text
Width	int?	Gets or sets the width of the control
WordWrap	bool	Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary

Methods

Syntax	Description
Arrange(Rect)	Positions child elements and determines a size for a `Control`. Parent elements call this method from their `Arrange(Rect)` implementation to form a recursive layout update
Clear()	Removes all characters from the Text
InvalidateMeasure()	Invalidates the measurement state (layout) for the element
InvalidateMeasureIfAutoSize()	Invalidates the measurement state (layout) for the element if AutoSize property is true otherwise invalidates the rendering of the element
InvalidateVisual()	Invalidates the rendering of the element, and forces a complete new layout pass. OnRender(IDrawingContext) is called after the layout cycle is completed
Measure(Size)	Updates `DesiredSize` of a `Control`. Parent elements call this method from their own `Measure(Size)` implementations to form a recursive layout update
OnRender(IDrawingContext)	Filling a pseudographics drawing context
ParentWindow()	Gets the form the control is in
SetStyle(Action)	Defines actions with an element style

Events

Event	Description
OnAutoSizeChanged	Occurs when the value of the AutoSize property changes
OnBackgroundChanged	Occurs when the value of the Background property changes
OnForegroundChanged	Occurs when the value of the Foreground property changes
OnHeightChanged	Occurs when the value of the Height property changes
OnMarginChanged	Occurs when the value of the Margin property changes
OnPaddingChanged	Occurs when the value of the Padding property changes
OnParentChanged	Occurs when the value of the Parent property changes
OnTagChanged	Occurs when the value of the Tag property changes
OnTextChanged	Occurs when the value of the Text property changes
OnTextAlignmentChanged	Occurs when the value of the TextAlignment property changes
OnWidthChanged	Occurs when the value of the Width property changes
OnWordWrapChanged	Occurs when the value of the WordWrap property changes