Class Label

The Label View displays a string at a given position and supports multiple lines separated 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)

Declaration
public Label(ustring text)
Parameters
Type Name Description
NStack.ustring text

Label(ustring, TextDirection)

Declaration
public Label(ustring text, TextDirection direction)
Parameters
Type Name Description
NStack.ustring text
TextDirection direction

Label(Int32, Int32, ustring)

Declaration
public Label(int x, int y, ustring text)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
NStack.ustring text

Label(Rect)

Declaration
public Label(Rect frame)
Parameters
Type Name Description
Rect frame

Label(Rect, ustring)

Declaration
public Label(Rect rect, ustring text)
Parameters
Type Name Description
Rect rect
NStack.ustring text

Methods

OnEnter(View)

Declaration
public override bool OnEnter(View view)
Parameters
Type Name Description
View view
Returns
Type Description
System.Boolean
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