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.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.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.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.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.OnMouseEvent(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.Dispose()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

CheckBox()

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

CheckBox(ustring, bool)

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

CheckBox(int, int, ustring)

Initializes a new instance of CheckBox using Absolute layout.

CheckBox(int, int, ustring, bool)

Initializes a new instance of CheckBox using Absolute layout.

Properties

Checked

The state of the CheckBox

Methods

MouseEvent(MouseEvent)

Method invoked when a mouse event is generated

OnEnter(View)

Method invoked when a view gets focus.

OnToggled(bool)

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

PositionCursor()

Positions the cursor in the right position based on the currently focused view in the chain.

ProcessHotKey(KeyEvent)

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

ProcessKey(KeyEvent)

If the view is focused, gives the view a chance to process the keystroke.

UpdateTextFormatterText()

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

Events

Toggled

Toggled event, raised when the CheckBox is toggled.