Class Label

The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap.
Inheritance
System.Object
Responder
View
Label
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
The Label view is functionality identical to View and is included for API backwards compatibility.

Constructors

Label()

Declaration
public Label()

Label(ustring)

Initializes a new instance of View using Computed layout.
Declaration
public Label(ustring text)
Parameters
Type Name Description
NStack.ustring text text to initialize the Text property with.
Remarks

The View will be created using Computed coordinates with the given string. The initial size (Frame will be adjusted to fit the contents of Text, including newlines ('\n') for multiple lines.

If Height is greater than one, word wrapping is provided.

Label(Int32, Int32, ustring)

Initializes a new instance of View using Absolute layout.
Declaration
public Label(int x, int y, ustring text)
Parameters
Type Name Description
System.Int32 x column to locate the Label.
System.Int32 y row to locate the Label.
NStack.ustring text text to initialize the Text property with.
Remarks

The View will be created at the given coordinates with the given string. The size (Frame will be adjusted to fit the contents of Text, including newlines ('\n') for multiple lines.

No line wrapping is provided.

Label(Rect)

Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter.
Declaration
public Label(Rect frame)
Parameters
Type Name Description
Rect frame The region covered by this view.
Remarks
This constructor intitalize a View with a LayoutStyle of Absolute. Use View() to initialize a View with LayoutStyle of Computed

Label(Rect, ustring)

Initializes a new instance of View using Absolute layout.
Declaration
public Label(Rect rect, ustring text)
Parameters
Type Name Description
Rect rect Location.
NStack.ustring text text to initialize the Text property with.
Remarks

The View will be created at the given coordinates with the given string. The initial size (Frame will be adjusted to fit the contents of Text, including newlines ('\n') for multiple lines.

If rect.Height is greater than one, word wrapping is provided.

Methods

OnEnter(View)

Method invoked when a view gets focus.
Declaration
public override bool OnEnter(View view)
Parameters
Type Name Description
View view The view that is losing focus.
Returns
Type Description
System.Boolean true, if the event was handled, false otherwise.
Overrides

OnMouseEvent(MouseEvent)

Method invoked when a mouse event is generated
Declaration
public override bool OnMouseEvent(MouseEvent mouseEvent)
Parameters
Type Name Description
MouseEvent mouseEvent
Returns
Type Description
System.Boolean true, if the event was handled, false otherwise.
Overrides

Events

Clicked

Clicked System.Action, raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault)
Declaration
public event Action Clicked
Event Type
Type Description
System.Action
Remarks
Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard.

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize