Class Label

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

The Label View displays a string at a given position and supports multiple lines separated by newline characters. Multi-line Labels support word wrap.

public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Inheritance

object

Responder

View

Label

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize

Inherited Members

View.Added

View.Removed

View.Enter

View.Leave

View.MouseEnter

View.MouseLeave

View.MouseClick

View.CanFocusChanged

View.EnabledChanged

View.VisibleChanged

View.HotKeyChanged

View.HotKey

View.HotKeySpecifier

View.Shortcut

View.ShortcutTag

View.ShortcutAction

View.Data

View.Driver

View.Subviews

View.TabIndexes

View.TabIndex

View.TabStop

View.CanFocus

View.Id

View.IsCurrentTop

View.WantMousePositionReports

View.WantContinuousButtonPressed

View.Frame

View.LayoutStyle

View.Bounds

View.X

View.Y

View.Width

View.Height

View.ForceValidatePosDim

View.GetMinWidthHeight(out Size)

View.SetMinWidthHeight()

View.TextFormatter

View.SuperView

View.UpdateTextFormatterText()

View.ProcessResizeView()

View.SetNeedsDisplay()

View.ClearLayoutNeeded()

View.SetNeedsDisplay(Rect)

View.SetChildNeedsDisplay()

View.Add(View)

View.Add(params View[])

View.RemoveAll()

View.Remove(View)

View.BringSubviewToFront(View)

View.SendSubviewToBack(View)

View.SendSubviewBackwards(View)

View.BringSubviewForward(View)

View.Clear()

View.Clear(Rect)

View.ScreenToView(int, int)

View.ClipToBounds()

View.SetClip(Rect)

View.DrawFrame(Rect, int, bool)

View.DrawHotString(ustring, Attribute, Attribute)

View.DrawHotString(ustring, bool, ColorScheme)

View.Move(int, int, bool)

View.PositionCursor()

View.HasFocus

View.OnAdded(View)

View.OnRemoved(View)

View.OnLeave(View)

View.Focused

View.MostFocused

View.ColorScheme

View.AddRune(int, int, Rune)

View.ClearNeedsDisplay()

View.Redraw(Rect)

View.DrawContent

View.OnDrawContent(Rect)

View.DrawContentComplete

View.OnDrawContentComplete(Rect)

View.SetFocus()

View.KeyPress

View.ProcessKey(KeyEvent)

View.InvokeKeybindings(KeyEvent)

View.AddKeyBinding(Key, params Command[])

View.ReplaceKeyBinding(Key, Key)

View.ContainsKeyBinding(Key)

View.ClearKeybindings()

View.ClearKeybinding(Key)

View.ClearKeybinding(params Command[])

View.AddCommand(Command, Func<bool?>)

View.GetSupportedCommands()

View.GetKeyFromCommand(params Command[])

View.ProcessColdKey(KeyEvent)

View.KeyDown

View.OnKeyDown(KeyEvent)

View.KeyUp

View.OnKeyUp(KeyEvent)

View.EnsureFocus()

View.FocusFirst()

View.FocusLast()

View.FocusPrev()

View.FocusNext()

View.LayoutStarted

View.LayoutComplete

View.Initialized

View.LayoutSubviews()

View.Text

View.AutoSize

View.PreserveTrailingSpaces

View.TextAlignment

View.VerticalTextAlignment

View.TextDirection

View.IsInitialized

View.IsAdded

View.Enabled

View.ClearOnVisibleFalse

View.Visible

View.Border

View.IgnoreBorderPropertyOnRedraw

View.ToString()

View.GetAutoSize()

View.GetHotKeySpecifierLength(bool)

View.GetTextFormatterBoundsSize()

View.GetBoundsTextFormatterSize()

View.OnMouseEnter(MouseEvent)

View.OnMouseLeave(MouseEvent)

View.OnMouseClick(View.MouseEventArgs)

View.OnCanFocusChanged()

View.OnEnabledChanged()

View.OnVisibleChanged()

View.Dispose(bool)

View.BeginInit()

View.EndInit()

View.SetWidth(int, out int)

View.SetHeight(int, out int)

View.GetCurrentWidth(out int)

View.GetCurrentHeight(out int)

View.GetNormalColor()

View.GetFocusColor()

View.GetHotNormalColor()

View.GetTopSuperView()

Responder.MouseEvent(MouseEvent)

Responder.Dispose()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

The Label view is functionality identical to View and is included for API backwards compatibility.

Constructors

Label()

Initializes a new instance of View using Computed layout.

Label(ustring, bool)

Label(ustring, TextDirection, bool)

Label(int, int, ustring, bool)

Label(Rect, ustring, bool)

Label(Rect, bool)

Methods

OnClicked()

Virtual method to invoke the Clicked event.

OnEnter(View)

Method invoked when a view gets focus.

OnMouseEvent(MouseEvent)

Method invoked when a mouse event is generated

ProcessHotKey(KeyEvent)

This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example).

Events

Clicked

Clicked 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)