Table of Contents

Class OptionSelector

Namespace
Terminal.Gui
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.

public class OptionSelector : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IOrientation, IDesignable
Inheritance
OptionSelector
Implements
Inherited Members

Constructors

OptionSelector()

Initializes a new instance of the OptionSelector class.

Properties

AssignHotKeysToCheckBoxes

If true the CheckBoxes will each be automatically assigned a hotkey. UsedHotKeys will be used to ensure unique keys are assigned. Set UsedHotKeys before setting Options with any hotkeys that may conflict with other Views.

Options

Gets or sets the list of options.

Orientation

Gets or sets the Orientation for this OptionSelector. The default is Vertical.

SelectedItem

Gets or sets the index of the selected item.

UsedHotKeys

Gets the list of hotkeys already used by the CheckBoxes or that should not be used if AssignHotKeysToCheckBoxes is enabled.

Methods

CreateCheckBox(string, int)
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.

OnOrientationChanged(Orientation)

Called when Orientation has changed.

OnSelectedItemChanged(int?, int?)

Called when SelectedItem has changed.

Events

OrientationChanged

Raised when Orientation has changed.

OrientationChanging

Raised when Orientation is changing. Can be cancelled.

SelectedItemChanged

Raised when SelectedItem has changed.