Table of Contents

Class OptionSelector

Namespace
Terminal.Gui.Views
Assembly
Terminal.Gui.dll

Provides a user interface for displaying and selecting a single item from a list of options. Each option is represented by a checkbox, but only one can be selected at a time. OptionSelector<TEnum> provides a type-safe version where a enum can be provided.

public class OptionSelector : SelectorBase, IDisposable, ISupportInitializeNotification, ISupportInitialize, IOrientation, IDesignable
Inheritance
OptionSelector
Implements
Derived
Inherited Members
Extension Methods

Constructors

OptionSelector()

Initializes a new instance of the SelectorBase class.

Properties

Cursor

Gets or sets the Labels index for the cursor. The cursor may or may not be the selected RadioItem.

Methods

EnableForDesign()

Causes the View to enable design-time mode. This typically means that the view will load demo data and be configured to allow for design-time manipulation.

OnHandlingHotKey(CommandEventArgs)

Called when the View is handling the user pressing the View's HotKey. Set CommandEventArgs.Handled to true to indicate the event was handled and processing should stop.

OnSelecting(CommandEventArgs)

Called when the user has performed an action (e.g. Select) causing the View to change state. Set CommandEventArgs.Handled to true and return true to indicate the event was handled and processing should stop.

OnSubViewAdded(View)

Called when a SubView has been added to this View.

UpdateChecked()

Updates the checked state of all checkbox subviews so that only the checkbox corresponding to the current Value is checked. Throws InvalidOperationException if a checkbox's Data property is not set.