Class CheckBox

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

Shows a check box that can be cycled between two or three states.

public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Inheritance

object

View

CheckBox

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize

Inherited Members

View.Margin

View.ShadowStyle

View.Border

View.BorderStyle

View.OnBorderStyleChanging(CancelEventArgs<LineStyle>)

View.BorderStyleChanging

View.SetBorderStyle(LineStyle)

View.Padding

View.GetAdornmentsThickness()

View.Arrangement

View.ColorScheme

View.GetFocusColor()

View.GetHotFocusColor()

View.GetHotNormalColor()

View.GetNormalColor()

View.SetAttribute(Attribute)

View.GetAttribute()

View.RaiseAccepting(ICommandContext)

View.OnAccepting(CommandEventArgs)

View.Accepting

View.RaiseSelecting(ICommandContext)

View.OnSelecting(CommandEventArgs)

View.Selecting

View.RaiseHandlingHotKey()

View.OnHandlingHotKey(CommandEventArgs)

View.HandlingHotKey

View.AddCommand(Command, View.CommandImplementation)

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

View.GetSupportedCommands()

View.InvokeCommands<TBindingType>(Command[], TBindingType)

View.InvokeCommand<TBindingType>(Command, TBindingType)

View.InvokeCommand(Command)

View.SetContentSize(Size?)

View.GetContentSize()

View.ContentSizeTracksViewport

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.Data

View.Id

View.Driver

View.Initialized

View.IsInitialized

View.BeginInit()

View.EndInit()

View.Enabled

View.EnabledChanged

View.OnEnabledChanged()

View.Visible

View.OnVisibleChanging()

View.VisibleChanging

View.OnVisibleChanged()

View.VisibleChanged

View.Title

View.OnTitleChanged()

View.OnTitleChanging(ref string)

View.TitleChanged

View.TitleChanging

View.ToString()

View.Dispose(bool)

View.Disposing

View.Dispose()

View.CursorVisibility

View.PositionCursor()

View.Diagnostics

View.GetClip()

View.SetClip(Region)

View.SetClipToScreen()

View.ExcludeFromClip(Rectangle)

View.ClipViewport()

View.Draw()

View.DrawBorderAndPadding()

View.OnDrawingBorderAndPadding()

View.OnSettingAttribute()

View.SettingAttribute

View.SetNormalAttribute()

View.OnClearingViewport()

View.ClearingViewport

View.ClearViewport()

View.OnDrawingText()

View.DrawingText

View.DrawText()

View.OnDrawingContent()

View.DrawingContent

View.OnDrawingSubviews()

View.DrawingSubviews

View.DrawSubviews()

View.OnRenderingLineCanvas()

View.LineCanvas

View.SuperViewRendersLineCanvas

View.RenderLineCanvas()

View.OnDrawComplete()

View.DrawComplete

View.NeedsDraw

View.SubViewNeedsDraw

View.SetNeedsDraw()

View.SetNeedsDraw(Rectangle)

View.SetSubViewNeedsDraw()

View.ClearNeedsDraw()

View.Move(int, int)

View.AddRune(Rune)

View.AddRune(char)

View.AddRune(int, int, Rune)

View.AddStr(string)

View.DrawHotString(string, Attribute, Attribute)

View.DrawHotString(string, bool)

View.FillRect(Rectangle, Color?)

View.FillRect(Rectangle, Rune)

View.Subviews

View.SuperView

View.IsAdded

View.Add(View)

View.Add(params View[])

View.Added

View.OnAdded(SuperViewChangedEventArgs)

View.OnRemoved(SuperViewChangedEventArgs)

View.Remove(View)

View.RemoveAll()

View.Removed

View.GetTopSuperView(View, View)

View.IsInHierarchy(View, View, bool)

View.MoveSubviewTowardsEnd(View)

View.MoveSubviewToEnd(View)

View.MoveSubviewTowardsStart(View)

View.MoveSubviewToStart(View)

View.HotKeyChanged

View.HotKey

View.AddKeyBindingsForHotKey(Key, Key, object)

View.NewKeyDownEvent(Key)

View.OnKeyDown(Key)

View.KeyDown

View.OnKeyDownNotHandled(Key)

View.KeyDownNotHandled

View.NewKeyUpEvent(Key)

View.OnKeyUp(Key)

View.KeyUp

View.KeyBindings

View.HotKeyBindings

View.DoInvokeCommands(Key)

View.InvokeCommandsBoundToHotKey(Key)

View.Contains(in Point)

View.Frame

View.OnFrameChanged(in Rectangle)

View.FrameChanged

View.FrameToScreen()

View.ScreenToFrame(in Point)

View.X

View.Y

View.Height

View.Width

View.Layout(Size)

View.Layout()

View.SetRelativeLayout(Size)

View.OnSubviewLayout(LayoutEventArgs)

View.SubviewLayout

View.OnSubviewsLaidOut(LayoutEventArgs)

View.SubviewsLaidOut

View.NeedsLayout

View.SetNeedsLayout()

View.ValidatePosDim

View.MouseBindings

View.InvokeCommandsBoundToMouse(MouseEventArgs)

View.OnMouseEnter(CancelEventArgs)

View.MouseEnter

View.OnMouseLeave()

View.MouseLeave

View.WantContinuousButtonPressed

View.WantMousePositionReports

View.NewMouseEvent(MouseEventArgs)

View.RaiseMouseEvent(MouseEventArgs)

View.OnMouseEvent(MouseEventArgs)

View.MouseEvent

View.RaiseMouseClickEvent(MouseEventArgs)

View.OnMouseClick(MouseEventArgs)

View.MouseClick

View.RaiseMouseWheelEvent(MouseEventArgs)

View.OnMouseWheel(MouseEventArgs)

View.MouseWheel

View.HighlightStyle

View.OnHighlight(CancelEventArgs<HighlightStyle>)

View.Highlight

View.AdvanceFocus(NavigationDirection, TabBehavior?)

View.OnAdvancingFocus(NavigationDirection, TabBehavior?)

View.AdvancingFocus

View.CanFocus

View.CanFocusChanged

View.FocusDeepest(NavigationDirection, TabBehavior?)

View.Focused

View.IsCurrentTop

View.MostFocused

View.OnCanFocusChanged()

View.HasFocus

View.SetFocus()

View.OnHasFocusChanging(bool, bool, View, View)

View.HasFocusChanging

View.OnHasFocusChanged(bool, View, View)

View.HasFocusChanged

View.TabStop

View.HorizontalScrollBar

View.VerticalScrollBar

View.OnTextChanged()

View.PreserveTrailingSpaces

View.TextAlignment

View.TextChanged

View.TextDirection

View.TextFormatter

View.VerticalTextAlignment

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.

Properties

AllowCheckStateNone

If true allows CheckedState to be None. The default is false.

CheckedState

The state of the CheckBox.

DefaultHighlightStyle

Gets or sets the default Highlight Style.

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

AdvanceCheckState()

Advances CheckedState to the next value. Invokes the cancelable CheckedStateChanging event.

OnCheckedStateChanged(EventArgs<CheckState>)

Called when the CheckBox state has changed.

OnCheckedStateChanging(CancelEventArgs<CheckState>)

Called when the CheckBox state is changing.

UpdateTextFormatterText()

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

Events

CheckedStateChanged

Raised when the CheckBox state has changed.

CheckedStateChanging

Raised when the CheckBox state is changing.