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, IValue<int?>, IValue, IDesignable
Inheritance
OptionSelector
Implements
Derived
Inherited Members
Extension Methods

Constructors

OptionSelector()

Initializes a new instance of the SelectorBase class.

Properties

ConsumeDispatch

Consumes: OptionSelector owns selection state, not the individual CheckBoxes.

FocusedItem

Gets or sets the Labels index for the focused item. The active item 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.

GetDispatchTarget(ICommandContext?)

Gets the SubView to dispatch commands to. Return null to skip dispatch. The framework calls this during RaiseActivating(ICommandContext?)/RaiseAccepting(ICommandContext?) after the OnActivating virtual and OnAccepting event have had a chance to cancel.

OnActivated(ICommandContext?)

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

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.

Edit this page