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
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class Label : View
Remarks
The Label view is functionality identical to View and is included for API backwards compatibility.

Constructors

Label()

Declaration
public Label()

Label(ustring, Boolean)

Declaration
public Label(ustring text, bool autosize = true)
Parameters
Type Name Description
NStack.ustring text
System.Boolean autosize

Label(ustring, TextDirection, Boolean)

Declaration
public Label(ustring text, TextDirection direction, bool autosize = true)
Parameters
Type Name Description
NStack.ustring text
TextDirection direction
System.Boolean autosize

Label(Int32, Int32, ustring, Boolean)

Declaration
public Label(int x, int y, ustring text, bool autosize = true)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
NStack.ustring text
System.Boolean autosize

Label(Rect, ustring, Boolean)

Declaration
public Label(Rect rect, ustring text, bool autosize = false)
Parameters
Type Name Description
Rect rect
NStack.ustring text
System.Boolean autosize

Label(Rect, Boolean)

Declaration
public Label(Rect frame, bool autosize = false)
Parameters
Type Name Description
Rect frame
System.Boolean autosize

Methods

OnClicked()

Virtual method to invoke the Clicked event.
Declaration
public virtual void OnClicked()

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

ProcessHotKey(KeyEvent)

This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example).
Declaration
public override bool ProcessHotKey(KeyEvent ke)
Parameters
Type Name Description
KeyEvent ke
Returns
Type Description
System.Boolean
Overrides
Remarks

Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key.

For example, if you implement a button that has a hotkey ok "o", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views.

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