Class CheckBox

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

The CheckBoxView shows an on/off toggle that the user can set

public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Inheritance

object

Responder

View

CheckBox

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize

Inherited Members

View.Frame

View.FrameToScreen()

View.ScreenToFrame(in Point)

View.X

View.Y

View.Height

View.Width

View.LayoutStyle

View.Contains(in Point)

View.LayoutComplete

View.LayoutStarted

View.LayoutSubviews()

View.ClearLayoutNeeded()

View.ValidatePosDim

View.Driver

View.Initialized

View.IsInitialized

View.BeginInit()

View.EndInit()

View.Id

View.Data

View.Accept

View.OnAccept()

View.Enabled

View.EnabledChanged

View.OnEnabledChanged()

View.Visible

View.OnVisibleChanged()

View.ClearOnVisibleFalse

View.VisibleChanged

View.Title

View.OnTitleChanged(string, string)

View.OnTitleChanging(string, string)

View.TitleChanged

View.TitleChanging

View.ToString()

View.Dispose(bool)

View.Margin

View.Border

View.BorderStyle

View.Padding

View.GetAdornmentsThickness()

View.Arrangement

View.ContentSize

View.OnContentSizeChanged(SizeChangedEventArgs)

View.ContentSizeChanged

View.ContentToScreen(in Point)

View.ScreenToContent(in Point)

View.ViewportSettings

View.Viewport

View.ViewportChanged

View.OnViewportChanged(DrawEventArgs)

View.ViewportToScreen(in Rectangle)

View.ViewportToScreen(in Point)

View.ScreenToViewport(in Point)

View.GetViewportOffsetFromFrame()

View.ScrollVertical(int)

View.ScrollHorizontal(int)

View.Diagnostics

View.ColorScheme

View.LineCanvas

View.NeedsDisplay

View.SubViewNeedsDisplay

View.SuperViewRendersLineCanvas

View.AddRune(int, int, Rune)

View.Clear()

View.FillRect(Rectangle, Color?)

View.SetClip()

View.Draw()

View.DrawContent

View.DrawContentComplete

View.DrawHotString(string, Attribute, Attribute)

View.DrawHotString(string, bool, ColorScheme)

View.GetFocusColor()

View.GetHotNormalColor()

View.GetNormalColor()

View.Move(int, int)

View.OnDrawAdornments()

View.OnDrawContent(Rectangle)

View.OnDrawContentComplete(Rectangle)

View.OnRenderLineCanvas()

View.SetNeedsDisplay()

View.SetNeedsDisplay(Rectangle)

View.SetSubViewNeedsDisplay()

View.ClearNeedsDisplay()

View.HotKeyChanged

View.HotKey

View.AddKeyBindingsForHotKey(Key, Key)

View.TabIndexes

View.TabIndex

View.TabStop

View.NewKeyDownEvent(Key)

View.OnKeyDown(Key)

View.KeyDown

View.OnProcessKeyDown(Key)

View.ProcessKeyDown

View.NewKeyUpEvent(Key)

View.OnKeyUp(Key)

View.KeyUp

View.KeyBindings

View.OnInvokingKeyBindings(Key)

View.InvokingKeyBindings

View.InvokeKeyBindings(Key)

View.InvokeCommands(Command[])

View.InvokeCommand(Command)

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

View.GetSupportedCommands()

View.HighlightStyle

View.WantContinuousButtonPressed

View.WantMousePositionReports

View.OnMouseEnter(MouseEvent)

View.MouseEnter

View.OnMouseLeave(MouseEvent)

View.MouseLeave

View.NewMouseEvent(MouseEvent)

View.Highlight

View.OnHighlight(HighlightStyle)

View.OnMouseEvent(MouseEvent)

View.MouseEvent

View.OnMouseClick(MouseEventEventArgs)

View.MouseClick

View.IsAdded

View.IsCurrentTop

View.Subviews

View.SuperView

View.Add(View)

View.Add(params View[])

View.Added

View.BringSubviewForward(View)

View.BringSubviewToFront(View)

View.GetTopSuperView(View, View)

View.OnAdded(SuperViewChangedEventArgs)

View.OnRemoved(SuperViewChangedEventArgs)

View.Remove(View)

View.RemoveAll()

View.Removed

View.SendSubviewBackwards(View)

View.SendSubviewToBack(View)

View.Enter

View.Leave

View.HasFocus

View.CanFocusChanged

View.OnCanFocusChanged()

View.CanFocus

View.OnEnter(View)

View.OnLeave(View)

View.Focused

View.MostFocused

View.SetFocus()

View.EnsureFocus()

View.FocusFirst()

View.FocusLast()

View.FocusPrev()

View.FocusNext()

View.CursorVisibility

View.PositionCursor()

View.PreserveTrailingSpaces

View.OnTextChanged(string, string)

View.TextChanged

View.TextAlignment

View.TextDirection

View.TextFormatter

View.VerticalTextAlignment

Responder.Dispose()

Responder.Disposing

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

CheckBox()

Initializes a new instance of CheckBox based on the given text, using Computed layout.

Properties

AllowNullChecked

If true allows Checked to be null, true or false. If false only allows Checked to be true or false.

Checked

The state of the CheckBox

HotKeySpecifier

Gets or sets the specifier character for the hot key (e.g. '_'). Set to '\xffff' to disable automatic hot key setting support for this View instance. The default is '\xffff'.

Text

The text displayed by the View.

Methods

OnToggled()

Called when the Checked property changes. Invokes the Toggled event.

UpdateTextFormatterText()

Can be overridden if the Text has different format than the default.

Events

Toggled

Toggled event, raised when the CheckBox is toggled.