Class CheckBox

Namespace

Terminal.Gui.Views

Assembly

Terminal.Gui.dll

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

public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IValue<CheckState>, IValue

Inheritance

object

View

CheckBox

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize

IValue<CheckState>

IValue

Inherited Members

View.OnMouseEnter(CancelEventArgs)

View.OnMouseLeave()

View.OnMouseHoldRepeatChanging(ValueChangingEventArgs<MouseFlags?>)

View.OnMouseHoldRepeatChanged(ValueChangedEventArgs<MouseFlags?>)

View.NewMouseEvent(Mouse)

View.RaiseMouseEvent(Mouse)

View.OnMouseEvent(Mouse)

View.RaiseCommandsBoundToButtonFlags(Mouse)

View.RaiseCommandsBoundToWheelFlags(Mouse)

View.InvokeCommandsBoundToMouse(Mouse)

View.OnMouseStateChanged(EventArgs<MouseState>)

View.OnBorderStyleChanged()

View.GetAdornmentsThickness()

View.AddCommand(Command, View.CommandImplementation)

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

View.GetSupportedCommands()

View.InvokeCommands(Command[], ICommandBinding)

View.InvokeCommand(Command, ICommandBinding)

View.InvokeCommand(Command, ICommandContext)

View.InvokeCommand(Command)

View.RaiseCommandNotBound(ICommandContext)

View.OnCommandNotBound(CommandEventArgs)

View.RaiseAccepting(ICommandContext)

View.OnAccepting(CommandEventArgs)

View.RaiseAccepted(ICommandContext)

View.OnAccepted(ICommandContext)

View.RaiseActivating(ICommandContext)

View.OnActivating(CommandEventArgs)

View.RaiseActivated(ICommandContext)

View.RaiseHandlingHotKey(ICommandContext)

View.OnHandlingHotKey(CommandEventArgs)

View.RaiseHotKeyCommand(ICommandContext)

View.OnHotKeyCommand(ICommandContext)

View.GetDispatchTarget(ICommandContext)

View.DispatchDown(View, ICommandContext)

View.TryBubbleUp(ICommandContext, bool)

View.SetContentSize(Size?)

View.GetContentSize()

View.GetWidthRequiredForSubViews()

View.GetHeightRequiredForSubViews()

View.OnContentSizeChanging(ValueChangingEventArgs<Size?>)

View.OnContentSizeChanged(ValueChangedEventArgs<Size?>)

View.ContentToScreen(in Point)

View.ScreenToContent(in Point)

View.OnViewportChanged(DrawEventArgs)

View.ViewportToScreen(in Rectangle)

View.ViewportToScreen(in Point)

View.ViewportToScreen()

View.ScreenToViewport(in Point)

View.GetViewportOffsetFromFrame()

View.ScrollVertical(int)

View.ScrollHorizontal(int)

View.Dispose()

View.ToString()

View.ToDebugString()

View.Dispose(bool)

View.GetApp()

View.GetDriver()

View.BeginInit()

View.EndInit()

View.OnEnabledChanged()

View.OnVisibleChanging()

View.OnVisibleChanged()

View.OnTitleChanging(ref string)

View.OnTitleChanged()

View.SetCursorNeedsUpdate()

View.GetCurrentAttribute()

View.GetAttributeForRole(VisualRole)

View.OnGettingAttributeForRole(in VisualRole, ref Attribute)

View.SetAttribute(Attribute)

View.SetAttributeForRole(VisualRole)

View.GetClip()

View.SetClip(Region)

View.SetClipToScreen()

View.ExcludeFromClip(Rectangle)

View.ExcludeFromClip(Region)

View.AddViewportToClip()

View.Draw(DrawContext)

View.DrawAdornments()

View.OnDrawingAdornments()

View.OnClearedViewport()

View.ClearViewport(DrawContext)

View.OnDrawingText(DrawContext)

View.OnDrawingText()

View.DrawText(DrawContext)

View.OnDrewText()

View.OnDrawingContent(DrawContext)

View.OnDrawingSubViews(DrawContext)

View.OnDrawingSubViews()

View.DrawSubViews(DrawContext)

View.OnRenderingLineCanvas()

View.RenderLineCanvas(DrawContext)

View.OnDrawComplete(DrawContext)

View.Move(int, int)

View.AddRune(Rune)

View.AddRune(char)

View.AddRune(int, int, Rune)

View.AddStr(string)

View.AddStr(int, int, string)

View.DrawHotString(string, Attribute, Attribute)

View.DrawHotString(string, bool)

View.FillRect(Rectangle, Color?)

View.FillRect(Rectangle, Rune)

View.OnSchemeNameChanging(ValueChangingEventArgs<string>)

View.OnSchemeNameChanged(ValueChangedEventArgs<string>)

View.GetScheme()

View.OnGettingScheme(out Scheme)

View.SetScheme(Scheme)

View.OnSettingScheme(ValueChangingEventArgs<Scheme>)

View.OnSchemeChanged(ValueChangedEventArgs<Scheme>)

View.GetSubViews(bool, bool, bool)

View.OnSuperViewChanging(ValueChangingEventArgs<View>)

View.OnSuperViewChanged(ValueChangedEventArgs<View>)

View.AddAt(int, View)

View.Add(View)

View.Add(params View[])

View.OnSubViewAdded(View)

View.Remove(View)

View.OnSubViewRemoved(View)

View.RemoveAll()

View.RemoveAll<TView>()

View.GetTopSuperView(View, View)

View.IsInHierarchy(View, View, bool)

View.MoveSubViewTowardsEnd(View)

View.MoveSubViewToEnd(View)

View.MoveSubViewTowardsStart(View)

View.MoveSubViewToStart(View)

View.AddKeyBindingsForHotKey(Key, Key, object)

View.AssignHotKeysToSubViews()

View.AssignHotKeyToView(View)

View.NewKeyDownEvent(Key)

View.OnKeyDown(Key)

View.OnKeyDownNotHandled(Key)

View.NewKeyUpEvent(Key)

View.OnKeyUp(Key)

View.Contains(in Point)

View.OnFrameChanged(in Rectangle)

View.FrameToScreen()

View.ScreenToFrame(in Point)

View.OnHeightChanging(ValueChangingEventArgs<Dim>)

View.OnHeightChanged(ValueChangedEventArgs<Dim>)

View.OnWidthChanging(ValueChangingEventArgs<Dim>)

View.OnWidthChanged(ValueChangedEventArgs<Dim>)

View.Layout(Size)

View.Layout()

View.SetRelativeLayout(Size)

View.OnSubViewLayout(LayoutEventArgs)

View.OnSubViewsLaidOut(LayoutEventArgs)

View.SetNeedsLayout()

View.GetContainerSize()

View.GetViewsUnderLocation(in Point, ViewportSettingsFlags)

View.AdvanceFocus(NavigationDirection, TabBehavior?)

View.OnAdvancingFocus(NavigationDirection, TabBehavior?)

View.FocusDeepest(NavigationDirection, TabBehavior?)

View.OnFocusedChanged(View, View)

View.OnCanFocusChanged()

View.ClearFocus()

View.SetFocus()

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

View.OnHasFocusChanged(bool, View, View)

View.SetNeedsDraw()

View.SetNeedsDraw(Rectangle)

View.OnTextChanged()

View.MouseBindings

View.MouseHoldRepeat

View.MousePositionTracking

View.MouseState

View.MouseHighlightStates

View.Margin

View.ShadowStyle

View.Border

View.BorderStyle

View.Padding

View.Arrangement

View.ConsumeDispatch

View.DefaultAcceptView

View.CommandsToBubbleUp

View.ContentSizeTracksViewport

View.ViewportSettings

View.Viewport

View.Data

View.Id

View.App

View.ScreenContents

View.IsInitialized

View.Enabled

View.Visible

View.Title

View.Cursor

View.Diagnostics

View.LineCanvas

View.SuperViewRendersLineCanvas

View.SchemeName

View.HasScheme

View.SubViews

View.SuperView

View.HotKey

View.AssignHotKeys

View.UsedHotKeys

View.KeyBindings

View.HotKeyBindings

View.Frame

View.X

View.Y

View.Height

View.Width

View.NeedsLayout

View.ValidatePosDim

View.CanFocus

View.Focused

View.IsCurrentTop

View.MostFocused

View.HasFocus

View.PreviouslyFocused

View.TabStop

View.NeedsDraw

View.HorizontalScrollBar

View.VerticalScrollBar

View.PreserveTrailingSpaces

View.TextAlignment

View.TextDirection

View.TextFormatter

View.VerticalTextAlignment

View.MouseEnter

View.MouseLeave

View.MouseHoldRepeatChanging

View.MouseHoldRepeatChanged

View.MouseEvent

View.MouseStateChanged

View.BorderStyleChanged

View.CommandNotBound

View.Accepting

View.Accepted

View.Activating

View.Activated

View.HandlingHotKey

View.HotKeyCommand

View.ContentSizeChanging

View.ContentSizeChanged

View.ViewportChanged

View.Disposing

View.Initialized

View.EnabledChanged

View.VisibleChanging

View.VisibleChanged

View.TitleChanging

View.TitleChanged

View.GettingAttributeForRole

View.ClearingViewport

View.ClearedViewport

View.DrawingText

View.DrewText

View.DrawingContent

View.DrawingSubViews

View.DrawComplete

View.SchemeNameChanging

View.SchemeNameChanged

View.GettingScheme

View.SchemeChanging

View.SchemeChanged

View.SuperViewChanging

View.SuperViewChanged

View.SubViewAdded

View.SubViewRemoved

View.Removed

View.HotKeyChanged

View.KeyDown

View.KeyDownNotHandled

View.KeyUp

View.FrameChanged

View.HeightChanging

View.HeightChanged

View.WidthChanging

View.WidthChanged

View.SubViewLayout

View.SubViewsLaidOut

View.AdvancingFocus

View.CanFocusChanged

View.FocusedChanged

View.HasFocusChanging

View.HasFocusChanged

View.TextChanged

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ViewExtensions.ToIdentifyingString(View?)

Remarks

RadioStyle is used to display radio button style glyphs (●) instead of checkbox style glyphs (☑).

Default mouse bindings:

Mouse Event	Action
Click	Toggles the checked state (Activate).
Double-Click	Accepts the checkbox (Accept).

Constructors

CheckBox()

Initializes a new instance of CheckBox.

Properties

AllowCheckStateNone

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

DefaultMouseHighlightStates

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

RadioStyle

If true, the CheckBox will display radio button style glyphs (●) instead of checkbox style glyphs (☑).

Text

The text displayed by the View.

Value

Gets or sets the state of the CheckBox.

Methods

AdvanceCheckState()

Advances Value to the next value. Invokes the cancelable ValueChanging event.

OnActivated(ICommandContext?)

Called when the View has been activated. This is called after Accepting has been raised and not cancelled.

OnClearingViewport()

Called when the Viewport is to be cleared.

OnValueChanged(ValueChangedEventArgs<CheckState>)

Called when the CheckBox Value has changed.

OnValueChanging(ValueChangingEventArgs<CheckState>)

Called when the CheckBox Value is changing.

UpdateTextFormatterText()

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

Events

ValueChanged

Raised when Value has changed.

ValueChangedUntyped

Raised when Value has changed, providing the value as an un-typed object.

ValueChanging

Raised when Value is about to change. Set Handled to true to cancel the change.